Spec-Zone.ru › OpenJavaFX 11
Модуль javafx.controls
Пакет javafx.scene.chart

Класс BarChart<X,​Y>

  • java.lang.Object
    • javafx.scene.Node
      • javafx.scene.Parent
        • javafx.scene.layout.Region
          • javafx.scene.chart.Chart
            • javafx.scene.chart.XYChart<X,​Y>
              • javafx.scene.chart.BarChart<X,​Y>
  • Все реализованные интерфейсы:
    Styleable, EventTarget
    public class BarChart<X,​Y>
    extends XYChart<X,​Y>
    Диаграмма, на которой отображаются столбцы, указывающие значения данных для категории. Столбцы могут быть вертикальными или горизонтальными в зависимости от того, какой ось является осью категорий.
    С момента:
    JavaFX 2.0
  • Краткое описание свойств

    Свойства
    Тип Свойство Описание
    DoubleProperty barGap
    Пробел между столбцами в одной категории
    DoubleProperty categoryGap
    Пробел между столбцами в разных категориях
    • Свойства, унаследованные от класса javafx.scene.chart.XYChart

      alternativeColumnFillVisible, alternativeRowFillVisible, data, horizontalGridLinesVisible, horizontalZeroLineVisible, verticalGridLinesVisible, verticalZeroLineVisible
    • Свойства, унаследованные от класса javafx.scene.chart.Chart

      animated, legend, legendSide, legendVisible, title, titleSide
    • Свойства, унаследованные от класса javafx.scene.layout.Region

      background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width
    • Свойства, унаследованные от класса javafx.scene.Parent

      needsLayout
    • Свойства, унаследованные от класса javafx.scene.Node

      accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible
  • Краткое описание вложенных классов

    • Вложенные классы/интерфейсы, унаследованные от класса javafx.scene.chart.XYChart

      XYChart.Data<X,​Y>, XYChart.Series<X,​Y>
  • Краткое описание полей

    • Поля, унаследованные от класса javafx.scene.layout.Region

      USE_COMPUTED_SIZE, USE_PREF_SIZE
    • Поля, унаследованные от класса javafx.scene.Node

      BASELINE_OFFSET_SAME_AS_HEIGHT
  • Краткое описание конструкторов

    Конструкторы
    Конструктор Описание
    BarChart​(Axis<X> xAxis, Axis<Y> yAxis)
    Создаёт новую BarChart с заданной осью.
    BarChart​(Axis<X> xAxis, Axis<Y> yAxis, ObservableList<XYChart.Series<X,​Y>> data)
    Создаёт новую BarChart с заданной осью и данными.
    BarChart​(Axis<X> xAxis, Axis<Y> yAxis, ObservableList<XYChart.Series<X,​Y>> data, double categoryGap)
    Создаёт новую BarChart с заданной осью и данными.
  • Краткое описание методов

    Все методыСтатические методыМетоды экземпляровКонкретные методы
    Модификатор и тип Метод Описание
    DoubleProperty barGapProperty()
    Пробел между столбцами в одной категории
    DoubleProperty categoryGapProperty()
    Пробел между столбцами в разных категориях
    protected void dataItemAdded​(XYChart.Series<X,​Y> series, int itemIndex, XYChart.Data<X,​Y> item)
    Вызывается при добавлении элемента данных в серию.
    protected void dataItemChanged​(XYChart.Data<X,​Y> item)
    Вызывается при изменении элемента данных, т.е. его xValue, yValue или extraValue изменились.
    protected void dataItemRemoved​(XYChart.Data<X,​Y> item, XYChart.Series<X,​Y> series)
    Вызывается, когда элемент данных был удален из модели данных, но все еще отображается на диаграмме.
    double getBarGap()
    Возвращает значение свойства barGap.
    double getCategoryGap()
    Возвращает значение свойства categoryGap.
    static List<CssMetaData<? extends Styleable,​?>> getClassCssMetaData()
    List<CssMetaData<? extends Styleable,​?>> getCssMetaData()
    Этот метод должен делегировать Node.getClassCssMetaData(), чтобы получить доступ к CssMetaData узла без необходимости в рефлексии.
    protected void layoutPlotChildren()
    Вызывается для обновления и компоновки дочерних элементов графика.
    protected void seriesAdded​(XYChart.Series<X,​Y> series, int seriesIndex)
    Серия была добавлена в модель данных диаграммы.
    protected void seriesChanged​(ListChangeListener.Change<? extends XYChart.Series> c)
    Вызывается при каждом атомарном изменении списка серий для этой диаграммы
    protected void seriesRemoved​(XYChart.Series<X,​Y> series)
    Серия была удалена из модели данных, но все еще отображается на диаграмме.
    void setBarGap​(double value)
    Устанавливает значение свойства barGap.
    void setCategoryGap​(double value)
    Устанавливает значение свойства categoryGap.
    • Методы, унаследованные от класса javafx.scene.chart.XYChart

      alternativeColumnFillVisibleProperty, alternativeRowFillVisibleProperty, currentDisplayedExtraValueProperty, currentDisplayedXValueProperty, currentDisplayedYValueProperty, dataProperty, getCurrentDisplayedExtraValue, getCurrentDisplayedXValue, getCurrentDisplayedYValue, getData, getDisplayedDataIterator, getDisplayedSeriesIterator, getPlotChildren, getVerticalGridLinesVisible, getXAxis, getYAxis, horizontalGridLinesVisibleProperty, horizontalZeroLineVisibleProperty, isAlternativeColumnFillVisible, isAlternativeRowFillVisible, isHorizontalGridLinesVisible, isHorizontalZeroLineVisible, isVerticalZeroLineVisible, layoutChartChildren, removeDataItemFromDisplay, removeSeriesFromDisplay, setAlternativeColumnFillVisible, setAlternativeRowFillVisible, setCurrentDisplayedExtraValue, setCurrentDisplayedXValue, setCurrentDisplayedYValue, setData, setHorizontalGridLinesVisible, setHorizontalZeroLineVisible, setVerticalGridLinesVisible, setVerticalZeroLineVisible, updateAxisRange, updateLegend, verticalGridLinesVisibleProperty, verticalZeroLineVisibleProperty
    • Методы, унаследованные от класса javafx.scene.chart.Chart

      animate, animatedProperty, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getAnimated, getChartChildren, getLegend, getLegendSide, getTitle, getTitleSide, isLegendVisible, layoutChildren, legendProperty, legendSideProperty, legendVisibleProperty, requestChartLayout, setAnimated, setLegend, setLegendSide, setLegendVisible, setTitle, setTitleSide, shouldAnimate, titleProperty, titleSideProperty
    • Методы, унаследованные от класса javafx.scene.layout.Region

      backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isResizable, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty
    • Методы, унаследованные от класса javafx.scene.Parent

      getBaselineOffset, getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestLayout, requestParentLayout, setNeedsLayout, updateBounds
    • Методы, унаследованные от класса javafx.scene.Node

      accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInitialFocusTraversable, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty
    • Методы, унаследованные от класса java.lang.Object

      clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Методы, унаследованные от интерфейса javafx.css.Styleable

      getStyleableNode
  • Подробности свойств

    • barGap

      public final DoubleProperty barGapProperty
      Промежуток между полосами в одной категории
      См. также:
      getBarGap(), setBarGap(double)
    • categoryGap

      public final DoubleProperty categoryGapProperty
      Промежуток между полосами в разных категориях
      См. также:
      getCategoryGap(), setCategoryGap(double)
  • Подробности конструктора

    • BarChart

      public BarChart​(Axis<X> xAxis,
                      Axis<Y> yAxis)
      Создать новый BarChart с заданной осью. Две оси должны быть ValueAxis/NumberAxis и CategoryAxis, они могут быть в любом порядке, в зависимости от того, хотите ли вы горизонтальную или вертикальную столбчатую диаграмму.
      Параметры:
      xAxis - Ось x для использования
      yAxis - Ось y для использования
    • BarChart

      public BarChart​(Axis<X> xAxis,
                      Axis<Y> yAxis,
                      ObservableList<XYChart.Series<X,​Y>> data)
      Создать новый BarChart с заданной осью и данными. Две оси должны быть ValueAxis/NumberAxis и CategoryAxis, они могут быть в любом порядке, в зависимости от того, хотите ли вы горизонтальную или вертикальную столбчатую диаграмму.
      Параметры:
      xAxis - Ось x для использования
      yAxis - Ось y для использования
      data - Данные для использования, это фактический используемый список, поэтому любые изменения в нем будут отражены в диаграмме
    • BarChart

      public BarChart​(Axis<X> xAxis,
                      Axis<Y> yAxis,
                      ObservableList<XYChart.Series<X,​Y>> data,
                      double categoryGap)
      Создать новый BarChart с заданной осью и данными. Две оси должны быть ValueAxis/NumberAxis и CategoryAxis, они могут быть в любом порядке, в зависимости от того, хотите ли вы горизонтальную или вертикальную столбчатую диаграмму.
      Параметры:
      xAxis - Ось x для использования
      yAxis - Ось y для использования
      data - Данные для использования, это фактический используемый список, поэтому любые изменения в нем будут отражены в диаграмме
      categoryGap - Промежуток между полосами в разных категориях
  • Подробности метода

    • getBarGap

      public final double getBarGap()
      Получает значение свойства barGap.
      Описание свойства:
      Промежуток между полосами в одной категории
    • setBarGap

      public final void setBarGap​(double value)
      Задает значение свойства barGap.
      Описание свойства:
      Промежуток между полосами в одной категории
    • barGapProperty

      public final DoubleProperty barGapProperty()
      Промежуток между полосами в одной категории
      См. также:
      getBarGap(), setBarGap(double)
    • getCategoryGap

      public final double getCategoryGap()
      Получает значение свойства categoryGap.
      Описание свойства:
      Промежуток между полосами в разных категориях
    • setCategoryGap

      public final void setCategoryGap​(double value)
      Задает значение свойства categoryGap.
      Описание свойства:
      Промежуток между полосами в разных категориях
    • categoryGapProperty

      public final DoubleProperty categoryGapProperty()
      Промежуток между полосами в разных категориях
      См. также:
      getCategoryGap(), setCategoryGap(double)
    • dataItemAdded

      protected void dataItemAdded​(XYChart.Series<X,​Y> series,
                                   int itemIndex,
                                   XYChart.Data<X,​Y> item)
      Описание, скопированное из класса: XYChart
      Вызывается при добавлении элемента данных в серию. Именно здесь реализации XYChart могут создавать/добавлять новые узлы в getPlotChildren для представления этого элемента данных. Они также могут анимировать это добавление данных с помощью эффекта затухания или аналогичного, если animated = true.
      Указывается в:
      dataItemAdded в классе XYChart<X,​Y>
      Параметры:
      series - Серия, к которой был добавлен элемент данных
      itemIndex - Индекс нового элемента в серии
      item - Новый элемент данных, который был добавлен
    • dataItemRemoved

      protected void dataItemRemoved​(XYChart.Data<X,​Y> item,
                                     XYChart.Series<X,​Y> series)
      Описание, скопированное из класса: XYChart
      Вызывается, когда элемент данных был удален из модели данных, но он все еще виден на диаграмме. Он все еще виден, чтобы вы могли обрабатывать анимацию его удаления в этом методе. После завершения анимации элемента данных вы должны вызвать removeDataItemFromDisplay(), чтобы удалить узел элемента из отображения на диаграмме.
      Указывается в:
      dataItemRemoved в классе XYChart<X,​Y>
      Параметры:
      item - Элемент, который был удален из серии
      series - Серия, из которой был удален элемент
    • dataItemChanged

      protected void dataItemChanged​(XYChart.Data<X,​Y> item)
      Вызывается, когда элемент данных изменился, т. е. изменилось его xValue, yValue или extraValue.
      Указывается в:
      dataItemChanged в классе XYChart<X,​Y>
      Параметры:
      item - Элемент данных, который был изменен
    • seriesChanged

      protected void seriesChanged​(ListChangeListener.Change<? extends XYChart.Series> c)
      Описание, скопированное из класса: XYChart
      Вызывается, когда в список серий для этой диаграммы вносятся какие-либо атомарные изменения
      Переопределяет:
      seriesChanged в классе XYChart<X,​Y>
      Параметры:
      c - экземпляр Change, представляющий изменения в серии
    • seriesAdded

      protected void seriesAdded​(XYChart.Series<X,​Y> series,
                                 int seriesIndex)
      Описание, скопированное из класса: XYChart
      Серия была добавлена в модель данных диаграммы. Именно здесь реализации XYChart могут создавать/добавлять новые узлы в getPlotChildren для представления этой серии. Также вы должны обработать добавление любых элементов данных, которые уже есть в серии. Вы можете просто вызвать dataItemAdded() для каждого из них или предоставить какую-либо другую анимацию для добавления всей серии.
      Указывается в:
      seriesAdded в классе XYChart<X,​Y>
      Параметры:
      series - Серия, которая была добавлена
      seriesIndex - Индекс новой серии
    • seriesRemoved

      protected void seriesRemoved​(XYChart.Series<X,​Y> series)
      Описание, скопированное из класса: XYChart
      Серия была удалена из модели данных, но она все еще видна на диаграмме. Он все еще виден, чтобы вы могли обрабатывать анимацию его удаления в этом методе. После завершения анимации элемента данных вы должны вызвать removeSeriesFromDisplay(), чтобы удалить серию из списка отображения.
      Указывается в:
      seriesRemoved в классе XYChart<X,​Y>
      Параметры:
      series - Серия, которая была удалена
    • layoutPlotChildren

      protected void layoutPlotChildren()
      Вызывается для обновления и размещения дочерних элементов графика. Это должно включать в себя всю работу по обновлению узлов, представляющих график поверх осей, линий сетки и т. д. Начало координат находится в верхнем левом углу области построения графика, область построения графика можно получить, получив ширину оси x и ее высоту от высоты оси y.
      Указывается в:
      layoutPlotChildren в классе XYChart<X,​Y>
    • getClassCssMetaData

      public static List<CssMetaData<? extends Styleable,​?>> getClassCssMetaData()
      Возвращает:
      CssMetaData, связанный с этим классом, который может включать CssMetaData его суперклассов.
      С:
      JavaFX 8.0
    • getCssMetaData

      public List<CssMetaData<? extends Styleable,​?>> getCssMetaData()
      Этот метод должен делегировать Node.getClassCssMetaData() чтобы можно было получить доступ к CssMetaData узла без необходимости отражения.
      Указывается в:
      getCssMetaData в интерфейсе Styleable
      Переопределяет:
      getCssMetaData в классе XYChart<X,​Y>
      Возвращает:
      CssMetaData, связанный с этим узлом, который может включать CssMetaData его суперклассов.
      С:
      JavaFX 8.0

© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API