Element: <oj-chart>

Oracle® JavaScript Extension Toolkit (JET)
4.2.0

E91398-01

QuickNav

Attributes


Context Objects

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Version:
  • 4.2.0
Since:
  • 0.7

JET Custom Elements

JET components are implemented as custom HTML elements. A detailed description of working with these elements can be found in: JET Custom Element Usage.

JET Chart

JET Chart with support for bar, line, area, combination, pie, scatter, bubble, funnel, box plot, and stock chart types.

The SVG DOM that this component generates should be treated as a black box, as it is subject to change.


<oj-chart
  type='bar'
  series='[{"name": "Q1 Sales", "items": [50, 60, 20]}]'
  groups='["Phone", "Tablets", "Laptops"]'
>
</oj-chart>

Accessibility

The application is responsible for populating the shortDesc value in the component properties object with meaningful descriptors when the component does not provide a default descriptor. Since component terminology for keyboard and touch shortcuts can conflict with those of the application, it is the application's responsibility to provide these shortcuts, possibly via a help popup.

Touch End User Information

Target Gesture Action
Data Item Tap Select when selectionMode is enabled.
Drill when drilling is enabled and selectionMode is none.
Double Tap Drill when drilling is enabled and selectionMode is enabled.
Press & Hold Display tooltip.
Display context menu on release.
Categorical Axis Item Tap Drill when drilling is enabled.
Legend Item Tap Drill when drilling is enabled.
Filter when hideAndShowBehavior is enabled.
Plot Area Drag Pan when panning is enabled and toggled into that mode.
Marquee select when selectionMode is multiple and toggled into that mode.
Pinch-close Zoom out when zooming is enabled.
Spread-open Zoom in when zooming is enabled.

Keyboard End User Information

Key Action
Tab Move focus to next element.
Shift + Tab Move focus to previous element.
UpArrow Move focus and selection to previous data item.
DownArrow Move focus and selection to next data item.
LeftArrow Move focus and selection to previous data item (on left).
RightArrow Move focus and selection to next data item (on right).
Shift + UpArrow Move focus and multi-select previous data item.
Shift + DownArrow Move focus and multi-select next data item.
Shift + LeftArrow Move focus and multi-select previous data item (on left).
Shift + RightArrow Move focus and multi-select next data item (on right).
Ctrl + UpArrow Move focus to previous data item, without changing the current selection.
Ctrl + DownArrow Move focus to next data item, without changing the current selection.
Ctrl + LeftArrow Move focus to previous data item (on left), without changing the current selection.
Ctrl + RightArrow Move focus to next data item (on right), without changing the current selection.
Ctrl + Spacebar Multi-select data item with focus.
= or + Zoom in one level if zooming is enabled.
- or _ Zoom out one level if zooming is enabled.
PageUp Pan up if scrolling is enabled.
PageDown Pan down if scrolling is enabled.
Shift + PageUp Pan left in left-to-right locales. Pan right in right-to-left locales.
Shift + PageDown Pan right in left-to-right locales. Pan left in right-to-left locales.
Enter Drill on data item, categorical axis label, or legend item when drilling is enabled.

Performance

Animation

Animation should only be enabled for visualizations of small to medium data sets. When animating changes to larger data sets or when animating between data sets, it's recommended to turn off the styleDefaults.animationIndicators, since they effectively double the amount of work required for the animation.

Data Set Size

As a rule of thumb, it's recommended that applications only set usable data densities on the chart. For example, it's not recommended to show more than 500 bars on a 500 pixel wide chart, since the bars will be unusably thin. While there are several optimizations within the chart to deal with large data sets, it's always more efficient to reduce the data set size as early as possible. Future optimizations will focus on improving end user experience as well as developer productivity for common use cases.

Styling

Use the highest level property available. For example, consider setting styling properties on styleDefaults or series, instead of styling properties on the individual data items. The chart can take advantage of these higher level properties to apply the style properties on containers, saving expensive DOM calls.

Tracking Resize

By default, the element will track resizes and render at the new size. This functionality adds a small overhead to the initial render for simple elements like gauges or spark charts, which become noticable when using large numbers of these simple elements. To disable resize tracking, set trackResize to off. The application can manually request a re-render at any time by calling the refresh function.

Reading direction

As with any JET component, in the unusual case that the directionality (LTR or RTL) changes post-init, the component must be refresh()ed.

Note: Application logic should not interact with the component's properties or invoke its methods until the BusyContext indicates that the component is ready for interaction.

Slots

JET elements can have up to two types of child content:

  • Any child element with a slot attribute will be moved into that named slot, e.g. <span slot='startIcon'>...</span>. All supported named slots are documented below. Child elements with unsupported named slots will be removed from the DOM.
  • Any child element lacking a slot attribute will be moved to the default slot, also known as a regular child.

contextMenu

The contextMenu slot is set on the oj-menu within this element. This is used to designate the JET Menu that this component should launch as a context menu on right-click, Shift-F10, Press & Hold, or component-specific gesture. If specified, the browser's native context menu will be replaced by the JET Menu specified in this slot.

The application can register a listener for the Menu's ojBeforeOpen event. The listener can cancel the launch via event.preventDefault(), or it can customize the menu contents by editing the menu DOM directly, and then calling refresh() on the Menu.

To help determine whether it's appropriate to cancel the launch or customize the menu, the ojBeforeOpen listener can use component API's to determine which table cell, chart item, etc., is the target of the context menu. See the JSDoc and demos of the individual components for details.

Keep in mind that any such logic must work whether the context menu was launched via right-click, Shift-F10, Press & Hold, or component-specific touch gesture.

Example

Initialize the component with a context menu:

<oj-some-element>
    <-- use the contextMenu slot to designate this as the context menu for this component -->
    <oj-menu slot="contextMenu" style="display:none" aria-label="Some element's context menu">
...
    </oj-menu>
</oj-some-element>

Attributes

animation-on-data-change :string

Defines the animation that is applied on data changes. Animation is automatically disabled when there are a large number of data items.
Supported Values:
Name Type
"auto" string
"none" string
"slideToLeft" string
"slideToRight" string
Default Value:
  • "none"
Names
Item Name
Property animationOnDataChange
Property change event animationOnDataChangeChanged
Property change listener attribute (must be of type function) on-animation-on-data-change-changed

animation-on-display :string

Defines the animation that is shown on initial display. Animation is automatically disabled when there are a large number of data items.
Supported Values:
Name Type
"alphaFade" string
"auto" string
"none" string
"zoom" string
Default Value:
  • "none"
Names
Item Name
Property animationOnDisplay
Property change event animationOnDisplayChanged
Property change listener attribute (must be of type function) on-animation-on-display-changed

coordinate-system :string

The coordinate system of the chart. Only applies to bar, line, area, combo, scatter, and bubble charts.
Supported Values:
Name Type
"cartesian" string
"polar" string
Default Value:
  • "cartesian"
Names
Item Name
Property coordinateSystem
Property change event coordinateSystemChanged
Property change listener attribute (must be of type function) on-coordinate-system-changed

data :object|Promise

An object with the following properties, used to define the series and groups when using a DataProvider to provide data to the chart. Also accepts a Promise for deferred data rendering.
Default Value:
  • null
Names
Item Name
Property data
Property change event dataChanged
Property change listener attribute (must be of type function) on-data-changed

data.groups :oj.DataProvider.<String, oj.ojChart.ChartGroup>

An oj.DataProvider that generates rows of ChartGroup typed objects.
Default Value:
  • null
Names
Item Name
Property data.groups

data.series :Array.<oj.ojChart.ChartSeries>|Promise.<Array>

An array of ChartSeries typed objects. Used when utilizing a DataProvider to provide data to the chart. Only a single series is supported for stock charts. Also accepts a Promise for deferred data rendering.
Default Value:
  • null
Names
Item Name
Property data.series

data-cursor :string

Defines whether the data cursor is enabled. If set to "auto", the data cursor is shown only for line or area charts on touch devices. The data cursor is not shown when the tooltip is null and it is not supported on polar charts.
Supported Values:
Name Type
"auto" string
"off" string
"on" string
Default Value:
  • "auto"
Names
Item Name
Property dataCursor
Property change event dataCursorChanged
Property change listener attribute (must be of type function) on-data-cursor-changed

data-cursor-behavior :string

Defines the behavior of the data cursor when moving between data items.
Supported Values:
Name Type
"auto" string
"smooth" string
"snap" string
Default Value:
  • "auto"
Names
Item Name
Property dataCursorBehavior
Property change event dataCursorBehaviorChanged
Property change listener attribute (must be of type function) on-data-cursor-behavior-changed

data-cursor-position :object

Speficies the position of the data cursor. Used for synchronizing data cursors across multiple charts. Null if the data cursor is not displayed.
Default Value:
  • null
Supports writeback:
  • true
Names
Item Name
Property dataCursorPosition
Property change event dataCursorPositionChanged
Property change listener attribute (must be of type function) on-data-cursor-position-changed

data-cursor-position.x :number|string

The x value of the data cursor.
Default Value:
  • null
Names
Item Name
Property dataCursorPosition.x

data-cursor-position.y :number

The y value of the data cursor. If both y and y2 are defined, y will take precedence.
Default Value:
  • null
Names
Item Name
Property dataCursorPosition.y

data-cursor-position.y2 :number

The y2 value of the data cursor. If both y and y2 are defined, y will take precedence.
Default Value:
  • null
Names
Item Name
Property dataCursorPosition.y2

data-label :function(object)

A function that returns a custom data label. The function takes a dataContext argument, provided by the chart, with the following properties:
  • id: The id of the data item.
  • series: The id of the series the data item belongs to.
  • group: The id or an array of ids of the group(s) the data item belongs to. For hierarchical groups, it will be an array of outermost to innermost group ids.
  • value, targetValue, x, y, z, low, high, open, close, volume: The values of the data item.
  • label: The label for the data item if the dataLabel callback is ignored. The dataLabel callback can concatenate this with another string to easily enhance the default label.
  • totalValue: The total of all values in the chart. This will only be included for pie charts.
  • data: The data object of the data item. For nested items, it will be an array containing the parent item data and nested item data.
  • seriesData: The data for the series the data item belongs to.
  • groupData: An array of data for the group the data item belongs to. For hierarchical groups, it will be an array of outermost to innermost group data related to the data item.
  • componentElement: The chart element.
The function may return a number or a string or in the case of range charts, an array of numbers or strings. If any label is a number, it will be formatted by the valueFormat of the type 'label' before being used as labels.
Default Value:
  • null
Names
Item Name
Property dataLabel
Property change event dataLabelChanged
Property change listener attribute (must be of type function) on-data-label-changed

dnd :object

Provides support for HTML5 Drag and Drop events. Please refer to third party documentation on HTML5 Drag and Drop to learn how to use it.
Default Value:
  • {}
Names
Item Name
Property dnd
Property change event dndChanged
Property change listener attribute (must be of type function) on-dnd-changed

dnd.drag :object

An object that describes drag functionality.
Default Value:
  • {}
Names
Item Name
Property dnd.drag

dnd.drag.groups :object

Allows dragging of chart groups from the categorical axis labels.
Default Value:
  • {}
Names
Item Name
Property dnd.drag.groups

dnd.drag.groups.data-types :string|Array.<string>

The MIME types to use for the dragged data in the dataTransfer object. This can be a string if there is only one type, or an array of strings if multiple types are needed. For example, if selected employee data items are being dragged, dataTypes could be "application/employees+json". Drop targets can examine the data types and decide whether to accept the data. For each type in the array, dataTransfer.setData will be called with the specified type and the data. The data is an array of the dataContexts of the selected groups. The dataContext is the JSON version of the dataContext that we use for "tooltip" and "dataLabels" properties, excluding componentElement and parentElement. This property is required unless the application calls setData itself in a dragStart callback function.
Default Value:
  • null
Names
Item Name
Property dnd.drag.groups.dataTypes

dnd.drag.groups.drag :function(Event)

An optional callback function that receives the "drag" event as argument.
Default Value:
  • null
Names
Item Name
Property dnd.drag.groups.drag

dnd.drag.groups.drag-end :function(Event)

An optional callback function that receives the "dragend" event as argument.
Default Value:
  • null
Names
Item Name
Property dnd.drag.groups.dragEnd

dnd.drag.groups.drag-start :function(Event, object)

An optional callback function that receives the "dragstart" event and context information as arguments. The context information is as follows:
  • groups {Array.(object)}: An array of dataContexts of the dragged groups. The dataContext is the same as what we use for "tooltip" and "dataLabels" properties.
This function can set its own data and drag image as needed. When this function is called, event.dataTransfer is already populated with the default data and drag image.
Default Value:
  • null
Names
Item Name
Property dnd.drag.groups.dragStart

dnd.drag.items :object

Allows dragging of chart data items, including bars, line/area/scatter markers, bubbles, and pie/funnel/pyramid slices.
Default Value:
  • {}
Names
Item Name
Property dnd.drag.items

dnd.drag.items.data-types :string|Array.<string>

The MIME types to use for the dragged data in the dataTransfer object. This can be a string if there is only one type, or an array of strings if multiple types are needed. For example, if selected employee data items are being dragged, dataTypes could be "application/employees+json". Drop targets can examine the data types and decide whether to accept the data. For each type in the array, dataTransfer.setData will be called with the specified type and the data. The data is an array of the dataContexts of the selected data items. The dataContext is the JSON version of the dataContext that we use for "tooltip" and "dataLabels" properties, excluding componentElement and parentElement. This property is required unless the application calls setData itself in a dragStart callback function.
Default Value:
  • null
Names
Item Name
Property dnd.drag.items.dataTypes

dnd.drag.items.drag :function(Event)

An optional callback function that receives the "drag" event as argument.
Default Value:
  • null
Names
Item Name
Property dnd.drag.items.drag

dnd.drag.items.drag-end :function(Event)

An optional callback function that receives the "dragend" event as argument.
Default Value:
  • null
Names
Item Name
Property dnd.drag.items.dragEnd

dnd.drag.items.drag-start :function(Event, object)

An optional callback function that receives the "dragstart" event and context information as arguments. The context information is as follows:
  • item {Array.(object)}: An array of dataContexts of the dragged data items. The dataContext is the same as what we use for "tooltip" and "dataLabels" properties.
This function can set its own data and drag image as needed. When this function is called, event.dataTransfer is already populated with the default data and drag image.
Default Value:
  • null
Names
Item Name
Property dnd.drag.items.dragStart

dnd.drag.series :object

Allows dragging of chart series from the legend items.
Default Value:
  • {}
Names
Item Name
Property dnd.drag.series

dnd.drag.series.data-types :string|Array.<string>

The MIME types to use for the dragged data in the dataTransfer object. This can be a string if there is only one type, or an array of strings if multiple types are needed. For example, if selected employee data items are being dragged, dataTypes could be "application/employees+json". Drop targets can examine the data types and decide whether to accept the data. For each type in the array, dataTransfer.setData will be called with the specified type and the data. The data is an array of the dataContexts of the selected series. The dataContext is the JSON version of the dataContext that we use for "tooltip" and "dataLabels" properties, excluding componentElement and parentElement. This property is required unless the application calls setData itself in a dragStart callback function.
Default Value:
  • null
Names
Item Name
Property dnd.drag.series.dataTypes

dnd.drag.series.drag :function(Event)

An optional callback function that receives the "drag" event as argument.
Default Value:
  • null
Names
Item Name
Property dnd.drag.series.drag

dnd.drag.series.drag-end :function(Event)

An optional callback function that receives the "dragend" event as argument.
Default Value:
  • null
Names
Item Name
Property dnd.drag.series.dragEnd

dnd.drag.series.drag-start :function(Event, object)

An optional callback function that receives the "dragstart" event and context information as arguments. The context information is as follows:
  • series {Array.(object)}: An array of dataContexts of the dragged series. The dataContext is the same as what we use for "tooltip" and "dataLabels" properties.
This function can set its own data and drag image as needed. When this function is called, event.dataTransfer is already populated with the default data and drag image.
Default Value:
  • null
Names
Item Name
Property dnd.drag.series.dragStart

dnd.drop :object

An object that describes drop functionality.
Default Value:
  • {}
Names
Item Name
Property dnd.drop

dnd.drop.legend :object

Allows dropping on the legend.
Default Value:
  • {}
Names
Item Name
Property dnd.drop.legend

dnd.drop.legend.data-types :string|Array.<string>

An array of MIME data types this element can accept. This property is required unless dragEnter, dragOver, and drop callback functions are specified to handle the corresponding events.
Default Value:
  • null
Names
Item Name
Property dnd.drop.legend.dataTypes

dnd.drop.legend.drag-enter :function(Event, object)

An optional callback function that receives the "dragenter" event and empty context information as arguments. This function should call event.preventDefault() to indicate the dragged data can be accepted. Otherwise, dataTypes will be matched against the drag data types to determine if the data is acceptable.
Default Value:
  • null
Names
Item Name
Property dnd.drop.legend.dragEnter

dnd.drop.legend.drag-leave :function(Event, object)

An optional callback function that receives the "dragleave" event and empty context information as arguments.
Default Value:
  • null
Names
Item Name
Property dnd.drop.legend.dragLeave

dnd.drop.legend.drag-over :function(Event, object)

An optional callback function that receives the "dragover" event and empty context information as arguments. This function should call event.preventDefault() to indicate the dragged data can be accepted. Otherwise, dataTypes will be matched against the drag data types to determine if the data is acceptable.
Default Value:
  • null
Names
Item Name
Property dnd.drop.legend.dragOver

dnd.drop.legend.drop :function(Event, object)

An optional callback function that receives the "drop" event and emtpy context information as arguments. This function should call event.preventDefault() to indicate the dragged data can be accepted.
Default Value:
  • null
Names
Item Name
Property dnd.drop.legend.drop

dnd.drop.plot-area :object

Allows dropping on the plot area.
Default Value:
  • {}
Names
Item Name
Property dnd.drop.plotArea

dnd.drop.plot-area.data-types :string|Array.<string>

An array of MIME data types this element can accept. This property is required unless dragEnter, dragOver, and drop callback functions are specified to handle the corresponding events.
Default Value:
  • null
Names
Item Name
Property dnd.drop.plotArea.dataTypes

dnd.drop.plot-area.drag-enter :function(Event, object)

An optional callback function that receives the "dragenter" event and context information as arguments. The context information is as follows:
  • x {number}: The X axis value at the event position.
  • y {number}: The Y axis value at the event position.
  • y2 {number}: The Y2 axis value at the event position.
This function should call event.preventDefault() to indicate the dragged data can be accepted. Otherwise, dataTypes will be matched against the drag data types to determine if the data is acceptable.
Default Value:
  • null
Names
Item Name
Property dnd.drop.plotArea.dragEnter

dnd.drop.plot-area.drag-leave :function(Event, object)

An optional callback function that receives the "dragleave" event and context information as arguments. The context information is as follows:
  • x {number}: The X axis value at the event position.
  • y {number}: The Y axis value at the event position.
  • y2 {number}: The Y2 axis value at the event position.
Default Value:
  • null
Names
Item Name
Property dnd.drop.plotArea.dragLeave

dnd.drop.plot-area.drag-over :function(Event, object)

An optional callback function that receives the "dragover" event and context information as arguments. The context information is as follows:
  • x {number}: The X axis value at the event position.
  • y {number}: The Y axis value at the event position.
  • y2 {number}: The Y2 axis value at the event position.
This function should call event.preventDefault() to indicate the dragged data can be accepted. Otherwise, dataTypes will be matched against the drag data types to determine if the data is acceptable.
Default Value:
  • null
Names
Item Name
Property dnd.drop.plotArea.dragOver

dnd.drop.plot-area.drop :function(Event, object)

An optional callback function that receives the "drop" event and context information as arguments. The context information is as follows:
  • x {number}: The X axis value at the event position.
  • y {number}: The Y axis value at the event position.
  • y2 {number}: The Y2 axis value at the event position.
This function should call event.preventDefault() to indicate the dragged data can be accepted.
Default Value:
  • null
Names
Item Name
Property dnd.drop.plotArea.drop

dnd.drop.x-axis :object

Allows dropping on the X axis.
Default Value:
  • {}
Names
Item Name
Property dnd.drop.xAxis

dnd.drop.x-axis.data-types :string|Array.<string>

An array of MIME data types this element can accept. This property is required unless dragEnter, dragOver, and drop callback functions are specified to handle the corresponding events.
Default Value:
  • null
Names
Item Name
Property dnd.drop.xAxis.dataTypes

dnd.drop.x-axis.drag-enter :function(Event, object)

An optional callback function that receives the "dragenter" event and context information as arguments. The context information is as follows:
  • x {number}: The X axis value at the event position.
This function should call event.preventDefault() to indicate the dragged data can be accepted. Otherwise, dataTypes will be matched against the drag data types to determine if the data is acceptable.
Default Value:
  • null
Names
Item Name
Property dnd.drop.xAxis.dragEnter

dnd.drop.x-axis.drag-leave :function(Event, object)

An optional callback function that receives the "dragleave" event and context information as arguments. The context information is as follows:
  • x {number}: The X axis value at the event position.
Default Value:
  • null
Names
Item Name
Property dnd.drop.xAxis.dragLeave

dnd.drop.x-axis.drag-over :function(Event, object)

An optional callback function that receives the "dragover" event and context information as arguments. The context information is as follows:
  • x {number}: The X axis value at the event position.
This function should call event.preventDefault() to indicate the dragged data can be accepted. Otherwise, dataTypes will be matched against the drag data types to determine if the data is acceptable.
Default Value:
  • null
Names
Item Name
Property dnd.drop.xAxis.dragOver

dnd.drop.x-axis.drop :function(Event, object)

An optional callback function that receives the "drop" event and context information as arguments. The context information is as follows:
  • x {number}: The X axis value at the event position.
This function should call event.preventDefault() to indicate the dragged data can be accepted.
Default Value:
  • null
Names
Item Name
Property dnd.drop.xAxis.drop

dnd.drop.y2-axis :object

Allows dropping on the Y2 axis.
Default Value:
  • {}
Names
Item Name
Property dnd.drop.y2Axis

dnd.drop.y2-axis.data-types :string|Array.<string>

An array of MIME data types this element can accept. This property is required unless dragEnter, dragOver, and drop callback functions are specified to handle the corresponding events.
Default Value:
  • null
Names
Item Name
Property dnd.drop.y2Axis.dataTypes

dnd.drop.y2-axis.drag-enter :function(Event, object)

An optional callback function that receives the "dragenter" event and context information as arguments. The context information is as follows:
  • y2 {number}: The Y2 axis value at the event position.
This function should call event.preventDefault() to indicate the dragged data can be accepted. Otherwise, dataTypes will be matched against the drag data types to determine if the data is acceptable.
Default Value:
  • null
Names
Item Name
Property dnd.drop.y2Axis.dragEnter

dnd.drop.y2-axis.drag-leave :function(Event, object)

An optional callback function that receives the "dragleave" event and context information as arguments. The context information is as follows:
  • y2 {number}: The Y2 axis value at the event position.
Default Value:
  • null
Names
Item Name
Property dnd.drop.y2Axis.dragLeave

dnd.drop.y2-axis.drag-over :function(Event, object)

An optional callback function that receives the "dragover" event and context information as arguments. The context information is as follows:
  • y2 {number}: The Y2 axis value at the event position.
This function should call event.preventDefault() to indicate the dragged data can be accepted. Otherwise, dataTypes will be matched against the drag data types to determine if the data is acceptable.
Default Value:
  • null
Names
Item Name
Property dnd.drop.y2Axis.dragOver

dnd.drop.y2-axis.drop :function(Event, object)

An optional callback function that receives the "drop" event and context information as arguments. The context information is as follows:
  • y2 {number}: The Y2 axis value at the event position.
This function should call event.preventDefault() to indicate the dragged data can be accepted.
Default Value:
  • null
Names
Item Name
Property dnd.drop.y2Axis.drop

dnd.drop.y-axis :object

Allows dropping on the Y axis.
Default Value:
  • {}
Names
Item Name
Property dnd.drop.yAxis

dnd.drop.y-axis.data-types :string|Array.<string>

An array of MIME data types this element can accept. This property is required unless dragEnter, dragOver, and drop callback functions are specified to handle the corresponding events.
Default Value:
  • null
Names
Item Name
Property dnd.drop.yAxis.dataTypes

dnd.drop.y-axis.drag-enter :function(Event, object)

An optional callback function that receives the "dragenter" event and context information as arguments. The context information is as follows:
  • y {number}: The Y axis value at the event position.
This function should call event.preventDefault() to indicate the dragged data can be accepted. Otherwise, dataTypes will be matched against the drag data types to determine if the data is acceptable.
Default Value:
  • null
Names
Item Name
Property dnd.drop.yAxis.dragEnter

dnd.drop.y-axis.drag-leave :function(Event, object)

An optional callback function that receives the "dragleave" event and context information as arguments. The context information is as follows:
  • y {number}: The Y axis value at the event position.
Default Value:
  • null
Names
Item Name
Property dnd.drop.yAxis.dragLeave

dnd.drop.y-axis.drag-over :function(Event, object)

An optional callback function that receives the "dragover" event and context information as arguments. The context information is as follows:
  • y {number}: The Y axis value at the event position.
This function should call event.preventDefault() to indicate the dragged data can be accepted. Otherwise, dataTypes will be matched against the drag data types to determine if the data is acceptable.
Default Value:
  • null
Names
Item Name
Property dnd.drop.yAxis.dragOver

dnd.drop.y-axis.drop :function(Event, object)

An optional callback function that receives the "drop" event and context information as arguments. The context information is as follows:
  • y {number}: The Y axis value at the event position.
This function should call event.preventDefault() to indicate the dragged data can be accepted.
Default Value:
  • null
Names
Item Name
Property dnd.drop.yAxis.drop

drag-mode :string

The action that is performed when a drag occurs on the chart. Pan and marquee zoom are only available if zoom and scroll is turned on. Marquee select is only available if multiple selection is turned on. If the value is set to "user" and multiple actions are available, buttons will be displayed on the plot area to let users switch between modes.
Supported Values:
Name Type
"off" string
"pan" string
"select" string
"user" string
"zoom" string
Default Value:
  • "user"
Names
Item Name
Property dragMode
Property change event dragModeChanged
Property change listener attribute (must be of type function) on-drag-mode-changed

drilling :string

Whether drilling is enabled. Drillable objects will show a pointer cursor on hover and fire an ojDrill event on click (double click if selection is enabled). Use "on" to enable drilling for all series objects (legend items), group objects (x-axis labels), and data items. Use "seriesOnly" or "groupsOnly" to enable drilling for series objects or group objects only. To enable or disable drilling on individual series, group, or data item, use the drilling attribute in each series, group, or data item.
Supported Values:
Name Type
"groupsOnly" string
"off" string
"on" string
"seriesOnly" string
Default Value:
  • "off"
Names
Item Name
Property drilling
Property change event drillingChanged
Property change listener attribute (must be of type function) on-drilling-changed

groups :Array.<object>|Array.<string>|Promise

An array of strings identifying the group labels, or an array of objects with the following properties. Also accepts a Promise for deferred data rendering.
Default Value:
  • null
Names
Item Name
Property groups
Property change event groupsChanged
Property change listener attribute (must be of type function) on-groups-changed

groups[].drilling :string

Whether drilling is enabled on the group label. Drillable objects will show a pointer cursor on hover and fire an ojDrill event on click. To enable drilling for all group labels at once, use the drilling attribute in the top level.
Supported Values:
Name Type
"inherit" string
"off" string
"on" string
Default Value:
  • "inherit"
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

groups[].groups :Array.<string>|Array.<object>

An array of nested group objects.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

groups[].id :string

The id of the group. Defaults to the name if not specified.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

groups[].labelStyle :object

The CSS style object defining the style of the group label text and only applies to a categorical axis.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

groups[].name :string

The name of the group.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

groups[].shortDesc :string

The description of the group. This is used for customizing the tooltip text and only applies to a categorical axis.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

hidden-categories :Array.<string>

An array of category strings used for filtering. Series or data items with any category matching an item in this array will be filtered.
Default Value:
  • []
Supports writeback:
  • true
Names
Item Name
Property hiddenCategories
Property change event hiddenCategoriesChanged
Property change listener attribute (must be of type function) on-hidden-categories-changed

hide-and-show-behavior :string

Defines the hide and show behavior that is performed when clicking on a legend item. When data items are hidden, the y axes can be optionally rescaled to fit to the remaining data.
Supported Values:
Name Type
"none" string
"withRescale" string
"withoutRescale" string
Default Value:
  • "none"
Names
Item Name
Property hideAndShowBehavior
Property change event hideAndShowBehaviorChanged
Property change listener attribute (must be of type function) on-hide-and-show-behavior-changed

highlight-match :string

The matching condition for the highlightedCategories property. By default, highlightMatch is 'all' and only items whose categories match all of the values specified in the highlightedCategories array will be highlighted. If highlightMatch is 'any', then items that match at least one of the highlightedCategories values will be highlighted.
Supported Values:
Name Type
"all" string
"any" string
Default Value:
  • "all"
Names
Item Name
Property highlightMatch
Property change event highlightMatchChanged
Property change listener attribute (must be of type function) on-highlight-match-changed

highlighted-categories :Array.<string>

An array of category strings used for highlighting. Series or data items matching all categories in this array will be highlighted.
Default Value:
  • []
Supports writeback:
  • true
Names
Item Name
Property highlightedCategories
Property change event highlightedCategoriesChanged
Property change listener attribute (must be of type function) on-highlighted-categories-changed

hover-behavior :string

Defines the behavior applied when hovering over data items.
Supported Values:
Name Type
"dim" string
"none" string
Default Value:
  • "none"
Names
Item Name
Property hoverBehavior
Property change event hoverBehaviorChanged
Property change listener attribute (must be of type function) on-hover-behavior-changed

initial-zooming :string

Whether automatic initial zooming is enabled. The valid values are "first" to initially zoom to the first data points (after the viewportMin) that can fit in the plot area, "last" to initially zoom to the last data points (before the viewportMax), and "none" to disable initial zooming. Only applies to bar, line, area, and combo charts with zoomAndScroll turned on.
Supported Values:
Name Type
"first" string
"last" string
"none" string
Default Value:
  • "none"
Names
Item Name
Property initialZooming
Property change event initialZoomingChanged
Property change listener attribute (must be of type function) on-initial-zooming-changed

legend :object

An object defining the style, positioning, and behavior of the legend.
Default Value:
  • {}
Names
Item Name
Property legend
Property change event legendChanged
Property change listener attribute (must be of type function) on-legend-changed

legend.background-color :string

The color of the legend background.
Default Value:
  • null
Names
Item Name
Property legend.backgroundColor

legend.border-color :string

The border color of the legend.
Default Value:
  • null
Names
Item Name
Property legend.borderColor

legend.max-size :string

Defines the maximum size of the legend in pixels (e.g. '50px') or percent (e.g. '15%').
Default Value:
  • null
Names
Item Name
Property legend.maxSize

legend.position :string

The position of the legend within the chart. By default, the legend will be placed on the side or bottom, based on the size of the chart and the legend contents.
Supported Values:
Name Type
"auto" string
"bottom" string
"end" string
"start" string
"top" string
Default Value:
  • "auto"
Names
Item Name
Property legend.position

legend.reference-object-section :object

An object with the following properties for the reference object section in the legend.
Default Value:
  • {}
Names
Item Name
Property legend.referenceObjectSection

legend.reference-object-section.title :string

The title of the reference object section.
Default Value:
  • null
Names
Item Name
Property legend.referenceObjectSection.title

legend.reference-object-section.title-halign :string

The horizontal alignment of the section title. If the section is collapsible or nested, only start alignment is supported.
Supported Values:
Name Type
"center" string
"end" string
"start" string
Default Value:
  • "start"
Names
Item Name
Property legend.referenceObjectSection.titleHalign

legend.reference-object-section.title-style :object

The CSS style object defining the style of the section title.
Default Value:
  • {}
Names
Item Name
Property legend.referenceObjectSection.titleStyle

legend.rendered :string

Defines whether the legend is displayed. If set to auto, the legend will be hidden for charts with a large number of series. To turn on legend for stock, funnel and pyramid charts, set the displayInLegend property for the series items to 'on'.
Supported Values:
Name Type
"auto" string
"off" string
"on" string
Default Value:
  • "auto"
Names
Item Name
Property legend.rendered

legend.scrolling :string

Defines whether scrolling is enabled for the legend.
Supported Values:
Name Type
"asNeeded" string
"off" string
Default Value:
  • "asNeeded"
Names
Item Name
Property legend.scrolling

legend.sections :Array.<object>

An array of objects with the following properties defining the additional legend sections, other than the default series and reference object sections.
Default Value:
  • []
Names
Item Name
Property legend.sections

legend.sections[].items :Array.<object>|Promise

An array of objects with the following properties defining the legend items. Also accepts a Promise for deferred data rendering.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

legend.sections[].items[].borderColor :string

The border color of the marker. Only applies if symbolType is "marker" or "lineWithMarker".
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

legend.sections[].items[].categories :Array.<string>

An array of categories for the legend item. Legend items currently only support a single category. If no category is specified, this defaults to the id or text of the legend item.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

legend.sections[].items[].categoryVisibility :string

Defines whether the legend item corresponds to visible data items. A hollow symbol is shown if the value is "hidden".
Supported Values:
Name Type
"hidden" string
"visible" string
Default Value:
  • "visible"
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

legend.sections[].items[].color :string

The color of the legend symbol (line or marker). When symbolType is "lineWithMarker", this attribute defines the line color and the markerColor attribute defines the marker color.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

legend.sections[].items[].id :string

The id of the legend item, which is provided as part of the context for events fired by this chart. If not specified, the id defaults to the text of the legend item.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

legend.sections[].items[].lineStyle :string

The line style. Only applies when the symbolType is "line" or "lineWithMarker".
Supported Values:
Name Type
"dashed" string
"dotted" string
"solid" string
Default Value:
  • "solid"
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

legend.sections[].items[].lineWidth :number

The line width in pixels. Only applies when the symbolType is "line" or "lineWithMarker".
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

legend.sections[].items[].markerColor :string

The color of the marker, if different than the line color. Only applies if the symbolType is "lineWithMarker".
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

legend.sections[].items[].markerShape :string

The shape of the marker. In addition to the built-in shapes, it may also take SVG path commands to specify a custom shape. The legend will style the custom shapes the same way as built-in shapes, supporting properties like color and borderColor and applying hover and filter effects. Only applies if symbolType is "marker" or "lineWithMarker".
Supported Values:
Name Type
"circle" string
"diamond" string
"human" string
"plus" string
"rectangle" string
"square" string
"star" string
"triangleDown" string
"triangleUp" string
Default Value:
  • "square"
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

legend.sections[].items[].pattern :string

The pattern used to fill the marker. Only applies if symbolType is "marker" or "lineWithMarker".
Supported Values:
Name Type
"largeChecker" string
"largeCrosshatch" string
"largeDiagonalLeft" string
"largeDiagonalRight" string
"largeDiamond" string
"largeTriangle" string
"none" string
"smallChecker" string
"smallCrosshatch" string
"smallDiagonalLeft" string
"smallDiagonalRight" string
"smallDiamond" string
"smallTriangle" string
Default Value:
  • "none"
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

legend.sections[].items[].shortDesc :string

The description of this legend item. This is used for accessibility and for customizing the tooltip text.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

legend.sections[].items[].source :string

The URI of the image of the legend symbol.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

legend.sections[].items[].symbolType :string

The type of legend symbol to display.
Supported Values:
Name Type
"image" string
"line" string
"lineWithMarker" string
"marker" string
Default Value:
  • "marker"
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

legend.sections[].items[].text :string

The legend item text.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

legend.sections[].sections :Array.<object>

An array of nested legend sections.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

legend.sections[].title :string

The title of the legend section.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

legend.sections[].titleHalign :string

The horizontal alignment of the section title. If the section is collapsible or nested, only start alignment is supported.
Supported Values:
Name Type
"center" string
"end" string
"start" string
Default Value:
  • "start"
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

legend.sections[].titleStyle :object

The CSS style object defining the style of the section title.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

legend.series-section :object

An object with the following properties for the series section in the legend.
Default Value:
  • {}
Names
Item Name
Property legend.seriesSection

legend.series-section.title :string

The title of the series section.
Default Value:
  • null
Names
Item Name
Property legend.seriesSection.title

legend.series-section.title-halign :string

The horizontal alignment of the section title. If the section is collapsible or nested, only start alignment is supported.
Supported Values:
Name Type
"center" string
"end" string
"start" string
Default Value:
  • "start"
Names
Item Name
Property legend.seriesSection.titleHalign

legend.series-section.title-style :object

The CSS style object defining the style of the section title.
Default Value:
  • {}
Names
Item Name
Property legend.seriesSection.titleStyle

legend.size :string

Defines the size of the legend in pixels (e.g. '50px') or percent (e.g. '15%').
Default Value:
  • null
Names
Item Name
Property legend.size

legend.symbol-height :number

The height of the legend symbol (line or marker) in pixels.
Default Value:
  • null
Names
Item Name
Property legend.symbolHeight

legend.symbol-width :number

The width of the legend symbol (line or marker) in pixels.
Default Value:
  • null
Names
Item Name
Property legend.symbolWidth

legend.text-style :object

The CSS style object defining the style of the legend text.
Default Value:
  • {}
Names
Item Name
Property legend.textStyle

legend.title :string

The legend title.
Default Value:
  • null
Names
Item Name
Property legend.title

legend.title-halign :string

The horizontal alignment of the title.
Supported Values:
Name Type
"center" string
"end" string
"start" string
Default Value:
  • "start"
Names
Item Name
Property legend.titleHalign

legend.title-style :object

The CSS style object defining the style of the title.
Default Value:
  • {}
Names
Item Name
Property legend.titleStyle

orientation :string

The chart orientation. Only applies to bar, line, area, combo, box plot, and funnel charts.
Supported Values:
Name Type
"horizontal" string
"vertical" string
Default Value:
  • "vertical"
Names
Item Name
Property orientation
Property change event orientationChanged
Property change listener attribute (must be of type function) on-orientation-changed

other-threshold :number

Specifies the fraction of the whole pie under which a slice would be aggregated into an "Other" slice. Valid values range from 0 (default) to 1. For example, a value of 0.1 would cause all slices which are less than 10% of the pie to be aggregated into the "Other" slice. Only applies to pie chart.
Default Value:
  • 0
Names
Item Name
Property otherThreshold
Property change event otherThresholdChanged
Property change listener attribute (must be of type function) on-other-threshold-changed

overview :object

An object defining the overview scrollbar. Only applies if zoomAndScroll is not off. Currently only supported for vertical bar, line, area, stock, and combo charts.
Default Value:
  • {}
Names
Item Name
Property overview
Property change event overviewChanged
Property change listener attribute (must be of type function) on-overview-changed

overview.content :object

An object containing the property override for the overview chart. The API is the same as the chart property API, and the property provided here will be merged on top of the default property of the overview chart. This can be used to customize the style or the type of the overview chart.
Default Value:
  • {}
Names
Item Name
Property overview.content

overview.height :string

Specifies the height of the overview scrollbar in pixels (e.g. '50px') or percent (e.g. '15%').
Default Value:
  • null
Names
Item Name
Property overview.height

overview.rendered :string

Specifies whether the overview scrollbar is rendered. If not, simple scrollbar will be used.
Supported Values:
Name Type
"off" string
"on" string
Default Value:
  • "off"
Names
Item Name
Property overview.rendered

pie-center :object

An object defining the center content of a pie chart. Either a label can be displayed at the center of the pie chart or custom HTML content.
Default Value:
  • {}
Names
Item Name
Property pieCenter
Property change event pieCenterChanged
Property change listener attribute (must be of type function) on-pie-center-changed

pie-center.converter :object

The converter (an object literal or instance that duck types oj.Converter) to format the label if it is numeric. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Default Value:
  • null
Names
Item Name
Property pieCenter.converter

pie-center.label :string

Specifies the text for the label. When a innerRadius is specified, the label will automatically be scaled to fit within the inner circle. If the innerRadius is 0, the default font size will be used.
Default Value:
  • null
Names
Item Name
Property pieCenter.label

pie-center.label-style :object

The CSS style object defining the style of the label.
Default Value:
  • {}
Names
Item Name
Property pieCenter.labelStyle

pie-center.renderer :function(object)

A function that returns custom center content. The function takes a dataContext argument, provided by the chart, with the following properties:
  • outerBounds: Object containing (x, y, width, height) of the rectangle circumscribing the center area. The x and y coordinates are relative to the top, left corner of the element.
  • innerBounds: Object containing (x, y, width, height) of the rectangle inscribed in the center area. The x and y coordinates are relative to the top, left corner of the element.
  • label: The pieCenter label.
  • componentElement: The chart element.
The function should return an Object with the following property:
  • insert: HTMLElement - An HTML element, which will be overlaid on top of the pie chart. This HTML element will block interactivity of the chart by default, but the CSS pointer-events property can be set to 'none' on this element if the chart's interactivity is desired.
Default Value:
  • null
Names
Item Name
Property pieCenter.renderer

pie-center.scaling :string

The scaling behavior of the label if it is numeric. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Supported Values:
Name Type
"auto" string
"billion" string
"million" string
"none" string
"quadrillion" string
"thousand" string
"trillion" string
Default Value:
  • "auto"
Names
Item Name
Property pieCenter.scaling

plot-area :object

An object defining the style of the plot area.
Default Value:
  • {}
Names
Item Name
Property plotArea
Property change event plotAreaChanged
Property change listener attribute (must be of type function) on-plot-area-changed

plot-area.background-color :string

The color of the plot area background.
Default Value:
  • null
Names
Item Name
Property plotArea.backgroundColor

plot-area.border-color :string

The border color to be set on the chart's plot area.
Default Value:
  • null
Names
Item Name
Property plotArea.borderColor

plot-area.border-width :number

The border width to be set on the chart's plot area.
Default Value:
  • null
Names
Item Name
Property plotArea.borderWidth

plot-area.rendered :string

Specifies whether the plot area is rendered.
Supported Values:
Name Type
"off" string
"on" string
Default Value:
  • "on"
Names
Item Name
Property plotArea.rendered

polar-grid-shape :string

Defines whether the grid shape of the polar chart is circle or polygon. Only applies to polar line and area charts.
Supported Values:
Name Type
"circle" string
"polygon" string
Default Value:
  • "circle"
Names
Item Name
Property polarGridShape
Property change event polarGridShapeChanged
Property change listener attribute (must be of type function) on-polar-grid-shape-changed

selection :Array.<string>

An array used to define the ids of the initially selected objects. When the selection is changed, the event.detail of the selectionChanged event will contain the following additional properties:

Name Type Description
selectionData Object an array containing objects describing the selected data items
Properties
Name Type Description
data object the data of the item, if one was specified
groupData Array the group data of the item
seriesData object the series data of the item
endGroup string the end group of a marquee selection on a chart with categorical axis
startGroup string the start group of a marquee selection on a chart with categorical axis
xMax number the maximum x value of a marquee selection
xMin number the minimum x value of a marquee selection
yMax number the maximum y value of a marquee selection
yMin number the minimum y value of a marquee selection
Default Value:
  • []
Supports writeback:
  • true
Names
Item Name
Property selection
Property change event selectionChanged
Property change listener attribute (must be of type function) on-selection-changed

selection-mode :string

The type of selection behavior that is enabled on the chart.
Supported Values:
Name Type
"multiple" string
"none" string
"single" string
Default Value:
  • "none"
Names
Item Name
Property selectionMode
Property change event selectionModeChanged
Property change listener attribute (must be of type function) on-selection-mode-changed

series :Array.<object>|Promise

An array of objects with the following properties, used to define series labels and override series styles. Only a single series is supported for stock charts. Also accepts a Promise for deferred data rendering.
Default Value:
  • null
Names
Item Name
Property series
Property change event seriesChanged
Property change listener attribute (must be of type function) on-series-changed

series[].areaColor :string

The area color of the series. Only applies if series type is area or lineWithArea.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].areaSvgClassName :string

The CSS style class to apply if series type is area or lineWithArea. The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the color attribute.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].areaSvgStyle :object

The inline style to apply if series type is area or lineWithArea. The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the color attribute.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].assignedToY2 :string

Defines whether the series is associated with the y2 axis. Only applies to Cartesian bar, line, area, and combo charts.
Supported Values:
Name Type
"off" string
"on" string
Default Value:
  • "off"
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].borderColor :string

The border color of the series.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].borderWidth :number

The border width of the series.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].boxPlot :object

An object containing the style properties of the box plot series.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].boxPlot.medianSvgClassName :string

The CSS style class to apply to the median line.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].boxPlot.medianSvgStyle :object

The CSS inline style to apply to the median line.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].boxPlot.q2Color :string

The color of the Q2 segment of the box.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].boxPlot.q2SvgClassName :string

The CSS style class to apply to the Q2 segment of the box. The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the q2Color attribute.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].boxPlot.q2SvgStyle :object

The CSS inline style to apply to the Q2 segment of the box. The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the q2Color attribute.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].boxPlot.q3Color :string

The color of the Q3 segment of the box.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].boxPlot.q3SvgClassName :string

The CSS style class to apply to the Q3 segment of the box. The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the q3Color attribute.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].boxPlot.q3SvgStyle :object

The CSS inline style to apply to the Q3 segment of the box. The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the q3Color attribute.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].boxPlot.whiskerEndLength :string

Specifies the length of the whisker ends in pixels (e.g. '9px') or as a percentage of the box width (e.g. '50%').
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].boxPlot.whiskerEndSvgClassName :string

The CSS style class to apply to the whisker ends.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].boxPlot.whiskerEndSvgStyle :object

The CSS inline style to apply to the whisker ends.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].boxPlot.whiskerSvgClassName :string

The CSS style class to apply to the whisker stems.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].boxPlot.whiskerSvgStyle :object

The CSS inline style to apply to the whisker stems.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].categories :Array.<string>

An optional array of category strings corresponding to this series. This allows highlighting and filtering of a series through interactions with legend sections. If not defined, the series id is used.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].color :string

The color of the series.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].displayInLegend :string

Defines whether the series should be shown in the legend. When set to 'auto', the series will not be displayed in the legend if it has null data or if it is a stock, funnel, or pyramid series.
Supported Values:
Name Type
"auto" string
"off" string
"on" string
Default Value:
  • "auto"
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].drilling :string

Whether drilling is enabled on the series item. Drillable objects will show a pointer cursor on hover and fire an ojDrill event on click. To enable drilling for all series items at once, use the drilling attribute in the top level.
Supported Values:
Name Type
"inherit" string
"off" string
"on" string
Default Value:
  • "inherit"
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].id :string

The id of the series. Defaults to the name or the series index if not specified.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items :Array.<object>|Array.<number>

An array of values or an array of objects with the following properties that defines the data items for the series.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].borderColor :string

The border color of the data item. For funnel and pyramid charts, it is used for the slice border.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].borderWidth :number

The border width of the data item. For funnel and pyramid charts, it is used for the slice border.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].boxPlot :object

An object containing the style properties of the box plot item.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].boxPlot.medianSvgClassName :string

The CSS style class to apply to the median line.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].boxPlot.medianSvgStyle :object

The CSS inline style to apply to the median line.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].boxPlot.q2Color :string

The color of the Q2 segment of the box.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].boxPlot.q2SvgClassName :string

The CSS style class to apply to the Q2 segment of the box. The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the q2Color attribute.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].boxPlot.q2SvgStyle :object

The CSS inline style to apply to the Q2 segment of the box. The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the q2Color attribute.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].boxPlot.q3SvgClassName :string

The CSS style class to apply to the Q3 segment of the box. The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the q3Color attribute.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].boxPlot.q3SvgStyle :object

The CSS inline style to apply to the Q3 segment of the box. The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the q3Color attribute.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].boxPlot.whiskerEndLength :string

Specifies the length of the whisker ends in pixels (e.g. '9px') or as a percentage of the box width (e.g. '50%'). The specified length will be rounded down to an odd number of pixels to ensure symmetry.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].boxPlot.whiskerEndSvgClassName :string

The CSS style class to apply to the whisker ends.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].boxPlot.whiskerEndSvgStyle :object

The CSS inline style to apply to the whisker ends.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].boxPlot.whiskerSvgClassName :string

The CSS style class to apply to the whisker stems.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].boxPlot.whiskerSvgStyle :object

The CSS inline style to apply to the whisker stems.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].categories :Array.<string>

An optional array of category strings corresponding to this data item. This enables highlighting and filtering of individual data items through interactions with the legend or other visualization elements. If not defined, series categories are used.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].close :number

The close value for stock candlestick. When bar, line, or area series type are used on a stock chart, this value is displayed.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].color :string

The color of the data item.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].drilling :string

Whether drilling is enabled for the data item. Drillable objects will show a pointer cursor on hover and fire an ojDrill event on click (double click if selection is enabled). To enable drilling for all data items at once, use the drilling attribute in the top level.
Supported Values:
Name Type
"inherit" string
"off" string
"on" string
Default Value:
  • "inherit"
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].high :number

The high value for range bar/area, stock candlestick, or box plot item. Define 'low' and 'high' instead of 'value' or 'y' to create a range bar/area chart.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].id :string

(Optional) The id of the data item. This id will be provided as part of the context for events on the chart.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].items :Array.<object>|Array.<number>

An array of nested data items to be used for defining the markers for outliers or additional data items of a box plot.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].label :string|Array.<string>

The label for the data item. For range series, if an array of two values are provided, the first and second value will apply to the low and high point respectively. Not supported for box plot or candlestick.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].labelPosition :string|Array.<string>

The position of the data label. For range series, if an array of two values are provided, the first and second value will apply to the low and high point respectively. The 'outsideSlice' value only applies to pie charts. The 'aboveMarker', 'belowMarker', 'beforeMarker', and 'afterMarker' values only apply to line, area, scatter, and bubble series. The 'insideBarEdge' and 'outsideBarEdge' values only apply to non-polar bar series. Stacked bars do not support 'outsideBarEdge'. The chart does not currently adjust layout to fit labels within the plot area or deal with any overlaps between labels.
Supported Values:
Name Type
"aboveMarker" string
"afterMarker" string
"auto" string
"beforeMarker" string
"belowMarker" string
"center" string
"insideBarEdge" string
"none" string
"outsideBarEdge" string
"outsideSlice" string
Default Value:
  • "auto"
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].labelStyle :object|Array.<object>

The CSS style object defining the style of the data label. For range series, if an array of two values are provided, the first and second value will apply to the low and high point respectively.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].low :number

The low value for range bar/area, stock candlestick, or box plot item. Define 'low' and 'high' instead of 'value' or 'y' to create a range bar/area chart.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].markerDisplayed :string

Defines whether the data marker is displayed. Only applies to line, area, scatter, and bubble series. If auto, the markers will be displayed whenever the data points are not connected by a line.
Supported Values:
Name Type
"auto" string
"off" string
"on" string
Default Value:
  • "auto"
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].markerShape :string

The shape of the data markers. In addition to the built-in shapes, it may also take SVG path commands to specify a custom shape. The chart will style the custom shapes the same way as built-in shapes, supporting properties like color and borderColor and applying hover and selection effects. Only 'auto' is supported for range series.
Supported Values:
Name Type
"auto" string
"circle" string
"diamond" string
"human" string
"plus" string
"square" string
"star" string
"triangleDown" string
"triangleUp" string
Default Value:
  • "auto"
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].markerSize :number

The size of the data markers. Does not apply to bubble charts, which calculate marker size based on the z values.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].open :number

The open value for stock candlestick.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].pattern :string

The pattern used to fill the data item. A solid fill is used by default, unless the seriesEffect is 'pattern'.
Supported Values:
Name Type
"auto" string
"largeChecker" string
"largeCrosshatch" string
"largeDiagonalLeft" string
"largeDiagonalRight" string
"largeDiamond" string
"largeTriangle" string
"smallChecker" string
"smallCrosshatch" string
"smallDiagonalLeft" string
"smallDiagonalRight" string
"smallDiamond" string
"smallTriangle" string
Default Value:
  • "auto"
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].q1 :number

The first quartile value for box plot.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].q2 :number

The second quartile (median) value for box plot.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].q3 :number

The third quartile value for box plot.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].shortDesc :string

The description of this object. This is used for accessibility and also for customizing the tooltip text.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].source :string

The URI of the custom image. If specified, it takes precedence over shape.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].sourceHover :string

The optional URI for the hover state. If not specified, the source image will be used.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].sourceHoverSelected :string

The optional URI for the hover selected state. If not specified, the source image will be used.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].sourceSelected :string

The optional URI for the selected state. If not specified, the source image will be used.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].svgClassName :string

The CSS style class to apply to the data item. The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the item color attribute.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].svgStyle :object

The inline style to apply to the data item. The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the item color attribute.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].targetValue :number

The target value for a funnel chart. When this is set, the value attribute defines the filled area within the slice and this represents the value of the whole slice.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].value :number

The value for this data item. Corresponding to the y value for bar, line, area, and combo charts and the slice values for pie, funnel and pyramid charts.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].volume :number

The value for stock volume bar. When this value is provided, the volume bar is displayed on the y2 axis.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].x :number|string

The x value. Mainly used for scatter and bubble chart and to specify the date for mixed-frequency time axis. For categorical axis, if the x value is not specified, it will default to the item index. For regular time axis, if the x value is not specified, it will default to the group name of the item.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].y :number

The y value. Also the primary value for charts without a y-Axis, such as pie charts.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].items[].z :number

The z value. Defines the bubble radius for a bubble chart, as well as the width of a bar or a box plot item.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].lineStyle :string

The line style of the data line. Only applies to line, lineWithArea, scatter, and bubble series.
Supported Values:
Name Type
"dashed" string
"dotted" string
"solid" string
Default Value:
  • "solid"
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].lineType :string

The line type of the data line or area. Only applies to line, area, scatter, and bubble series. centeredStepped and centeredSegmented are not supported for polar, scatter, and bubble charts.
Supported Values:
Name Type
"auto" string
"centeredSegmented" string
"centeredStepped" string
"curved" string
"none" string
"segmented" string
"stepped" string
"straight" string
Default Value:
  • "auto"
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].lineWidth :number

The width of the data line. Only applies to line, lineWithArea, scatter, and bubble series.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].markerColor :string

The color of the data markers, if different from the series color.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].markerDisplayed :string

Defines whether the data markers should be displayed. Only applies to line, area, scatter, and bubble series. If auto, the markers will be displayed whenever the data points are not connected by a line.
Supported Values:
Name Type
"auto" string
"off" string
"on" string
Default Value:
  • "auto"
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].markerShape :string

The shape of the data markers. In addition to the built-in shapes, it may also take SVG path commands to specify a custom shape. The chart will style the custom shapes the same way as built-in shapes, supporting properties like color and borderColor and applying hover and selection effects. Only 'auto' is supported for range series.
Supported Values:
Name Type
"auto" string
"circle" string
"diamond" string
"human" string
"plus" string
"square" string
"star" string
"triangleDown" string
"triangleUp" string
Default Value:
  • "auto"
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].markerSize :number

The size of the data markers.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].markerSvgClassName :string

The CSS style class to apply to the data markers.The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the marker color attribute.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].markerSvgStyle :object

The inline style to apply to the data markers. The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the marker color attribute.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].name :string

The name of the series, displayed in the legend and tooltips.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].pattern :string

The pattern used to fill the series. A solid fill is used by default, unless the seriesEffect is 'pattern'.
Supported Values:
Name Type
"auto" string
"largeChecker" string
"largeCrosshatch" string
"largeDiagonalLeft" string
"largeDiagonalRight" string
"largeDiamond" string
"largeTriangle" string
"smallChecker" string
"smallCrosshatch" string
"smallDiagonalLeft" string
"smallDiagonalRight" string
"smallDiamond" string
"smallTriangle" string
Default Value:
  • "auto"
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].pieSliceExplode :number

A number from 0 to 1 indicating the amount to explode the pie slice. Only applies to pie charts.
Default Value:
  • 0
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].shortDesc :string

The description of this series. This is used for accessibility and for customizing the tooltip text on the corressponding legend item for the series.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].source :string

The URI of the custom image. If specified, it takes precedence over shape.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].sourceHover :string

The optional URI for the hover state. If not specified, the source image will be used.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].sourceHoverSelected :string

The optional URI for the hover selected state. If not specified, the source image will be used.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].sourceSelected :string

The optional URI for the selected state. If not specified, the source image will be used.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].stackCategory :string

In stacked charts, groups series together for stacking. All series without a stackCategory will be assigned to the same stack.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].svgClassName :string

The CSS style class to apply to the series. For series of type lineWithArea, this style will only be applied to the line if areaClassName is also specified. The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the color attribute.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].svgStyle :object

The inline style to apply to the series. For series of type lineWithArea, this style will only be applied to the line if areaStyle is also specified.The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the color attribute.
Default Value:
  • null
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

series[].type :string

The type of data objects to display for this series. Only applies to bar, line, area, stock, box plot, and combo charts.
Supported Values:
Name Type
"area" string
"auto" string
"bar" string
"boxPlot" string
"candlestick" string
"line" string
"lineWithArea" string
Default Value:
  • "auto"
Note: This property is a subproperty of an array-valued property. Such properties cannot be set individually either at init time via HTML attribute syntax or at runtime via JavaScript. Instead, the outermost array-valued attribute, and its ancestor attributes, can be set at init time or runtime.

sorting :string

Specifies the sorting of the data. It should only be used for pie charts, bar/line/area charts with one series, or stacked bar/area charts. Sorting will not apply when using a hierarchical group axis.
Supported Values:
Name Type
"ascending" string
"descending" string
"off" string
Default Value:
  • "off"
Names
Item Name
Property sorting
Property change event sortingChanged
Property change listener attribute (must be of type function) on-sorting-changed

split-dual-y :string

Defines whether the plot area is split into two sections, so that sets of data assigned to the different Y-axes appear in different parts of the plot area. Stock charts do not support "off".
Supported Values:
Name Type
"auto" string
"off" string
"on" string
Default Value:
  • "auto"
Names
Item Name
Property splitDualY
Property change event splitDualYChanged
Property change listener attribute (must be of type function) on-split-dual-y-changed

splitter-position :number

In a split dual-Y chart, specifies the fraction of the space that is given to the Y-axis subchart. Valid values are numbers from 0 to 1.
Default Value:
  • 0.5
Names
Item Name
Property splitterPosition
Property change event splitterPositionChanged
Property change listener attribute (must be of type function) on-splitter-position-changed

stack :string

Defines whether the data items are stacked. Only applies to bar, line, area, and combo charts. Does not apply to range series.
Supported Values:
Name Type
"off" string
"on" string
Default Value:
  • "off"
Names
Item Name
Property stack
Property change event stackChanged
Property change listener attribute (must be of type function) on-stack-changed

stack-label :string

Defines whether or not the total values of stacked data items should be displayed. Only applies to bar charts. It can be formatted by the valueFormat of the type 'label'.
Supported Values:
Name Type
"off" string
"on" string
Default Value:
  • "off"
Names
Item Name
Property stackLabel
Property change event stackLabelChanged
Property change listener attribute (must be of type function) on-stack-label-changed

style-defaults :object

An object defining the default styles for series colors, marker shapes, and other style attributes. Properties specified on this object may be overridden by specifications on the data object.
Default Value:
  • {}
Names
Item Name
Property styleDefaults
Property change event styleDefaultsChanged
Property change listener attribute (must be of type function) on-style-defaults-changed

style-defaults.animation-down-color :string

The color of the indicator shown for a decreasing data change animation.
Default Value:
  • null
Names
Item Name
Property styleDefaults.animationDownColor

style-defaults.animation-duration :number

The duration of the animations, in milliseconds.
Default Value:
  • null
Names
Item Name
Property styleDefaults.animationDuration

style-defaults.animation-indicators :string

Defines whether data change indicators are displayed during animation.
Supported Values:
Name Type
"all" string
"none" string
Default Value:
  • "all"
Names
Item Name
Property styleDefaults.animationIndicators

style-defaults.animation-up-color :string

The color of the indicator shown for an increasing data change animation.
Default Value:
  • null
Names
Item Name
Property styleDefaults.animationUpColor

style-defaults.bar-gap-ratio :number

Specifies the width of the bar group gap as a ratio of the group width. The valid value is a number from 0 to 1.
Default Value:
  • null
Names
Item Name
Property styleDefaults.barGapRatio

style-defaults.border-color :string

The default border color for the data items. For funnel and pyramid charts, it is used for the slice border.
Default Value:
  • null
Names
Item Name
Property styleDefaults.borderColor

style-defaults.border-width :number

The default border width for the data items. For funnel and pyramid charts, it is used for the slice border.
Default Value:
  • null
Names
Item Name
Property styleDefaults.borderWidth

style-defaults.box-plot :object

An object containing the style properties of the box plot items.
Default Value:
  • {}
Names
Item Name
Property styleDefaults.boxPlot

style-defaults.box-plot.median-svg-class-name :string

The CSS style class to apply to the median line.
Default Value:
  • ""
Names
Item Name
Property styleDefaults.boxPlot.medianSvgClassName

style-defaults.box-plot.median-svg-style :object

The CSS inline style to apply to the median line.
Default Value:
  • {}
Names
Item Name
Property styleDefaults.boxPlot.medianSvgStyle

style-defaults.box-plot.whisker-end-length :string

Specifies the length of the whisker ends in pixels (e.g. '9px') or as a percentage of the box width (e.g. '50%').
Default Value:
  • null
Names
Item Name
Property styleDefaults.boxPlot.whiskerEndLength

style-defaults.box-plot.whisker-end-svg-class-name :string

The CSS style class to apply to the whisker ends.
Default Value:
  • ""
Names
Item Name
Property styleDefaults.boxPlot.whiskerEndSvgClassName

style-defaults.box-plot.whisker-end-svg-style :object

The CSS inline style to apply to the whisker ends.
Default Value:
  • {}
Names
Item Name
Property styleDefaults.boxPlot.whiskerEndSvgStyle

style-defaults.box-plot.whisker-svg-class-name :string

The CSS style class to apply to the whisker stems.
Default Value:
  • ""
Names
Item Name
Property styleDefaults.boxPlot.whiskerSvgClassName

style-defaults.box-plot.whisker-svg-style :object

The CSS inline style to apply to the whisker stems.
Default Value:
  • {}
Names
Item Name
Property styleDefaults.boxPlot.whiskerSvgStyle

style-defaults.colors :Array.<string>

The array defining the default color ramp for the series.
Default Value:
  • null
Names
Item Name
Property styleDefaults.colors

style-defaults.data-cursor :object

An object defining the data cursor style.
Default Value:
  • {}
Names
Item Name
Property styleDefaults.dataCursor

style-defaults.data-cursor.line-color :string

The color of the data cursor line.
Default Value:
  • null
Names
Item Name
Property styleDefaults.dataCursor.lineColor

style-defaults.data-cursor.line-style :string

The line style of the data cursor line.
Supported Values:
Name Type
"dashed" string
"dotted" string
"solid" string
Default Value:
  • "solid"
Names
Item Name
Property styleDefaults.dataCursor.lineStyle

style-defaults.data-cursor.line-width :number

The width of the data cursor line in pixels.
Default Value:
  • null
Names
Item Name
Property styleDefaults.dataCursor.lineWidth

style-defaults.data-cursor.marker-color :string

The color of the data cursor marker. Defaults to the data series color.
Default Value:
  • null
Names
Item Name
Property styleDefaults.dataCursor.markerColor

style-defaults.data-cursor.marker-displayed :string

Whether the data cursor marker is displayed. Marker should only be hidden if the data cursor is displaying information for the entire group.
Supported Values:
Name Type
"off" string
"on" string
Default Value:
  • "on"
Names
Item Name
Property styleDefaults.dataCursor.markerDisplayed

style-defaults.data-cursor.marker-size :number

The size of the data cursor marker in pixels.
Default Value:
  • null
Names
Item Name
Property styleDefaults.dataCursor.markerSize

style-defaults.data-item-gaps :string

Specifies the presence and size of the gaps between data items, such as bars, markers, and areas. Valid values are a percentage string from 0% to 100%, where 100% produces the maximum supported gaps.
Default Value:
  • null
Names
Item Name
Property styleDefaults.dataItemGaps

style-defaults.data-label-position :string|Array.<string>

The position of the data label. For range series, if an array of two values are provided, the first and second value will apply to the low and high point respectively. The 'outsideSlice' value only applies to pie charts. The 'aboveMarker', 'belowMarker', 'beforeMarker', and 'afterMarker' values only apply to line, area, scatter, and bubble series. The 'insideBarEdge' and 'outsideBarEdge' values only apply to non-polar bar series. Stacked bars do not support 'outsideBarEdge'. The chart does not currently adjust layout to fit labels within the plot area or deal with any overlaps between labels.
Supported Values:
Name Type
"aboveMarker" string
"afterMarker" string
"auto" string
"beforeMarker" string
"belowMarker" string
"center" string
"insideBarEdge" string
"none" string
"outsideBarEdge" string
"outsideSlice" string
Default Value:
  • "auto"
Names
Item Name
Property styleDefaults.dataLabelPosition

style-defaults.data-label-style :object|Array.<object>

The CSS style object defining the style of the data label text. For range series, if an array of two values are provided, the first and second value will apply to the low and high point respectively.
Default Value:
  • null
Names
Item Name
Property styleDefaults.dataLabelStyle

style-defaults.funnel-background-color :string

The default background color of funnel slices that show actual/target values.
Default Value:
  • null
Names
Item Name
Property styleDefaults.funnelBackgroundColor

style-defaults.group-separators :object

An object defining the style for hierarchical label separators.
Default Value:
  • {}
Names
Item Name
Property styleDefaults.groupSeparators

style-defaults.group-separators.color :string

The color of the separators lines.
Default Value:
  • null
Names
Item Name
Property styleDefaults.groupSeparators.color

style-defaults.group-separators.rendered :string

Defines whether the group separators are displayed.
Supported Values:
Name Type
"off" string
"on" string
Default Value:
  • "on"
Names
Item Name
Property styleDefaults.groupSeparators.rendered

style-defaults.hover-behavior-delay :number

Specifies initial hover delay in ms for highlighting items in chart.
Default Value:
  • null
Names
Item Name
Property styleDefaults.hoverBehaviorDelay

style-defaults.line-style :string

The line style of the data line. Only applies to line, lineWithArea, scatter, and bubble series.
Supported Values:
Name Type
"dashed" string
"dotted" string
"solid" string
Default Value:
  • "solid"
Names
Item Name
Property styleDefaults.lineStyle

style-defaults.line-type :string

The line type of the data line or area. Only applies to line, area, scatter, and bubble series. centeredStepped and centeredSegmented are not supported for polar, scatter, and bubble charts.
Supported Values:
Name Type
"auto" string
"centeredSegmented" string
"centeredStepped" string
"curved" string
"none" string
"segmented" string
"stepped" string
"straight" string
Default Value:
  • "auto"
Names
Item Name
Property styleDefaults.lineType

style-defaults.line-width :number

The width of the data line. Only applies to line, lineWithArea, scatter, and bubble series.
Default Value:
  • null
Names
Item Name
Property styleDefaults.lineWidth

style-defaults.marker-color :string

The color of the data markers, if different from the series color.
Default Value:
  • null
Names
Item Name
Property styleDefaults.markerColor

style-defaults.marker-displayed :string

Defines whether the data markers should be displayed. Only applies to line, area, scatter, and bubble series. If auto, the markers will be displayed whenever the data points are not connected by a line.
Supported Values:
Name Type
"auto" string
"off" string
"on" string
Default Value:
  • "auto"
Names
Item Name
Property styleDefaults.markerDisplayed

style-defaults.marker-shape :string

The shape of the data markers. In addition to the built-in shapes, it may also take SVG path commands to specify a custom shape. The chart will style the custom shapes the same way as built-in shapes, supporting properties like color and borderColor and applying hover and selection effects. Only 'auto' is supported for range series.
Supported Values:
Name Type
"auto" string
"circle" string
"diamond" string
"human" string
"plus" string
"square" string
"star" string
"triangleDown" string
"triangleUp" string
Default Value:
  • "auto"
Names
Item Name
Property styleDefaults.markerShape

style-defaults.marker-size :number

The size of the data markers in pixels.
Default Value:
  • null
Names
Item Name
Property styleDefaults.markerSize

style-defaults.marquee-border-color :string

The border color of the marquee. Applies to marquee selection and marquee zoom.
Default Value:
  • null
Names
Item Name
Property styleDefaults.marqueeBorderColor

style-defaults.marquee-color :string

The fill color of the marquee. Applies to marquee selection and marquee zoom.
Default Value:
  • null
Names
Item Name
Property styleDefaults.marqueeColor

style-defaults.max-bar-width :number

Specifies the maximum width of each bar in pixels.
Default Value:
  • null
Names
Item Name
Property styleDefaults.maxBarWidth

style-defaults.other-color :string

Specifies the color of the "Other" slice. Only applies to pie chart.
Default Value:
  • null
Names
Item Name
Property styleDefaults.otherColor

style-defaults.patterns :Array.<string>

The array defining the default pattern ramp for the series. This is used only when seriesEffect is 'pattern'.
Default Value:
  • null
Names
Item Name
Property styleDefaults.patterns

style-defaults.pie-feeler-color :string

The color of the line extending from the pie slice to the slice label.
Default Value:
  • null
Names
Item Name
Property styleDefaults.pieFeelerColor

style-defaults.pie-inner-radius :number

Specifies the radius of the inner circle that can be used to create a donut chart. Valid values range from 0 (default) to 1. Not supported if 3D effect is on.
Default Value:
  • 0
Names
Item Name
Property styleDefaults.pieInnerRadius

style-defaults.selection-effect :string

The selection effect that is applied to selected items. The values explode and highlightAndExplode only apply to pie charts.
Supported Values:
Name Type
"explode" string
"highlight" string
"highlightAndExplode" string
Default Value:
  • "highlight"
Names
Item Name
Property styleDefaults.selectionEffect

style-defaults.series-effect :string

Defines the fill effect for the data items.
Supported Values:
Name Type
"color" string
"gradient" string
"pattern" string
Default Value:
  • "gradient"
Names
Item Name
Property styleDefaults.seriesEffect

style-defaults.shapes :Array.<string>

The array defining the default shape ramp for the series. Valid values are defined in the markerShape attribute.
Default Value:
  • null
Names
Item Name
Property styleDefaults.shapes

style-defaults.stack-label-style :object

The CSS style object defining the style of the stack label. Only applies to stacked bar charts.
Default Value:
  • {}
Names
Item Name
Property styleDefaults.stackLabelStyle

style-defaults.stock-falling-color :string

In stock charts, the color of the candlestick when the 'open' value is greater than the 'close' value.
Default Value:
  • null
Names
Item Name
Property styleDefaults.stockFallingColor

style-defaults.stock-range-color :string

In stock charts, the color of the range bars for candlestick.
Default Value:
  • null
Names
Item Name
Property styleDefaults.stockRangeColor

style-defaults.stock-rising-color :string

In stock charts, the color of the candlestick when the 'close' value is greater than the 'open' value.
Default Value:
  • null
Names
Item Name
Property styleDefaults.stockRisingColor

style-defaults.stock-volume-color :string

In stock charts, the color of the volume bars. If specified, overrides the default rising and falling colors used by the volume bars.
Default Value:
  • null
Names
Item Name
Property styleDefaults.stockVolumeColor

style-defaults.three-d-effect :string

Defines whether the chart is displayed with a 3D effect. Only applies to pie, funnel and pyramid charts.
Supported Values:
Name Type
"off" string
"on" string
Default Value:
  • "off"
Names
Item Name
Property styleDefaults.threeDEffect

style-defaults.tooltip-label-style :object

The CSS style object defining the style of the labels in the tooltip.
Default Value:
  • {}
Names
Item Name
Property styleDefaults.tooltipLabelStyle

style-defaults.tooltip-value-style :object

The CSS style object defining the style of the values in the tooltip.
Default Value:
  • {}
Names
Item Name
Property styleDefaults.tooltipValueStyle

time-axis-type :string

The type of time axis to display in the chart. Time axis is only supported for Cartesian bar, line, area, stock, box plot, and combo charts. If the type is "enabled" or "skipGaps", the time values must be provided through the "groups" attribute and stacking is supported. If the type is "skipGaps", the groups will be rendered at a regular interval regardless of any time gaps that may exist in the data. If the type is "mixedFrequency", the time values must be provided through the "x" attribute of the the data items and stacking is not supported.
Supported Values:
Name Type
"auto" string
"disabled" string
"enabled" string
"mixedFrequency" string
"skipGaps" string
Default Value:
  • "auto"
Names
Item Name
Property timeAxisType
Property change event timeAxisTypeChanged
Property change listener attribute (must be of type function) on-time-axis-type-changed

tooltip :object

An object containing an optional callback function for tooltip customization.
Default Value:
  • {}
Names
Item Name
Property tooltip
Property change event tooltipChanged
Property change listener attribute (must be of type function) on-tooltip-changed

tooltip.renderer :function(object)

A function that returns a custom tooltip. The function takes a dataContext argument, provided by the chart, with the following properties:
  • parentElement: The tooltip element. This can be used to change the tooltip border or background color.
  • id: The id of the hovered item.
  • series: The id of the series the hovered item belongs to.
  • group: The ids or an array of ids of the group(s) the hovered item belongs to. For hierarchical groups, it will be an array of outermost to innermost group ids.
  • value, targetValue, x, y, z, low, high, open, close, volume: The values of the hovered item.
  • label: The data label of the hovered item.
  • data: The data object of the hovered item. For nested items, it will be an array containing the parent item data and nested item data.
  • seriesData: The data for the series the hovered item belongs to.
  • groupData: An array of data for the group the hovered item belongs to. For hierarchical groups, it will be an array of outermost to innermost group data related to the hovered item.
  • componentElement: The chart element.
  • color: The color of the hovered item.
For reference objects, this tooltip function is only called if the reference object has an id. Note: In future releases, tooltips may be fired for objects other than data items and reference objects. To know whether a hovered object is a data item, please check that the "series" and "group" properties are not null. The function should return an Object that contains only one of the two properties:
  • insert: HTMLElement | string - An HTML element, which will be appended to the tooltip, or a tooltip string.
  • preventDefault: true - Indicates that the tooltip should not be displayed. It is not necessary to return {preventDefault:false} to display tooltip, since this is a default behavior.
Default Value:
  • null
Names
Item Name
Property tooltip.renderer

touch-response :string

Data visualizations require a press and hold delay before triggering tooltips, marquee selection, and rollover effects on mobile devices to avoid interfering with page panning, but these hold delays can make applications seem slower and less responsive. For a better user experience, the application can remove the touch and hold delay when data visualizations are used within a non scrolling container or if there is sufficient space outside of the visualization for panning. If touchResponse is touchStart the element will instantly trigger the touch gesture and consume the page pan events if the element does not require an internal feature that requires a touch start gesture like panning, zooming, or when marquee selection is initiated. If touchResponse is auto, the element will behave like touchStart if it determines that it is not rendered within scrolling content and if panning is not available for those elements that support the feature.
Supported Values:
Name Type
"auto" string
"touchStart" string
Default Value:
  • "auto"
Names
Item Name
Property touchResponse
Property change event touchResponseChanged
Property change listener attribute (must be of type function) on-touch-response-changed

track-resize :string

Defines whether the element will automatically render in response to changes in size. If set to off, then the application is responsible for calling refresh to render the element at the new size.
Supported Values:
Name Type
"off" string
"on" string
Default Value:
  • "on"
Names
Item Name
Property trackResize
Property change event trackResizeChanged
Property change listener attribute (must be of type function) on-track-resize-changed
Examples

Initialize the data visualization element with the track-resize attribute specified:

<oj-some-dvt track-resize='off'></oj-some-dvt>

Get or set the trackResize property after initialization:

// getter
var value = myComponent.trackResize;

// setter
myComponent.trackResize="off";

translations :Object

A collection of translated resources from the translation bundle, or null if this component has no resources. Resources may be accessed and overridden individually or collectively, as seen in the examples.

If this component has translations, their documentation immediately follows this doc entry.

Default Value:
  • an object containing all resources relevant to the component, or null if none
Names
Item Name
Property translations
Property change event translationsChanged
Property change listener attribute (must be of type function) on-translations-changed
Examples

Initialize the component, overriding some translated resources and leaving the others intact:

<!-- Using dot notation -->
<oj-some-element translations.some-key='some value' translations.some-other-key='some other value'></oj-some-element>

<!-- Using JSON notation -->
<oj-some-element translations='{"someKey":"some value", "someOtherKey":"some other value"}'></oj-some-element>

Get or set the translations property after initialization:

// Get one
var value = myComponent.translations.someKey;

// Set one, leaving the others intact. Always use the setProperty API for 
// subproperties rather than setting a subproperty directly.
myComponent.setProperty('translations.someKey', 'some value');

// Get all
var values = myComponent.translations;

// Set all.  Must list every resource key, as those not listed are lost.
myComponent.translations = {
    someKey: 'some value',
    someOtherKey: 'some other value'
};

translations.component-name :string

Used to describe the data visualization type for accessibility.

See the translations attribute for usage examples.

Default Value:
  • "Chart"
Names
Item Name
Property translations.componentName

translations.label-and-value :string

Used to display a label and its value.

See the translations attribute for usage examples.

Default Value:
  • "{0}: {1}"
Names
Item Name
Property translations.labelAndValue

translations.label-clear-selection :string

Text shown for clearing multiple selection on touch devices.

See the translations attribute for usage examples.

Default Value:
  • "Clear Selection"
Names
Item Name
Property translations.labelClearSelection

translations.label-close :string

Used for the close value in the tooltip for stock data.

See the translations attribute for usage examples.

Default Value:
  • "Close"
Names
Item Name
Property translations.labelClose

translations.label-count-with-total :string

Used to display a count out of a total.

See the translations attribute for usage examples.

Default Value:
  • "{0} of {1}"
Names
Item Name
Property translations.labelCountWithTotal

translations.label-data-visualization :string

Label for data visualizations used for accessibility.

See the translations attribute for usage examples.

Default Value:
  • "Data Visualization"
Names
Item Name
Property translations.labelDataVisualization

translations.label-date :string

Used for the date value in the tooltip, if a time axis is being used.

See the translations attribute for usage examples.

Default Value:
  • "Value"
Names
Item Name
Property translations.labelDate

translations.label-default-group-name :string

Used when the group names are not specified.

See the translations attribute for usage examples.

Default Value:
  • "Group {0}"
Names
Item Name
Property translations.labelDefaultGroupName

translations.label-group :string

Used for the default tooltip.

See the translations attribute for usage examples.

Default Value:
  • "Group"
Names
Item Name
Property translations.labelGroup

translations.label-high :string

>Used for the high value in the tooltip for stock and range data.

See the translations attribute for usage examples.

Default Value:
  • "High"
Names
Item Name
Property translations.labelHigh

translations.label-invalid-data :string

Text shown when the component receives invalid data.

See the translations attribute for usage examples.

Default Value:
  • "Invalid data"
Names
Item Name
Property translations.labelInvalidData

translations.label-low :string

Used for the low value in the tooltip for stock and range data.

See the translations attribute for usage examples.

Default Value:
  • "Low"
Names
Item Name
Property translations.labelLow

translations.label-no-data :string

Text shown when the component receives no data.

See the translations attribute for usage examples.

Default Value:
  • "No data to display"
Names
Item Name
Property translations.labelNoData

translations.label-open :string

Used for the open value in the tooltip for stock data.

See the translations attribute for usage examples.

Default Value:
  • "Open"
Names
Item Name
Property translations.labelOpen

translations.label-other :string

Used for the other series label which aggregates small data values.

See the translations attribute for usage examples.

Default Value:
  • "Other"
Names
Item Name
Property translations.labelOther

translations.label-percentage :string

Used for displaying the percentage in the tooltip.

See the translations attribute for usage examples.

Default Value:
  • "Percentage"
Names
Item Name
Property translations.labelPercentage

translations.label-q1 :string

Used for displaying the first quartile for box plots.

See the translations attribute for usage examples.

Default Value:
  • "Q1"
Names
Item Name
Property translations.labelQ1

translations.label-q2 :string

Used for displaying the second quartile (i.e. median) for box plots.

See the translations attribute for usage examples.

Default Value:
  • "Q2"
Names
Item Name
Property translations.labelQ2

translations.label-q3 :string

Used for displaying the third quartile for box plots.

See the translations attribute for usage examples.

Default Value:
  • "Q3"
Names
Item Name
Property translations.labelQ3

translations.label-series :string

Used for the default tooltip.

See the translations attribute for usage examples.

Default Value:
  • "Series"
Names
Item Name
Property translations.labelSeries

translations.label-target-value :string

Used for the funnel chart target value.

See the translations attribute for usage examples.

Default Value:
  • "Target"
Names
Item Name
Property translations.labelTargetValue

translations.label-value :string

Used for the data item value in the tooltip.

See the translations attribute for usage examples.

Default Value:
  • "Value"
Names
Item Name
Property translations.labelValue

translations.label-volume :string

Used for the volume value in the tooltip for stock data.

See the translations attribute for usage examples.

Default Value:
  • "Volume"
Names
Item Name
Property translations.labelVolume

translations.label-x :string

Used for the x value in the tooltip

See the translations attribute for usage examples.

Default Value:
  • "X"
Names
Item Name
Property translations.labelX

translations.label-y :string

Used for the y value in the tooltip

See the translations attribute for usage examples.

Default Value:
  • "Y"
Names
Item Name
Property translations.labelY

translations.label-z :string

Used for the z value in the tooltip.

See the translations attribute for usage examples.

Default Value:
  • "Z"
Names
Item Name
Property translations.labelZ

translations.state-collapsed :string

Used to describe the collapsed state for accessibility.

See the translations attribute for usage examples.

Default Value:
  • "Collapsed"
Names
Item Name
Property translations.stateCollapsed

translations.state-drillable :string

Used to describe a drillable object for accessibility.

See the translations attribute for usage examples.

Default Value:
  • "Drillable"
Names
Item Name
Property translations.stateDrillable

translations.state-expanded :string

Used to describe the expanded state for accessibility.

See the translations attribute for usage examples.

Default Value:
  • "Expanded"
Names
Item Name
Property translations.stateExpanded

translations.state-hidden :string

Used to describe the hidden state for accessibility.

See the translations attribute for usage examples.

Default Value:
  • "Hidden"
Names
Item Name
Property translations.stateHidden

translations.state-isolated :string

Used to describe the isolated state for accessibility.

See the translations attribute for usage examples.

Default Value:
  • "Isolated"
Names
Item Name
Property translations.stateIsolated

translations.state-maximized :string

Used to describe the maximized state for accessibility.

See the translations attribute for usage examples.

Default Value:
  • "Maximized"
Names
Item Name
Property translations.stateMaximized

translations.state-minimized :string

Used to describe the minimized state for accessibility.

See the translations attribute for usage examples.

Default Value:
  • "Minimized"
Names
Item Name
Property translations.stateMinimized

translations.state-selected :string

Used to describe the selected state for accessibility.

See the translations attribute for usage examples.

Default Value:
  • "Selected"
Names
Item Name
Property translations.stateSelected

translations.state-unselected :string

Used to describe the unselected state for accessibility.

See the translations attribute for usage examples.

Default Value:
  • "Unselected"
Names
Item Name
Property translations.stateUnselected

translations.state-visible :string

Used to describe the visible state for accessibility.

See the translations attribute for usage examples.

Default Value:
  • "Visible"
Names
Item Name
Property translations.stateVisible

translations.tooltip-pan :string

Used for the pan tooltip.

See the translations attribute for usage examples.

Default Value:
  • "Pan"
Names
Item Name
Property translations.tooltipPan

translations.tooltip-select :string

Used for the marquee select tooltip.

See the translations attribute for usage examples.

Default Value:
  • "Marquee select"
Names
Item Name
Property translations.tooltipSelect

translations.tooltip-zoom :string

Used for the marquee zoom tooltip.

See the translations attribute for usage examples.

Default Value:
  • "Marquee zoom"
Names
Item Name
Property translations.tooltipZoom

type :string

The chart type.
Supported Values:
Name Type
"area" string
"bar" string
"boxPlot" string
"bubble" string
"combo" string
"funnel" string
"line" string
"lineWithArea" string
"pie" string
"pyramid" string
"scatter" string
"stock" string
Default Value:
  • "bar"
Names
Item Name
Property type
Property change event typeChanged
Property change listener attribute (must be of type function) on-type-changed

value-formats :object

An object specifying value formatting and tooltip behavior, whose keys generally correspond to the attribute names on the data items.
Default Value:
  • {}
Names
Item Name
Property valueFormats
Property change event valueFormatsChanged
Property change listener attribute (must be of type function) on-value-formats-changed

value-formats.close :object

Specifies the value formatting and tooltip behavior for the close values of a stock chart.
Default Value:
  • {}
Names
Item Name
Property valueFormats.close

value-formats.close.converter :object

The converter (an object literal or instance that duck types oj.Converter) used to format the label. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Default Value:
  • null
Names
Item Name
Property valueFormats.close.converter

value-formats.close.scaling :string

The scaling behavior of the value. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Supported Values:
Name Type
"auto" string
"billion" string
"million" string
"none" string
"quadrillion" string
"thousand" string
"trillion" string
Default Value:
  • "auto"
Names
Item Name
Property valueFormats.close.scaling

value-formats.close.tooltip-display :string

Whether the value is displayed in the tooltip.
Supported Values:
Name Type
"auto" string
"off" string
Default Value:
  • "auto"
Names
Item Name
Property valueFormats.close.tooltipDisplay

value-formats.close.tooltip-label :string

A string representing the label that is displayed before the value in the tooltip.
Default Value:
  • null
Names
Item Name
Property valueFormats.close.tooltipLabel

value-formats.group :object

Specifies tooltip behavior for the groups.
Default Value:
  • {}
Names
Item Name
Property valueFormats.group

value-formats.group.tooltip-display :string

Whether the value is displayed in the tooltip.
Supported Values:
Name Type
"auto" string
"off" string
Default Value:
  • "auto"
Names
Item Name
Property valueFormats.group.tooltipDisplay

value-formats.group.tooltip-label :string|Array.<string>

A string representing the label that is displayed before the value in the tooltip. This value can also take an array of strings to be applied to hierarchical group names, from outermost to innermost.
Default Value:
  • null
Names
Item Name
Property valueFormats.group.tooltipLabel

value-formats.high :object

Specifies the value formatting and tooltip behavior for the high values.
Default Value:
  • {}
Names
Item Name
Property valueFormats.high

value-formats.high.converter :object

The converter (an object literal or instance that duck types oj.Converter) used to format the label. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Default Value:
  • null
Names
Item Name
Property valueFormats.high.converter

value-formats.high.scaling :string

The scaling behavior of the value. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Supported Values:
Name Type
"auto" string
"billion" string
"million" string
"none" string
"quadrillion" string
"thousand" string
"trillion" string
Default Value:
  • "auto"
Names
Item Name
Property valueFormats.high.scaling

value-formats.high.tooltip-display :string

Whether the value is displayed in the tooltip.
Supported Values:
Name Type
"auto" string
"off" string
Default Value:
  • "auto"
Names
Item Name
Property valueFormats.high.tooltipDisplay

value-formats.high.tooltip-label :string

A string representing the label that is displayed before the value in the tooltip.
Default Value:
  • null
Names
Item Name
Property valueFormats.high.tooltipLabel

value-formats.label :object

Specifies the value formatting for the data item labels.
Default Value:
  • {}
Names
Item Name
Property valueFormats.label

value-formats.label.converter :object

The converter (an object literal or instance that duck types oj.Converter) used to format the label. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Default Value:
  • null
Names
Item Name
Property valueFormats.label.converter

value-formats.label.scaling :string

The scaling behavior of the value. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Supported Values:
Name Type
"auto" string
"billion" string
"million" string
"none" string
"quadrillion" string
"thousand" string
"trillion" string
Default Value:
  • "auto"
Names
Item Name
Property valueFormats.label.scaling

value-formats.low :object

Specifies the value formatting and tooltip behavior for the low values.
Default Value:
  • {}
Names
Item Name
Property valueFormats.low

value-formats.low.converter :object

The converter (an object literal or instance that duck types oj.Converter) used to format the label. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Default Value:
  • null
Names
Item Name
Property valueFormats.low.converter

value-formats.low.scaling :string

The scaling behavior of the value. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Supported Values:
Name Type
"auto" string
"billion" string
"million" string
"none" string
"quadrillion" string
"thousand" string
"trillion" string
Default Value:
  • "auto"
Names
Item Name
Property valueFormats.low.scaling

value-formats.low.tooltip-display :string

Whether the value is displayed in the tooltip.
Supported Values:
Name Type
"auto" string
"off" string
Default Value:
  • "auto"
Names
Item Name
Property valueFormats.low.tooltipDisplay

value-formats.low.tooltip-label :string

A string representing the label that is displayed before the value in the tooltip.
Default Value:
  • null
Names
Item Name
Property valueFormats.low.tooltipLabel

value-formats.open :object

Specifies the value formatting and tooltip behavior for the open values of a stock chart.
Default Value:
  • {}
Names
Item Name
Property valueFormats.open

value-formats.open.converter :object

The converter (an object literal or instance that duck types oj.Converter) used to format the label. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Default Value:
  • null
Names
Item Name
Property valueFormats.open.converter

value-formats.open.scaling :string

The scaling behavior of the value. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Supported Values:
Name Type
"auto" string
"billion" string
"million" string
"none" string
"quadrillion" string
"thousand" string
"trillion" string
Default Value:
  • "auto"
Names
Item Name
Property valueFormats.open.scaling

value-formats.open.tooltip-display :string

Whether the value is displayed in the tooltip.
Supported Values:
Name Type
"auto" string
"off" string
Default Value:
  • "auto"
Names
Item Name
Property valueFormats.open.tooltipDisplay

value-formats.open.tooltip-label :string

A string representing the label that is displayed before the value in the tooltip.
Default Value:
  • null
Names
Item Name
Property valueFormats.open.tooltipLabel

value-formats.q1 :object

Specifies the value formatting and tooltip behavior for the q1 values of a box plot.
Default Value:
  • {}
Names
Item Name
Property valueFormats.q1

value-formats.q1.converter :object

The converter (an object literal or instance that duck types oj.Converter) used to format the label. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Default Value:
  • null
Names
Item Name
Property valueFormats.q1.converter

value-formats.q1.scaling :string

The scaling behavior of the value. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Supported Values:
Name Type
"auto" string
"billion" string
"million" string
"none" string
"quadrillion" string
"thousand" string
"trillion" string
Default Value:
  • "auto"
Names
Item Name
Property valueFormats.q1.scaling

value-formats.q1.tooltip-display :string

Whether the value is displayed in the tooltip.
Supported Values:
Name Type
"auto" string
"off" string
Default Value:
  • "auto"
Names
Item Name
Property valueFormats.q1.tooltipDisplay

value-formats.q1.tooltip-label :string

A string representing the label that is displayed before the value in the tooltip.
Default Value:
  • null
Names
Item Name
Property valueFormats.q1.tooltipLabel

value-formats.q2 :object

Specifies the value formatting and tooltip behavior for the q2 values of a box plot.
Default Value:
  • {}
Names
Item Name
Property valueFormats.q2

value-formats.q2.converter :object

The converter (an object literal or instance that duck types oj.Converter) used to format the label. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Default Value:
  • null
Names
Item Name
Property valueFormats.q2.converter

value-formats.q2.scaling :string

The scaling behavior of the value. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Supported Values:
Name Type
"auto" string
"billion" string
"million" string
"none" string
"quadrillion" string
"thousand" string
"trillion" string
Default Value:
  • "auto"
Names
Item Name
Property valueFormats.q2.scaling

value-formats.q2.tooltip-display :string

Whether the value is displayed in the tooltip.
Supported Values:
Name Type
"auto" string
"off" string
Default Value:
  • "auto"
Names
Item Name
Property valueFormats.q2.tooltipDisplay

value-formats.q2.tooltip-label :string

A string representing the label that is displayed before the value in the tooltip.
Default Value:
  • null
Names
Item Name
Property valueFormats.q2.tooltipLabel

value-formats.q3 :object

Specifies the value formatting and tooltip behavior for the q3 values of a box plot.
Default Value:
  • {}
Names
Item Name
Property valueFormats.q3

value-formats.q3.converter :object

The converter (an object literal or instance that duck types oj.Converter) used to format the label. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Default Value:
  • null
Names
Item Name
Property valueFormats.q3.converter

value-formats.q3.scaling :string

The scaling behavior of the value. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Supported Values:
Name Type
"auto" string
"billion" string
"million" string
"none" string
"quadrillion" string
"thousand" string
"trillion" string
Default Value:
  • "auto"
Names
Item Name
Property valueFormats.q3.scaling

value-formats.q3.tooltip-display :string

Whether the value is displayed in the tooltip.
Supported Values:
Name Type
"auto" string
"off" string
Default Value:
  • "auto"
Names
Item Name
Property valueFormats.q3.tooltipDisplay

value-formats.q3.tooltip-label :string

A string representing the label that is displayed before the value in the tooltip.
Default Value:
  • null
Names
Item Name
Property valueFormats.q3.tooltipLabel

value-formats.series :object

Specifies tooltip behavior for the series.
Default Value:
  • {}
Names
Item Name
Property valueFormats.series

value-formats.series.tooltip-display :string

Whether the value is displayed in the tooltip.
Supported Values:
Name Type
"auto" string
"off" string
Default Value:
  • "auto"
Names
Item Name
Property valueFormats.series.tooltipDisplay

value-formats.series.tooltip-label :string

A string representing the label that is displayed before the value in the tooltip.
Default Value:
  • null
Names
Item Name
Property valueFormats.series.tooltipLabel

value-formats.target-value :object

Specifies the value formatting and tooltip behavior for the target values of a funnel chart.
Default Value:
  • {}
Names
Item Name
Property valueFormats.targetValue

value-formats.target-value.converter :object

The converter (an object literal or instance that duck types oj.Converter) used to format the label. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Default Value:
  • null
Names
Item Name
Property valueFormats.targetValue.converter

value-formats.target-value.scaling :string

The scaling behavior of the value. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Supported Values:
Name Type
"auto" string
"billion" string
"million" string
"none" string
"quadrillion" string
"thousand" string
"trillion" string
Default Value:
  • "auto"
Names
Item Name
Property valueFormats.targetValue.scaling

value-formats.target-value.tooltip-display :string

Whether the value is displayed in the tooltip.
Supported Values:
Name Type
"auto" string
"off" string
Default Value:
  • "auto"
Names
Item Name
Property valueFormats.targetValue.tooltipDisplay

value-formats.target-value.tooltip-label :string

A string representing the label that is displayed before the value in the tooltip.
Default Value:
  • null
Names
Item Name
Property valueFormats.targetValue.tooltipLabel

value-formats.value :object

Specifies the value formatting and tooltip behavior for the values.
Default Value:
  • {}
Names
Item Name
Property valueFormats.value

value-formats.value.converter :object

The converter (an object literal or instance that duck types oj.Converter) used to format the label. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Default Value:
  • null
Names
Item Name
Property valueFormats.value.converter

value-formats.value.scaling :string

The scaling behavior of the value. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Supported Values:
Name Type
"auto" string
"billion" string
"million" string
"none" string
"quadrillion" string
"thousand" string
"trillion" string
Default Value:
  • "auto"
Names
Item Name
Property valueFormats.value.scaling

value-formats.value.tooltip-display :string

Whether the value is displayed in the tooltip.
Supported Values:
Name Type
"auto" string
"off" string
Default Value:
  • "auto"
Names
Item Name
Property valueFormats.value.tooltipDisplay

value-formats.value.tooltip-label :string

A string representing the label that is displayed before the value in the tooltip.
Default Value:
  • null
Names
Item Name
Property valueFormats.value.tooltipLabel

value-formats.volume :object

Specifies the value formatting and tooltip behavior for the volume values of a stock chart.
Default Value:
  • {}
Names
Item Name
Property valueFormats.volume

value-formats.volume.converter :object

The converter (an object literal or instance that duck types oj.Converter) used to format the label. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Default Value:
  • null
Names
Item Name
Property valueFormats.volume.converter

value-formats.volume.scaling :string

The scaling behavior of the value. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Supported Values:
Name Type
"auto" string
"billion" string
"million" string
"none" string
"quadrillion" string
"thousand" string
"trillion" string
Default Value:
  • "auto"
Names
Item Name
Property valueFormats.volume.scaling

value-formats.volume.tooltip-display :string

Whether the value is displayed in the tooltip.
Supported Values:
Name Type
"auto" string
"off" string
Default Value:
  • "auto"
Names
Item Name
Property valueFormats.volume.tooltipDisplay

value-formats.volume.tooltip-label :string

A string representing the label that is displayed before the value in the tooltip.
Default Value:
  • null
Names
Item Name
Property valueFormats.volume.tooltipLabel

value-formats.x :object

Specifies the value formatting and tooltip behavior for the x values.
Default Value:
  • {}
Names
Item Name
Property valueFormats.x

value-formats.x.converter :object

The converter (an object literal or instance that duck types oj.Converter) used to format the label. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Default Value:
  • null
Names
Item Name
Property valueFormats.x.converter

value-formats.x.scaling :string

The scaling behavior of the value. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
Supported Values:
Name Type
"auto" string
"billion" string