ods-charts
    Preparing search index...

    Class ODSChartsPopoverItem

    ODSChartsPopoverItem defines an item to be displayed in the popover/tooltip It is used in ODSChartsPopoverDefinition methods to customize the content of the popover/tooltip Example of use:

    themeManager.externalizePopover(undefined, {
       ...ODSCharts.ODSChartsPopoverManagers.NONE,
       getPopupContentLine: ({ seriesName, itemValue, seriesIndex }) => {
         return `<p>${themeManager.getPopoverMarker(seriesIndex)}This is my HTML code of one line for ${itemValue} of ${seriesName}</p>`;
       },
     });
    Index

    Constructors

    constructor

    Properties

    color data dataIndex dimensionIndex dimensionNames encode isTruncated itemColor itemValue label markerColor name percent seriesColor seriesIndex seriesName seriesType tickIndex treeAncestors treePathInfo value

    Constructors

    Properties

    color: string

    Color of data

    data: object

    Original data as input

    dataIndex: number

    Data index in input data array

    dimensionIndex: number

    data dimension index, for example 0 or 1 or 2 ... Only work in radar series.

    dimensionNames: string[]

    dimension names list

    encode: object

    encoding info of coordinate system Key: coord, like ('x' 'y' 'radius' 'angle') value: Must be an array, not null/undefined. Contain dimension indices, like: { x: [2] // values on dimension index 2 are mapped to x axis. y: [0] // values on dimension index 0 are mapped to y axis. }

    isTruncated: Function

    A function that returns a boolean value to flag if the axis label is truncated

    itemColor: string

    Color used to display the item

    itemValue: any

    Value of the item

    label: string

    label of the series the item belongs to

    markerColor: string

    Color of the marker representing the series

    name: string

    Data name; or category name

    percent: number

    The percentage of current data item in the pie/funnel series

    seriesColor: string

    Color used to display the series. May differ from itemColor in some cases (like specific item coloring)

    seriesIndex: number

    Series index in option.series

    seriesName: string

    name of the series the item belongs to

    seriesType: string

    Series type

    tickIndex: number

    Current index of the axis label tick

    treeAncestors: any[]

    The ancestors of current node in the tree/treemap series (including self)

    treePathInfo: any[]

    The ancestors of current node in the sunburst series (including self)

    value: number | object | any[]

    Value of data. In most series it is the same as data. But in some series it is some part of the data (e.g., in map, radar)

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties