Initializer
.ojChart()
- Source:
Examples
Initialize the Chart with no options specified:
$(".selector").ojChart();
Initialize the Chart with some options:
$(".selector").ojChart({type: 'bar'});
Initialize the Chart via the JET ojComponent
binding:
<div data-bind="ojComponent: {component: 'ojChart'}">
Options
-
animationOnDataChange :string
-
Defines the animation that is applied on data changes.
- Default Value:
"none"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 76
Supported Values:
Name Type "auto"
string "slideToLeft"
string "slideToRight"
string "none"
string -
animationOnDisplay :string
-
Defines the animation that is shown on initial display.
- Default Value:
"none"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 77
Supported Values:
Name Type "auto"
string "alphaFade"
string "zoom"
string "none"
string -
contextMenu :Object
-
JQ selector identifying the JET Menu that the 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 specified JET Menu.
To specify a JET context menu on a DOM element that is not a JET component, see the
ojContextMenu
binding.To make the page semantically accurate from the outset, applications are encouraged to specify the context menu via the standard HTML5 syntax shown in the below example. When the component is initialized, the context menu thus specified will be set on the component.
After create time, the
contextMenu
option should be set via this API, not by setting the DOM attribute.- Default Value:
null
- Inherited From:
- Source:
Examples
Initialize a JET component with a context menu:
// via recommended HTML5 syntax: <div id="myComponent" contextmenu="myMenu" data-bind="ojComponent: { ... }> // via JET initializer (less preferred) : // Foo is the component, e.g., InputText, InputNumber, Select, etc. $( ".selector" ).ojFoo({ "contextMenu": "#myMenu" });
Get or set the
contextMenu
option, after initialization:// getter // Foo is the component, e.g., Menu, Button, InputText, InputNumber, Select, etc. var menu = $( ".selector" ).ojFoo( "option", "contextMenu" ); // setter // Foo is the component, e.g., InputText, InputNumber, Select, etc. $( ".selector" ).ojFoo( "option", "contextMenu", ".my-marker-class" );
Set a JET context menu on an ordinary HTML element:
<a href="#" id="myAnchor" contextmenu="myMenu" data-bind="ojContextMenu: {}">Some text
-
coordinateSystem :string
-
The coordinate system of the chart. Only applies to bar, line, area, combo, scatter, and bubble charts.
- Default Value:
"cartesian"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 70
Supported Values:
Name Type "polar"
string "cartesian"
string -
dataCursor :string
-
Defines whether the data cursor is enabled. Not supported for polar charts. If set to "on", the cursor will be rendered even if the tooltip is empty.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 78
Supported Values:
Name Type "on"
string "off"
string "auto"
string -
dataCursorBehavior :string
-
Defines the behavior of the data cursor when moving between data items.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 79
Supported Values:
Name Type "smooth"
string "snap"
string "auto"
string -
dataCursorPosition :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
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 80
-
dataCursorPosition.x :number|Date
-
The x value of the data cursor.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 81
-
dataCursorPosition.y :number
-
The y value of the data cursor. If both y and y2 are defined, y will take precedence.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 82
-
dataCursorPosition.y2 :number
-
The y2 value of the data cursor. If both y and y2 are defined, y will take precedence.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 83
-
dragMode :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.
- Default Value:
"user"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 65
Supported Values:
Name Type "pan"
string "zoom"
string "select"
string "off"
string "user"
string -
drilling :string
-
Whether drilling is enabled. Drillable objects will show a pointer cursor on hover and fire a drill 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.
- Default Value:
"off"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 375
Supported Values:
Name Type "on"
string "seriesOnly"
string "groupsOnly"
string "off"
string -
footnote :object
-
An object defining the style and positioning of the chart footnote.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 93
-
footnote.halign :string
-
The horizontal alignment of the text. If the value is plotAreaStart, plotAreaCenter, or plotAreaEnd, the text is aligned relative to the plot area instead of the entire chart container.
- Default Value:
"start"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 96
Supported Values:
Name Type "center"
string "end"
string "plotAreaStart"
string "plotAreaCenter"
string "plotAreaEnd"
string "start"
string -
footnote.style :string
-
The CSS style string defining the style of the text.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 95
-
footnote.text :string
-
The text for the footnote.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 94
-
groups :Array.<Object>|Array.<string>
-
An array of strings identifying the group labels, or an array of objects with the following properties.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 50
-
groups[].drilling :string
-
Whether drilling is enabled on the group label. Drillable objects will show a pointer cursor on hover and fire a drill event on click. To enable drilling for all group labels at once, use the drilling attribute in the top level.
- Default Value:
"inherit"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 55
Supported Values:
Name Type "on"
string "off"
string "inherit"
string -
groups[].groups :Array.<string>|Array.<Object>
-
An array of nested group objects.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 56
-
groups[].id :string
-
The id of the group. Defaults to the name if not specified.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 52
-
groups[].labelStyle :string
-
The CSS style string defining the style of the group label text and only applies to a categorical axis.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 53
-
groups[].name :string
-
The name of the group.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 51
-
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
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 54
-
hiddenCategories :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:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 72
-
hideAndShowBehavior :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.
- Default Value:
"none"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 71
Supported Values:
Name Type "withRescale"
string "withoutRescale"
string "none"
string -
highlightedCategories :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:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 74
-
highlightMatch :string
-
The matching condition for the highlightedCategories option. 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.
- Default Value:
"all"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 75
Supported Values:
Name Type "any"
string "all"
string -
hoverBehavior :string
-
Defines the behavior applied when hovering over data items.
- Default Value:
"none"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 73
Supported Values:
Name Type "dim"
string "none"
string -
initialZooming :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.
- Default Value:
"none"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 374
Supported Values:
Name Type "first"
string "last"
string "none"
string -
legend :object
-
An object defining the style, positioning, and behavior of the legend.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 291
-
legend.backgroundColor :string
-
The color of the legend background.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 306
-
legend.borderColor :string
-
The border color of the legend.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 307
-
legend.maxSize :string
-
Defines the maximum size of the legend in pixels (e.g. '50px') or percent (e.g. '15%').
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 305
-
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.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 302
Supported Values:
Name Type "start"
string "end"
string "bottom"
string "top"
string "auto"
string -
legend.referenceObjectSection :object
-
An object with the following properties for the reference object section in the legend.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 297
-
legend.referenceObjectSection.title :string
-
The title of the reference object section.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 298
-
legend.referenceObjectSection.titleHalign :string
-
The horizontal alignment of the section title. If the section is collapsible or nested, only start alignment is supported.
- Default Value:
"start"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 299
Supported Values:
Name Type "center"
string "end"
string "start"
string -
legend.referenceObjectSection.titleStyle :string
-
The CSS style string defining the style of the section title.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 300
-
legend.referenceObjectTitle :string
-
The section title for the reference objects, if present.
- Default Value:
null
- Deprecated:
- Use referenceObjectSection.title instead
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 301
-
legend.rendered :string
-
Defines whether the legend is displayed.
- Default Value:
"on"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 303
Supported Values:
Name Type "off"
string "on"
string -
legend.scrolling :string
-
Defines whether scrolling is enabled for the legend.
- Default Value:
"asNeeded"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 313
Supported Values:
Name Type "off"
string "asNeeded"
string -
legend.seriesSection :object
-
An object with the following properties for the series section in the legend.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 293
-
legend.seriesSection.title :string
-
The title of the series section.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 294
-
legend.seriesSection.titleHalign :string
-
The horizontal alignment of the section title. If the section is collapsible or nested, only start alignment is supported.
- Default Value:
"start"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 295
Supported Values:
Name Type "center"
string "end"
string "start"
string -
legend.seriesSection.titleStyle :string
-
The CSS style string defining the style of the section title.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 296
-
legend.size :string
-
Defines the size of the legend in pixels (e.g. '50px') or percent (e.g. '15%').
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 304
-
legend.symbolHeight :number
-
The height of the legend symbol (line or marker) in pixels.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 310
-
legend.symbolWidth :number
-
The width of the legend symbol (line or marker) in pixels.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 309
-
legend.textStyle :string
-
The CSS style string defining the style of the legend text.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 308
-
legend.title :string
-
The legend title.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 292
-
legend.titleHalign :string
-
The horizontal alignment of the title.
- Default Value:
"start"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 311
Supported Values:
Name Type "center"
string "end"
string "start"
string -
legend.titleStyle :string
-
The CSS style string defining the style of the title.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 312
-
orientation :string
-
The chart orientation. Only applies to bar, line, area, combo, and funnel charts.
- Default Value:
"vertical"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 68
Supported Values:
Name Type "horizontal"
string "vertical"
string -
otherThreshold :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
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 85
-
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:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 285
-
overview.height :string
-
Specifies the height of the overview scrollbar in pixels (e.g. '50px') or percent (e.g. '15%').
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 287
-
overview.rendered :string
-
Specifies whether the overview scrollbar is rendered. If not, simple scrollbar will be used.
- Default Value:
"off"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 286
Supported Values:
Name Type "on"
string "off"
string -
pieCenterLabel :object
-
An object defining the style and text for the label to be displayed at the center of the pie chart. 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
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 97
-
pieCenterLabel.style :string
-
The CSS style string defining the style of the label.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 99
-
pieCenterLabel.text :string
-
Specifies the text for the label.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 98
-
plotArea :object
-
An object defining the style of the plot area.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 288
-
plotArea.backgroundColor :string
-
The color of the plot area background.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 289
-
plotArea.rendered :string
-
Specifies whether the plot area is rendered.
- Default Value:
"on"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 290
Supported Values:
Name Type "off"
string "on"
string -
polarGridShape :string
-
Defines whether the grid shape of the polar chart is circle or polygon. Only applies to polar line and area charts.
- Default Value:
"circle"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 69
Supported Values:
Name Type "polygon"
string "circle"
string -
rootAttributes :Object
-
Attributes specified here will be set on the component's root DOM element at creation time. This is particularly useful for components like Dialog that wrap themselves in a new root element at creation time.
The supported attributes are
id
, which overwrites any existing value, andclass
andstyle
, which are appended to the current class and style, if any.Setting this option after component creation has no effect. At that time, the root element already exists, and can be accessed directly via the
widget
method, per the second example below.- Default Value:
null
- Inherited From:
- Source:
Examples
Initialize a JET component, specifying a set of attributes to be set on the component's root DOM element:
// Foo is the component, e.g., Menu, Button, InputText, InputNumber, Select, etc. $( ".selector" ).ojFoo({ "rootAttributes": { "id": "myId", "style": "max-width:100%; color:blue;", "class": "my-class" }});
After initialization,
rootAttributes
should not be used. It is not needed at that time, as attributes of the root DOM element can simply be set directly, usingwidget
:// Foo is the component, e.g., Menu, Button, InputText, InputNumber, Select, etc. $( ".selector" ).ojFoo( "widget" ).css( "height", "100px" ); $( ".selector" ).ojFoo( "widget" ).addClass( "my-class" );
-
selection :Array.<string>|Array.<Object>
-
An array used to define the initially selected objects. Could include strings identifying the selected item ids or an array of objects with the following properties.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 57
-
selection[].group :string
-
The group id. This is a required field unless the data item id is specified.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 59
-
selection[].id :string
-
The data item id. This is a required field unless both the series and group ids are specified.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 60
-
selection[].series :string
-
The series id. This is a required field unless the data item id is specified.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 58
-
selectionMode :string
-
The type of selection behavior that is enabled on the chart.
- Default Value:
"none"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 64
Supported Values:
Name Type "single"
string "multiple"
string "none"
string -
series :Array.<Object>
-
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.
- Default Value:
null
- Source:
-
series[].areaColor :string
-
The area color of the series. Only applies if series type is area or lineWithArea.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 33
-
series[].assignedToY2 :string
-
Defines whether the series is associated with the y2 axis. Only applies to Cartesian bar, line, area, and combo charts.
- Default Value:
"off"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 43
Supported Values:
Name Type "on"
string "off"
string -
series[].borderColor :string
-
The border color of the series.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 31
-
series[].borderWidth :number
-
The border width of the series.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 32
-
series[].categories :Array.<string>
-
An optional array of additional category strings corresponding to this series. This allows highlighting and filtering of a series through interactions with legend sections.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 48
-
series[].color :string
-
The color of the series.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 30
-
series[].displayInLegend :string
-
Defines whether the series should be shown in the legend. When set to 'auto', the series will be displayed in the legend if it has any non-null data.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 46
Supported Values:
Name Type "on"
string "off"
string "auto"
string -
series[].drilling :string
-
Whether drilling is enabled on the series item. Drillable objects will show a pointer cursor on hover and fire a drill event on click. To enable drilling for all series items at once, use the drilling attribute in the top level.
- Default Value:
"inherit"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 47
Supported Values:
Name Type "on"
string "off"
string "inherit"
string -
series[].id :string
-
The id of the series. Defaults to the name or the series index if not specified.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 28
-
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
- Source:
-
series[].items[].borderColor :string
-
The border color of the data item. For funnel charts, it is used for the slice border.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 15
-
series[].items[].borderWidth :number
-
The border width of the data item. For funnel charts, it is used for the slice border.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 16
-
series[].items[].categories :Array.<string>
-
An optional array of additional category strings corresponding to this data item. This enables highlighting and filtering of individual data items through interactions with the legend or other components.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 24
-
series[].items[].close :number
-
The close value for a stock chart data item. When bar, line, or area series are used on a stock chart, this value is displayed.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 11
-
series[].items[].color :string
-
The color of the data item.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 14
-
series[].items[].drilling :string
-
Whether drilling is enabled for the data item. Drillable objects will show a pointer cursor on hover and fire a drill 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.
- Default Value:
"inherit"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 27
Supported Values:
Name Type "on"
string "off"
string "inherit"
string -
series[].items[].high :number
-
The high value for range bar/area as well as candlestick series. Define 'low' and 'high' instead of 'value' or 'y' to create a range bar/area chart.
- Default Value:
null
- Source:
-
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
- Source:
-
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.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 21
-
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 '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.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 22
Supported Values:
Name Type "center"
string "aboveMarker"
string "belowMarker"
string "beforeMarker"
string "afterMarker"
string "insideBarEdge"
string "outsideBarEdge"
string "none"
string "auto"
string -
series[].items[].labelStyle :string|Array.<string>
-
The CSS style string 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
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 23
-
series[].items[].low :number
-
The low value for range bar/area as well as candlestick series. Define 'low' and 'high' instead of 'value' or 'y' to create a range bar/area chart.
- Default Value:
null
- Source:
-
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.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 18
Supported Values:
Name Type "on"
string "off"
string "auto"
string -
series[].items[].markerShape :string
-
The shape of the data markers. Only 'auto' is supported for range series.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 19
Supported Values:
Name Type "square"
string "circle"
string "diamond"
string "plus"
string "triangleDown"
string "triangleUp"
string "human"
string "star"
string "auto"
string -
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
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 20
-
series[].items[].open :number
-
The open value for a stock chart data item.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 10
-
series[].items[].pattern :string
-
The pattern used to fill the data item. A solid fill is used by default, unless the seriesEffect is 'pattern'.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 17
Supported Values:
Name Type "smallChecker"
string "smallCrosshatch"
string "smallDiagonalLeft"
string "smallDiagonalRight"
string "smallDiamond"
string "smallTriangle"
string "largeChecker"
string "largeCrosshatch"
string "largeDiagonalLeft"
string "largeDiagonalRight"
string "largeDiamond"
string "largeTriangle"
string "auto"
string -
series[].items[].shortDesc :string
-
The description of this object. This is used for accessibility and also for customizing the tooltip text.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 13
-
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
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 26
-
series[].items[].value :number
-
The value for this data item. Corresponding to the y value for bar/line/area/combo charts and the slice values for pie and funnel charts.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 25
-
series[].items[].volume :number
-
The volume value for a stock chart data item. When values are provided, the volume is displayed on the y2 axis.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 12
-
series[].items[].x :number|Date
-
The x value for a scatter or bubble chart or the date on a time axis.
- Default Value:
null
- Source:
-
series[].items[].y :number
-
The y value. Also the primary value for charts without a y-Axis, such as pie charts.
- Default Value:
null
- Source:
-
series[].items[].z :number
-
The z value. Defines the bubble radius for a bubble chart, and the bar width for a bar or combo chart.
- Default Value:
null
- Source:
-
series[].lineStyle :string
-
The line style of the data line. Only applies to line, lineWithArea, scatter, and bubble series.
- Default Value:
"solid"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 40
Supported Values:
Name Type "dotted"
string "dashed"
string "solid"
string -
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.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 41
Supported Values:
Name Type "straight"
string "curved"
string "stepped"
string "centeredStepped"
string "segmented"
string "centeredSegmented"
string "none"
string "auto"
string -
series[].lineWidth :number
-
The width of the data line. Only applies to line, lineWithArea, scatter, and bubble series.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 39
-
series[].markerColor :string
-
The color of the data markers, if different from the series color.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 36
-
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.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 37
Supported Values:
Name Type "on"
string "off"
string "auto"
string -
series[].markerShape :string
-
The shape of the data markers. Only 'auto' is supported for range series.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 35
Supported Values:
Name Type "square"
string "circle"
string "diamond"
string "plus"
string "triangleDown"
string "triangleUp"
string "human"
string "star"
string "auto"
string -
series[].markerSize :number
-
The size of the data markers.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 38
-
series[].name :string
-
The name of the series, displayed in the legend and tooltips.
- Default Value:
null
- Source:
-
series[].pattern :string
-
The pattern used to fill the series. A solid fill is used by default, unless the seriesEffect is 'pattern'.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 34
Supported Values:
Name Type "smallChecker"
string "smallCrosshatch"
string "smallDiagonalLeft"
string "smallDiagonalRight"
string "smallDiamond"
string "smallTriangle"
string "largeChecker"
string "largeCrosshatch"
string "largeDiagonalLeft"
string "largeDiagonalRight"
string "largeDiamond"
string "largeTriangle"
string "auto"
string -
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
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 42
-
series[].shortDesc :string
-
The description of this object. This is used for accessibility and for customizing the tooltip text on the corressponding legend item for the series.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 49
-
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
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 44
-
series[].type :string
-
The type of data objects to display for this series. Only applies to bar, line, area, stock, and combo charts.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 29
Supported Values:
Name Type "bar"
string "line"
string "area"
string "lineWithArea"
string "candlestick"
string "auto"
string -
series[].visibility :string
-
Defines whether the series should be displayed.
- Default Value:
"visible"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 45
Supported Values:
Name Type "hidden"
string "visible"
string -
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.
- Default Value:
"off"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 84
Supported Values:
Name Type "ascending"
string "descending"
string "off"
string -
splitDualY :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".
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 61
Supported Values:
Name Type "on"
string "off"
string "auto"
string -
splitterPosition :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:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 62
-
stack :string
-
Defines whether the data items are stacked. Only applies to bar, line, area, and combo charts. Does not apply to range series.
- Default Value:
"off"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 67
Supported Values:
Name Type "on"
string "off"
string -
styleDefaults :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:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 314
-
styleDefaults.animationDownColor :string
-
The color of the indicator shown for a decreasing data change animation.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 331
-
styleDefaults.animationDuration :number
-
The duration of the animations, in milliseconds. Also accepts CSS strings such as 1s and 1000ms.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 328
-
styleDefaults.animationIndicators :string
-
Defines whether data change indicators are displayed during animation.
- Default Value:
"all"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 329
Supported Values:
Name Type "none"
string "all"
string -
styleDefaults.animationUpColor :string
-
The color of the indicator shown for an increasing data change animation.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 330
-
styleDefaults.backgroundColor :string
-
The default background color of the data items. Currently applies only for funnel charts with actual/target values.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 322
-
styleDefaults.barGapRatio :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
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 352
-
styleDefaults.borderColor :string
-
The default border color for the data items. For funnel charts, it is used for the slice border.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 320
-
styleDefaults.borderWidth :number
-
The default border width for the data items. For funnel charts, it is used for the slice border.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 321
-
styleDefaults.colors :Array.<string>
-
The array defining the default color ramp for the series.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 316
-
styleDefaults.dataCursor :object
-
An object defining the data cursor style.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 357
-
styleDefaults.dataCursor.groupSeparators :object
-
An object defining the style for hierarchical label separators.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 364
-
styleDefaults.dataCursor.groupSeparators.color :string
-
The color of the separators lines.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 366
-
styleDefaults.dataCursor.groupSeparators.rendered :string
-
Defines whether the group separators are displayed.
- Default Value:
"on"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 365
Supported Values:
Name Type "off"
string "on"
string -
styleDefaults.dataCursor.lineColor :string
-
The color of the data cursor line.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 359
-
styleDefaults.dataCursor.lineStyle :string
-
The line style of the data cursor line.
- Default Value:
"solid"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 360
Supported Values:
Name Type "dotted"
string "dashed"
string "solid"
string -
styleDefaults.dataCursor.lineWidth :number
-
The width of the data cursor line in pixels.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 358
-
styleDefaults.dataCursor.markerColor :string
-
The color of the data cursor marker. Defaults to the data series color.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 361
-
styleDefaults.dataCursor.markerDisplayed :string
-
Whether the data cursor marker is displayed. Marker should only be hidden if the data cursor is displaying information for the entire group.
- Default Value:
"on"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 363
Supported Values:
Name Type "off"
string "on"
string -
styleDefaults.dataCursor.markerSize :number
-
The size of the data cursor marker in pixels.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 362
-
styleDefaults.dataItemGaps :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
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 345
-
styleDefaults.dataLabelPosition :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 '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.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 350
Supported Values:
Name Type "center"
string "aboveMarker"
string "belowMarker"
string "beforeMarker"
string "afterMarker"
string "insideBarEdge"
string "outsideBarEdge"
string "none"
string "auto"
string -
styleDefaults.dataLabelStyle :string|Array.<string>
-
The CSS style string 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
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 351
-
styleDefaults.groupTooltipType :string
-
Defines whether the group information is displayed in the tooltips.
- Default Value:
"auto"
- Deprecated:
- Use valueFormats[i].tooltipDisplay instead.
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 325
Supported Values:
Name Type "none"
string "auto"
string -
styleDefaults.hoverBehaviorDelay :number|string
-
Specifies initial hover delay in ms for highlighting items in chart. Also accepts CSS strings such as 1s and 1000ms.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 354
-
styleDefaults.lineStyle :string
-
The line style of the data line. Only applies to line, lineWithArea, scatter, and bubble series.
- Default Value:
"solid"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 337
Supported Values:
Name Type "dotted"
string "dashed"
string "solid"
string -
styleDefaults.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.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 336
Supported Values:
Name Type "straight"
string "curved"
string "stepped"
string "centeredStepped"
string "segmented"
string "centeredSegmented"
string "none"
string "auto"
string -
styleDefaults.lineWidth :number
-
The width of the data line. Only applies to line, lineWithArea, scatter, and bubble series.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 335
-
styleDefaults.markerColor :string
-
The color of the data markers, if different from the series color.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 338
-
styleDefaults.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.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 339
Supported Values:
Name Type "on"
string "off"
string "auto"
string -
styleDefaults.markerShape :string
-
The shape of the data markers. Only 'auto' is supported for range series.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 340
Supported Values:
Name Type "square"
string "circle"
string "diamond"
string "plus"
string "triangleDown"
string "triangleUp"
string "human"
string "star"
string "auto"
string -
styleDefaults.markerSize :number
-
The size of the data markers in pixels.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 341
-
styleDefaults.marqueeBorderColor :string
-
The border color of the marquee. Applies to marquee selection and marquee zoom.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 333
-
styleDefaults.marqueeColor :string
-
The fill color of the marquee. Applies to marquee selection and marquee zoom.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 332
-
styleDefaults.maxBarWidth :number
-
Specifies the maximum width of each bar in pixels.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 353
-
styleDefaults.otherColor :string
-
Specifies the color of the "Other" slice. Only applies to pie chart.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 318
-
styleDefaults.patterns :Array.<string>
-
The array defining the default pattern ramp for the series. This is used only when seriesEffect is 'pattern'.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 317
-
styleDefaults.pieFeelerColor :string
-
The color of the line extending from the pie slice to the slice label.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 342
-
styleDefaults.pieInnerRadius :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
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 334
-
styleDefaults.selectionEffect :string
-
The selection effect that is applied to selected items. The values explode and highlightAndExplode only apply to pie charts.
- Default Value:
"highlight"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 324
Supported Values:
Name Type "explode"
string "highlightAndExplode"
string "highlight"
string -
styleDefaults.seriesEffect :string
-
Defines the fill effect for the data items.
- Default Value:
"gradient"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 315
Supported Values:
Name Type "color"
string "pattern"
string "gradient"
string -
styleDefaults.seriesTooltipType :string
-
Defines whether the series information is displayed in the tooltips.
- Default Value:
"auto"
- Deprecated:
- Use valueFormats[i].tooltipDisplay instead.
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 326
Supported Values:
Name Type "none"
string "auto"
string -
styleDefaults.shapes :Array.<string>
-
The array defining the default shape ramp for the series. Valid values are defined in the markerShape attribute.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 319
-
styleDefaults.sliceLabelPosition :string
-
The position of the pie slice labels.
- Default Value:
"auto"
- Deprecated:
- Use 'dataLabelPosition' instead
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 343
Supported Values:
Name Type "outside"
string "inside"
string "none"
string "auto"
string -
styleDefaults.sliceLabelStyle :string
-
The CSS style string defining the style of the pie slice labels.
- Default Value:
null
- Deprecated:
- Use 'dataLabelStyle' instead
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 344
-
styleDefaults.stockFallingColor :string
-
In stock charts, the color of the candlestick when the 'open' value is greater than the 'close' value.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 347
-
styleDefaults.stockRangeColor :string
-
In stock charts, the color of the range bars for candlestick.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 348
-
styleDefaults.stockRisingColor :string
-
In stock charts, the color of the candlestick when the 'close' value is greater than the 'open' value.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 346
-
styleDefaults.stockVolumeColor :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
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 349
-
styleDefaults.threeDEffect :string
-
Defines whether the chart is displayed with a 3D effect. Only applies to pie and funnel charts.
- Default Value:
"off"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 323
Supported Values:
Name Type "on"
string "off"
string -
styleDefaults.tooltipLabelStyle :string
-
The CSS style string defining the style of the labels in the tooltip.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 355
-
styleDefaults.tooltipValueStyle :string
-
The CSS style string defining the style of the values in the tooltip.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 356
-
styleDefaults.valueTooltipType :string
-
Defines whether the value information is displayed in the tooltips.
- Default Value:
"auto"
- Deprecated:
- Use valueFormats[i].tooltipDisplay instead.
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 327
Supported Values:
Name Type "none"
string "auto"
string -
subtitle :object
-
An object defining the style and positioning of the chart subtitle.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 90
-
subtitle.style :string
-
The CSS style string defining the style of the text.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 92
-
subtitle.text :string
-
The text for the subtitle.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 91
-
timeAxisType :string
-
The type of time axis to display in the chart. Time axis is only supported for Cartesian bar, line, area, stock, 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.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 63
Supported Values:
Name Type "enabled"
string "mixedFrequency"
string "skipGaps"
string "disabled"
string "auto"
string -
title :object
-
An object defining the style and positioning of the chart title.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 86
-
title.halign :string
-
The horizontal alignment of the text. If the value is plotAreaStart, plotAreaCenter, or plotAreaEnd, the text is aligned relative to the plot area instead of the entire chart container.
- Default Value:
"start"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 89
Supported Values:
Name Type "center"
string "end"
string "plotAreaStart"
string "plotAreaCenter"
string "plotAreaEnd"
string "start"
string -
title.style :string
-
The CSS style string defining the style of the text.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 88
-
title.text :string
-
The text for the title.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 87
-
tooltip :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. The function can directly modify or append content to this element.
- id: The id of the hovered item.
- series: The series name of the hovered item.
- group: The group name of the hovered item.
- value, targetValue, x, y, z, low, high, open, close, volume: The values of the hovered item.
- label: The data label of the hovered item.
- color: The color of the hovered item.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 376
-
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 (or inherits) translations, their documentation immediately follows this doc entry.
- Default Value:
- an object containing all resources relevant to the component and all its superclasses, or
null
if none
- an object containing all resources relevant to the component and all its superclasses, or
- Inherited From:
- Source:
Examples
Initialize the component, overriding some translated resources. This syntax leaves the other translations intact at create time, but not if called after create time:
// Foo is InputDate, InputNumber, etc. $( ".selector" ).ojFoo({ "translations": { someKey: "someValue", someOtherKey: "someOtherValue" } });
Get or set the
translations
option, after initialization:// Get one. (Foo is InputDate, InputNumber, etc.) var value = $( ".selector" ).ojFoo( "option", "translations.someResourceKey" ); // Get all. (Foo is InputDate, InputNumber, etc.) var values = $( ".selector" ).ojFoo( "option", "translations" ); // Set one, leaving the others intact. (Foo is InputDate, InputNumber, etc.) $( ".selector" ).ojFoo( "option", "translations.someResourceKey", "someValue" ); // Set many. Any existing resource keys not listed are lost. (Foo is InputDate, InputNumber, etc.) $( ".selector" ).ojFoo( "option", "translations", { someKey: "someValue", someOtherKey: "someOtherValue" } );
-
translations.componentName :string
-
Used to describe the data visualization type for accessibility.
See the translations option for usage examples.
- Default Value:
"Chart"
- Source:
-
translations.labelAndValue :string
-
Used to display a label and its value.
See the translations option for usage examples.
- Default Value:
"{0}: {1}"
- Inherited From:
- Source:
-
translations.labelClearSelection :string
-
Text shown for clearing multiple selection on touch devices.
See the translations option for usage examples.
- Default Value:
"Clear Selection"
- Inherited From:
- Source:
-
translations.labelClose :string
-
Used for the close value in the tooltip for stock data.
See the translations option for usage examples.
- Default Value:
"Close"
- Source:
-
translations.labelDataVisualization :string
-
Label for data visualizations used for accessibility.
See the translations option for usage examples.
- Default Value:
"Data Visualization"
- Inherited From:
- Source:
-
translations.labelDate :string
-
Used for the date value in the tooltip, if a time axis is being used.
See the translations option for usage examples.
- Default Value:
"Value"
- Source:
-
translations.labelDefaultGroupName :string
-
Used when the group names are not specified.
See the translations option for usage examples.
- Default Value:
"Group {0}"
- Source:
-
translations.labelGroup :string
-
Used for the default tooltip.
See the translations option for usage examples.
- Default Value:
"Group"
- Source:
-
translations.labelHigh :string
-
>Used for the high value in the tooltip for stock and range data.
See the translations option for usage examples.
- Default Value:
"High"
- Source:
-
translations.labelInvalidData :string
-
Text shown when the component receives invalid data.
See the translations option for usage examples.
- Default Value:
"Invalid data"
- Inherited From:
- Source:
-
translations.labelLow :string
-
Used for the low value in the tooltip for stock and range data.
See the translations option for usage examples.
- Default Value:
"Low"
- Source:
-
translations.labelNoData :string
-
Text shown when the component receives no data.
See the translations option for usage examples.
- Default Value:
"No data to display"
- Inherited From:
- Source:
-
translations.labelOpen :string
-
Used for the open value in the tooltip for stock data.
See the translations option for usage examples.
- Default Value:
"Open"
- Source:
-
translations.labelOther :string
-
Used for the other series label which aggregates small data values.
See the translations option for usage examples.
- Default Value:
"Other"
- Source:
-
translations.labelPercentage :string
-
Used for displaying the percentage in the tooltip.
See the translations option for usage examples.
- Default Value:
"Percentage"
- Source:
-
translations.labelSeries :string
-
Used for the default tooltip.
See the translations option for usage examples.
- Default Value:
"Series"
- Source:
-
translations.labelTargetValue :string
-
Used for the funnel chart target value.
See the translations option for usage examples.
- Default Value:
"Target"
- Source:
-
translations.labelValue :string
-
Used for the data item value in the tooltip.
See the translations option for usage examples.
- Default Value:
"Value"
- Source:
-
translations.labelVolume :string
-
Used for the volume value in the tooltip for stock data.
See the translations option for usage examples.
- Default Value:
"Volume"
- Source:
-
translations.labelX :string
-
Used for the x value in the tooltip
See the translations option for usage examples.
- Default Value:
"X"
- Source:
-
translations.labelY :string
-
Used for the y value in the tooltip
See the translations option for usage examples.
- Default Value:
"Y"
- Source:
-
translations.labelZ :string
-
Used for the z value in the tooltip.
See the translations option for usage examples.
- Default Value:
"Z"
- Source:
-
translations.messageNotReadyToRender :object
-
Provides properties to customize the summary text used for the not ready to render error message.
See the translations option for usage examples.
- Inherited From:
- Source:
-
translations.messageNotReadyToRender.summary :string
-
Summary text for the not ready to render error message.
See the translations option for usage examples.
- Default Value:
"This component must be attached to a visible subtree of the DOM prior to rendering."
- Inherited From:
- Source:
-
translations.stateCollapsed :string
-
Used to describe the collapsed state for accessibility.
See the translations option for usage examples.
- Default Value:
"Collapsed"
- Inherited From:
- Source:
-
translations.stateExpanded :string
-
Used to describe the expanded state for accessibility.
See the translations option for usage examples.
- Default Value:
"Expanded"
- Inherited From:
- Source:
-
translations.stateHidden :string
-
Used to describe the hidden state for accessibility.
See the translations option for usage examples.
- Default Value:
"Hidden"
- Inherited From:
- Source:
-
translations.stateIsolated :string
-
Used to describe the isolated state for accessibility.
See the translations option for usage examples.
- Default Value:
"Isolated"
- Inherited From:
- Source:
-
translations.stateMaximized :string
-
Used to describe the maximized state for accessibility.
See the translations option for usage examples.
- Default Value:
"Maximized"
- Inherited From:
- Source:
-
translations.stateMinimized :string
-
Used to describe the minimized state for accessibility.
See the translations option for usage examples.
- Default Value:
"Minimized"
- Inherited From:
- Source:
-
translations.stateSelected :string
-
Used to describe the selected state for accessibility.
See the translations option for usage examples.
- Default Value:
"Selected"
- Inherited From:
- Source:
-
translations.stateUnselected :string
-
Used to describe the unselected state for accessibility.
See the translations option for usage examples.
- Default Value:
"Unselected"
- Inherited From:
- Source:
-
translations.stateVisible :string
-
Used to describe the visible state for accessibility.
See the translations option for usage examples.
- Default Value:
"Visible"
- Inherited From:
- Source:
-
translations.tooltipPan :string
-
Used for the pan tooltip.
See the translations option for usage examples.
- Default Value:
"Pan"
- Source:
-
translations.tooltipSelect :string
-
Used for the marquee select tooltip.
See the translations option for usage examples.
- Default Value:
"Marquee select"
- Source:
-
translations.tooltipZoom :string
-
Used for the marquee zoom tooltip.
See the translations option for usage examples.
- Default Value:
"Marquee zoom"
- Source:
-
type :string
-
The chart type.
- Default Value:
"bar"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 66
Supported Values:
Name Type "line"
string "area"
string "lineWithArea"
string "combo"
string "pie"
string "scatter"
string "stock"
string "bubble"
string "funnel"
string "bar"
string -
valueFormats :Array.<Object>
-
An array of objects containing the chart value formats.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 367
-
valueFormats[].converter :object
-
The 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
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 369
-
valueFormats[].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.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 370
Supported Values:
Name Type "none"
string "thousand"
string "million"
string "billion"
string "trillion"
string "quadrillion"
string "auto"
string -
valueFormats[].tooltipDisplay :string
-
Whether the value is displayed in the tooltip.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 372
Supported Values:
Name Type "off"
string "auto"
string -
valueFormats[].tooltipLabel :string|Array.<string>
-
A string representing the label that is displayed before the value in the tooltip. When type 'group' is used, this value can also take an array of strings to be applied to hierarchical group names, from outermost to innermost.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 371
-
valueFormats[].type :string
-
Identifies which value the valueFormat applies to. For pie charts, value formats of type 'label' will only apply to custom labels set by the user.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 368
Supported Values:
Name Type "series"
string "group"
string "x"
string "y"
string "y2"
string "z"
string "value"
string "targetValue"
string "low"
string "high"
string "open"
string "close"
string "volume"
string "label"
string -
xAxis :object
-
An object defining properties for the axis, tick marks, tick labels, and axis titles.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 100
-
xAxis.axisLine :object
-
An object defining properties for the axis line.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 136
-
xAxis.axisLine.lineColor :string
-
The color of the axis line.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 137
-
xAxis.axisLine.lineWidth :number
-
The width of the axis line.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 138
-
xAxis.axisLine.rendered :string
-
Defines whether the axis line is rendered.
- Default Value:
"on"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 139
Supported Values:
Name Type "off"
string "on"
string -
xAxis.baselineScaling :string
-
Defines whether the axis baseline starts at the minimum value of the data or at zero. Only applies to numerical data axes.
- Default Value:
"zero"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 153
Supported Values:
Name Type "min"
string "zero"
string -
xAxis.dataMax :number
-
The maximum data value corresponding to an axis. If specified, the automatic axis extent calculation will use this value. Only applies to numerical axes.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 124
-
xAxis.dataMin :number
-
The minimum data value corresponding to an axis. If specified, the automatic axis extent calculation will use this value. Only applies to numerical axes.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 123
-
xAxis.majorTick :object
-
An object defining properties for the major tick marks.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 140
-
xAxis.majorTick.baselineColor :string
-
The color of the major tick mark at the baseline (x = 0). Valid values are auto, inherit, or a custom color. If set to inherit, it will follow the lineColor attribute.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 144
Supported Values:
Name Type "inherit"
string "auto"
string -
xAxis.majorTick.baselineStyle :string
-
The line style of the major tick mark at the baseline (x = 0). If not specified, it will follow the lineStyle attribute.
- Default Value:
"solid"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 145
Supported Values:
Name Type "dotted"
string "dashed"
string "solid"
string -
xAxis.majorTick.baselineWidth :number
-
The width of the major tick mark at the baseline (x = 0) If not specified, it will follow the lineWidth attribute.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 146
-
xAxis.majorTick.lineColor :string
-
The color of the major tick marks.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 141
-
xAxis.majorTick.lineStyle :string
-
The line style of the major tick marks.
- Default Value:
"solid"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 142
Supported Values:
Name Type "dotted"
string "dashed"
string "solid"
string -
xAxis.majorTick.lineWidth :number
-
The width of the major tick marks.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 143
-
xAxis.majorTick.rendered :string
-
Defines whether the major tick marks are rendered.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 147
Supported Values:
Name Type "on"
string "off"
string "auto"
string -
xAxis.max :number
-
The maximum value of the axis. Defaults to null for automatic calculation based on the data.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 122
-
xAxis.maxSize :string
-
Defines the maximum size of the axis in pixels (e.g. '50px') or percent (e.g. '15%').
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 103
-
xAxis.min :number
-
The minimum value of the axis. Defaults to null for automatic calculation based on the data.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 121
-
xAxis.minorStep :number
-
The increment between minor tick marks. Defaults to null for automatic calculation based on the data. Only applies to numerical axes.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 127
-
xAxis.minorTick :object
-
An object defining properties for the minor tick marks.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 148
-
xAxis.minorTick.lineColor :string
-
The color of the minor tick marks.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 149
-
xAxis.minorTick.lineStyle :string
-
The line style of the minor tick marks.
- Default Value:
"solid"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 150
Supported Values:
Name Type "dotted"
string "dashed"
string "solid"
string -
xAxis.minorTick.lineWidth :number
-
The width of the minor tick marks.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 151
-
xAxis.minorTick.rendered :string
-
Defines whether the minor tick marks are rendered.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 152
Supported Values:
Name Type "on"
string "off"
string "auto"
string -
xAxis.minStep :number
-
The minimum increment between major tick marks. This is typically used to prevent fractional axis values for discrete measures. Only applies to numerical axes.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 126
-
xAxis.referenceObjects :Array.<Object>
-
The array of reference objects associated with the axis.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 105
-
xAxis.referenceObjects[].color :string
-
The color of the reference object.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 110
-
xAxis.referenceObjects[].displayInLegend :string
-
Defines whether the reference object should be shown in the legend.
- Default Value:
"off"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 120
Supported Values:
Name Type "on"
string "off"
string -
xAxis.referenceObjects[].high :number
-
The high value of a reference area. This property defines a constant value across the entire reference area and is ignored if the items array is specified.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 118
-
xAxis.referenceObjects[].id :string
-
The id of the reference object.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 106
-
xAxis.referenceObjects[].lineStyle :string
-
The line style of the reference line.
- Default Value:
"solid"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 112
Supported Values:
Name Type "dotted"
string "dashed"
string "solid"
string -
xAxis.referenceObjects[].lineType :string
-
The line type of the reference line. Only applies if the line value is not constant. centeredStepped and centeredSegmented are not supported for polar, scatter, and bubble charts.
- Default Value:
"straight"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 113
Supported Values:
Name Type "curved"
string "stepped"
string "centeredStepped"
string "segmented"
string "centeredSegmented"
string "straight"
string -
xAxis.referenceObjects[].lineWidth :number
-
The width of the reference line.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 111
-
xAxis.referenceObjects[].location :string
-
The location of the reference object relative to the data items.
- Default Value:
"back"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 109
Supported Values:
Name Type "front"
string "back"
string -
xAxis.referenceObjects[].low :number
-
The low value of a reference area. This property defines a constant value across the entire reference area and is ignored if the items array is specified.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 117
-
xAxis.referenceObjects[].max :number
-
The high value of a reference area. This property defines a constant value across the entire reference area and is ignored if the items array is specified.
- Default Value:
null
- Deprecated:
- Use 'high' instead
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 116
-
xAxis.referenceObjects[].min :number
-
The low value of a reference area. This property defines a constant value across the entire reference area and is ignored if the items array is specified.
- Default Value:
null
- Deprecated:
- Use 'low' instead
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 115
-
xAxis.referenceObjects[].shortDesc :string
-
The description of this object. This is used for accessibility and also for customizing the tooltip text.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 119
-
xAxis.referenceObjects[].text :string
-
The text displayed in the legend for the reference object.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 107
-
xAxis.referenceObjects[].type :string
-
The type of reference object being shown.
- Default Value:
"line"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 108
Supported Values:
Name Type "area"
string "line"
string -
xAxis.referenceObjects[].value :number
-
The value of a reference line. This property defines a constant value across the entire reference line and is ignored if the items array is specified.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 114
-
xAxis.rendered :string
-
Defines whether the axis is rendered.
- Default Value:
"on"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 101
Supported Values:
Name Type "off"
string "on"
string -
xAxis.scale :string
-
Defines the axis scale. Only applies to numerical axes.
- Default Value:
"linear"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 128
Supported Values:
Name Type "log"
string "linear"
string -
xAxis.size :string
-
Defines the size of the axis in pixels (e.g. '50px') or percent (e.g. '15%').
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 102
-
xAxis.step :number
-
The increment between major tick marks. Defaults to null for automatic calculation based on the data. Only applies to time and numerical axes.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 125
-
xAxis.tickLabel :object
-
An object defining the properties of the tick labels.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 130
-
xAxis.tickLabel.converter :object
-
The converter to format the labels. When using a time axis, this attribute also takes an array of two converters, which apply respectively to the first and second label levels. 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
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 135
-
xAxis.tickLabel.rendered :string
-
Defines whether the tick labels are rendered.
- Default Value:
"on"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 131
Supported Values:
Name Type "off"
string "on"
string -
xAxis.tickLabel.rotation :string
-
Defines whether the chart will automatically rotate the labels by 90 degrees in order to fit more labels on the axis. The rotation will only be applied to categorical labels for a horizontal axis.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 134
Supported Values:
Name Type "none"
string "auto"
string -
xAxis.tickLabel.scaling :string
-
The scaling behavior of the labels. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 133
Supported Values:
Name Type "none"
string "thousand"
string "million"
string "billion"
string "trillion"
string "quadrillion"
string "auto"
string -
xAxis.tickLabel.style :string
-
The CSS style string defining the style of the labels.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 132
-
xAxis.title :string
-
The axis title. Does not apply to polar charts.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 104
-
xAxis.titleStyle :string
-
The CSS style string defining the style of the axis title.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 129
-
xAxis.viewportEndGroup :string|Date
-
Specifies the end group of the current viewport. Only applies to charts with group or time axis. If not specified, the default end group is the last group in the data set.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 157
-
xAxis.viewportMax :number
-
Specifies the maximum x coordinate of the current viewport for zoom and scroll. For group axis, the group index will be treated as the axis coordinate. If both viewportEndGroup and viewportMax are specified, then viewportEndGroup takes precedence. If not specified, this value will be the axis max.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 155
-
xAxis.viewportMin :number
-
Specifies the minimum x coordinate of the current viewport for zoom and scroll. For group axis, the group index will be treated as the axis coordinate. If both viewportStartGroup and viewportMin are specified, then viewportStartGroup takes precedence. If not specified, this value will be the axis min.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 154
-
xAxis.viewportStartGroup :string|Date
-
Specifies the start group of the current viewport. Only applies to charts with group or time axis. If not specified, the default start group is the first group in the data set.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 156
-
y2Axis :object
-
An object defining properties for the axis, tick marks, tick labels, and axis titles. Y2 axis is only supported for Cartesian bar, line, area, and combo charts.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 222
-
y2Axis.alignTickMarks :string
-
Defines whether the tick marks of the y1 and y2 axes are aligned.
- Default Value:
"on"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 284
Supported Values:
Name Type "off"
string "on"
string -
y2Axis.axisLine :object
-
An object defining properties for the axis line.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 266
-
y2Axis.axisLine.lineColor :string
-
The color of the axis line.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 267
-
y2Axis.axisLine.lineWidth :number
-
The width of the axis line.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 268
-
y2Axis.axisLine.rendered :string
-
Defines whether the axis line is rendered.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 269
Supported Values:
Name Type "on"
string "off"
string "auto"
string -
y2Axis.baselineScaling :string
-
Defines whether the axis baseline starts at the minimum value of the data or at zero. Only applies to numerical data axes.
- Default Value:
"zero"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 283
Supported Values:
Name Type "min"
string "zero"
string -
y2Axis.dataMax :number
-
The maximum data value corresponding to an axis. If specified, the automatic axis extent calculation will use this value.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 254
-
y2Axis.dataMin :number
-
The minimum data value corresponding to an axis. If specified, the automatic axis extent calculation will use this value.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 253
-
y2Axis.majorTick :object
-
An object defining properties for the major tick marks.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 270
-
y2Axis.majorTick.baselineColor :string
-
The color of the major tick mark at the baseline (y = 0). Valid values are auto, inherit, or a custom color. If set to inherit, it will follow the lineColor attribute.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 274
Supported Values:
Name Type "inherit"
string "auto"
string -
y2Axis.majorTick.baselineStyle :string
-
The line style of the major tick mark at the baseline (y = 0). If not specified, it will follow the lineStyle attribute.
- Default Value:
"solid"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 275
Supported Values:
Name Type "dotted"
string "dashed"
string "solid"
string -
y2Axis.majorTick.baselineWidth :number
-
The width of the major tick mark at the baseline (y = 0) If not specified, it will follow the lineWidth attribute.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 276
-
y2Axis.majorTick.lineColor :string
-
The color of the major tick marks.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 271
-
y2Axis.majorTick.lineStyle :string
-
The line style of the major tick marks.
- Default Value:
"solid"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 272
Supported Values:
Name Type "dotted"
string "dashed"
string "solid"
string -
y2Axis.majorTick.lineWidth :number
-
The width of the major tick marks.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 273
-
y2Axis.majorTick.rendered :string
-
Defines whether the major tick marks are rendered.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 277
Supported Values:
Name Type "on"
string "off"
string "auto"
string -
y2Axis.max :number
-
The maximum value of the axis. Defaults to null for automatic calculation based on the data.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 252
-
y2Axis.maxSize :string
-
Defines the maximum size of the axis in pixels (e.g. '50px') or percent (e.g. '15%').
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 225
-
y2Axis.min :number
-
The minimum value of the axis. Defaults to null for automatic calculation based on the data.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 251
-
y2Axis.minorStep :number
-
The increment between minor tick marks. Defaults to null for automatic calculation based on the data.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 257
-
y2Axis.minorTick :object
-
An object defining properties for the minor tick marks.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 278
-
y2Axis.minorTick.lineColor :string
-
The color of the minor tick marks.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 279
-
y2Axis.minorTick.lineStyle :string
-
The line style of the minor tick marks.
- Default Value:
"solid"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 280
Supported Values:
Name Type "dotted"
string "dashed"
string "solid"
string -
y2Axis.minorTick.lineWidth :number
-
The width of the minor tick marks.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 281
-
y2Axis.minorTick.rendered :string
-
Defines whether the minor tick marks are rendered.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 282
Supported Values:
Name Type "on"
string "off"
string "auto"
string -
y2Axis.minStep :number
-
The minimum increment between major tick marks. This is typically used to prevent fractional axis values for discrete measures.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 256
-
y2Axis.position :string
-
The position of the axis relative to its content. For vertical charts, only start and end apply. For horizontal charts, only top and bottom apply.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 227
Supported Values:
Name Type "start"
string "end"
string "top"
string "bottom"
string "auto"
string -
y2Axis.referenceObjects :Array.<Object>
-
The array of reference objects associated with the axis.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 228
-
y2Axis.referenceObjects[].color :string
-
The color of the reference object.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 233
-
y2Axis.referenceObjects[].displayInLegend :string
-
Defines whether the reference object should be shown in the legend.
- Default Value:
"off"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 243
Supported Values:
Name Type "on"
string "off"
string -
y2Axis.referenceObjects[].high :number
-
The high value of a reference area. This property defines a constant value across the entire reference area and is ignored if the items array is specified.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 241
-
y2Axis.referenceObjects[].id :string
-
The id of the reference object.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 229
-
y2Axis.referenceObjects[].items :Array.<Object>|Array.<number>
-
An array of values or an array of objects with the following properties that defines the data for a varying reference object. Only supported for y1 and y2 axes for all chart types.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 244
-
y2Axis.referenceObjects[].items[].high :number
-
The high value of this point of a reference area.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 248
-
y2Axis.referenceObjects[].items[].low :number
-
The low value of this point of a reference area.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 247
-
y2Axis.referenceObjects[].items[].max :number
-
The high value of this point of a reference area.
- Default Value:
null
- Deprecated:
- Use 'high' instead
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 246
-
y2Axis.referenceObjects[].items[].min :number
-
The low value of this point of a reference area.
- Default Value:
null
- Deprecated:
- Use 'low' instead
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 245
-
y2Axis.referenceObjects[].items[].value :number
-
The value of this point of a line object.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 249
-
y2Axis.referenceObjects[].items[].x :number|Date
-
The x-value on a data axis or date on a time axis for this point, not used for categorical axis.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 250
-
y2Axis.referenceObjects[].lineStyle :string
-
The line style of the reference line.
- Default Value:
"solid"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 235
Supported Values:
Name Type "dotted"
string "dashed"
string "solid"
string -
y2Axis.referenceObjects[].lineType :string
-
The line type of the reference line. Only applies if the line value is not constant. centeredStepped and centeredSegmented are not supported for polar, scatter, and bubble charts.
- Default Value:
"straight"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 236
Supported Values:
Name Type "curved"
string "stepped"
string "centeredStepped"
string "segmented"
string "centeredSegmented"
string "straight"
string -
y2Axis.referenceObjects[].lineWidth :number
-
The width of the reference line.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 234
-
y2Axis.referenceObjects[].location :string
-
The location of the reference object relative to the data items.
- Default Value:
"back"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 232
Supported Values:
Name Type "front"
string "back"
string -
y2Axis.referenceObjects[].low :number
-
The low value of a reference area. This property defines a constant value across the entire reference area and is ignored if the items array is specified.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 240
-
y2Axis.referenceObjects[].max :number
-
The high value of a reference area. This property defines a constant value across the entire reference area and is ignored if the items array is specified.
- Default Value:
null
- Deprecated:
- Use 'high' instead
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 239
-
y2Axis.referenceObjects[].min :number
-
The low value of a reference area. This property defines a constant value across the entire reference area and is ignored if the items array is specified.
- Default Value:
null
- Deprecated:
- Use 'low' instead
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 238
-
y2Axis.referenceObjects[].shortDesc :string
-
The description of this object. This is used for accessibility and also for customizing the tooltip text.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 242
-
y2Axis.referenceObjects[].text :string
-
The text displayed in the legend for the reference object.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 230
-
y2Axis.referenceObjects[].type :string
-
The type of reference object being shown.
- Default Value:
"line"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 231
Supported Values:
Name Type "area"
string "line"
string -
y2Axis.referenceObjects[].value :number
-
The value of a reference line. This property defines a constant value across the entire reference line and is ignored if the items array is specified.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 237
-
y2Axis.rendered :string
-
Defines whether the axis is rendered.
- Default Value:
"on"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 223
Supported Values:
Name Type "off"
string "on"
string -
y2Axis.scale :string
-
Defines the axis scale. Only applies to numerical axes.
- Default Value:
"linear"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 258
Supported Values:
Name Type "log"
string "linear"
string -
y2Axis.size :string
-
Defines the size of the axis in pixels (e.g. '50px') or percent (e.g. '15%').
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 224
-
y2Axis.step :number
-
The increment between major tick marks. Defaults to null for automatic calculation based on the data.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 255
-
y2Axis.tickLabel :object
-
An object defining the properties of the tick labels.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 260
-
y2Axis.tickLabel.converter :object
-
The converter to format the labels. 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
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 265
-
y2Axis.tickLabel.position :string
-
Defines the position of the tick labels relative to the plot area.
- Default Value:
"outside"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 262
Supported Values:
Name Type "inside"
string "outside"
string -
y2Axis.tickLabel.rendered :string
-
Defines whether the tick labels are rendered.
- Default Value:
"on"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 261
Supported Values:
Name Type "off"
string "on"
string -
y2Axis.tickLabel.scaling :string
-
The scaling behavior of the labels. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 264
Supported Values:
Name Type "none"
string "thousand"
string "million"
string "billion"
string "trillion"
string "quadrillion"
string "auto"
string -
y2Axis.tickLabel.style :string
-
The CSS style string defining the style of the labels.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 263
-
y2Axis.title :string
-
The axis title.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 226
-
y2Axis.titleStyle :string
-
The CSS style string defining the style of the axis title.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 259
-
yAxis :object
-
An object defining properties for the axis, tick marks, tick labels, and axis titles.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 158
-
yAxis.axisLine :object
-
An object defining properties for the axis line.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 202
-
yAxis.axisLine.lineColor :string
-
The color of the axis line.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 203
-
yAxis.axisLine.lineWidth :number
-
The width of the axis line.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 204
-
yAxis.axisLine.rendered :string
-
Defines whether the axis line is rendered.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 205
Supported Values:
Name Type "on"
string "off"
string "auto"
string -
yAxis.baselineScaling :string
-
Defines whether the axis baseline starts at the minimum value of the data or at zero. Only applies to numerical data axes.
- Default Value:
"zero"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 219
Supported Values:
Name Type "min"
string "zero"
string -
yAxis.dataMax :number
-
The maximum data value corresponding to an axis. If specified, the automatic axis extent calculation will use this value.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 190
-
yAxis.dataMin :number
-
The minimum data value corresponding to an axis. If specified, the automatic axis extent calculation will use this value.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 189
-
yAxis.majorTick :object
-
An object defining properties for the major tick marks.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 206
-
yAxis.majorTick.baselineColor :string
-
The color of the major tick mark at the baseline (y = 0). Valid values are auto, inherit, or a custom color. If set to inherit, it will follow the lineColor attribute.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 210
Supported Values:
Name Type "inherit"
string "auto"
string -
yAxis.majorTick.baselineStyle :string
-
The line style of the major tick mark at the baseline (y = 0). If not specified, it will follow the lineStyle attribute.
- Default Value:
"solid"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 211
Supported Values:
Name Type "dotted"
string "dashed"
string "solid"
string -
yAxis.majorTick.baselineWidth :number
-
The width of the major tick mark at the baseline (y = 0) If not specified, it will follow the lineWidth attribute.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 212
-
yAxis.majorTick.lineColor :string
-
The color of the major tick marks.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 207
-
yAxis.majorTick.lineStyle :string
-
The line style of the major tick marks.
- Default Value:
"solid"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 209
Supported Values:
Name Type "dotted"
string "dashed"
string "solid"
string -
yAxis.majorTick.lineWidth :number
-
The width of the major tick marks.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 208
-
yAxis.majorTick.rendered :string
-
Defines whether the major tick marks are rendered.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 213
Supported Values:
Name Type "on"
string "off"
string "auto"
string -
yAxis.max :number
-
The maximum value of the axis. Defaults to null for automatic calculation based on the data.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 188
-
yAxis.maxSize :string
-
Defines the maximum size of the axis in pixels (e.g. '50px') or percent (e.g. '15%').
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 161
-
yAxis.min :number
-
The minimum value of the axis. Defaults to null for automatic calculation based on the data.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 187
-
yAxis.minorStep :number
-
The increment between minor tick marks. Defaults to null for automatic calculation based on the data.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 193
-
yAxis.minorTick :object
-
An object defining properties for the minor tick marks.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 214
-
yAxis.minorTick.lineColor :string
-
The color of the minor tick marks.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 215
-
yAxis.minorTick.lineStyle :string
-
The line style of the minor tick marks.
- Default Value:
"solid"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 216
Supported Values:
Name Type "dotted"
string "dashed"
string "solid"
string -
yAxis.minorTick.lineWidth :number
-
The width of the minor tick marks.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 217
-
yAxis.minorTick.rendered :string
-
Defines whether the minor tick marks are rendered.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 218
Supported Values:
Name Type "on"
string "off"
string "auto"
string -
yAxis.minStep :number
-
The minimum increment between major tick marks. This is typically used to prevent fractional axis values for discrete measures.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 192
-
yAxis.position :string
-
The position of the axis relative to its content. For vertical charts, only start and end apply. For horizontal charts, only top and bottom apply.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 163
Supported Values:
Name Type "start"
string "end"
string "top"
string "bottom"
string "auto"
string -
yAxis.referenceObjects :Array.<Object>
-
The array of reference objects associated with the axis.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 164
-
yAxis.referenceObjects[].color :string
-
The color of the reference object.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 169
-
yAxis.referenceObjects[].displayInLegend :string
-
Defines whether the reference object should be shown in the legend.
- Default Value:
"off"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 179
Supported Values:
Name Type "on"
string "off"
string -
yAxis.referenceObjects[].high :number
-
The high value of a reference area. This property defines a constant value across the entire reference area and is ignored if the items array is specified.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 177
-
yAxis.referenceObjects[].id :string
-
The id of the reference object.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 165
-
yAxis.referenceObjects[].items :Array.<Object>|Array.<number>
-
An array of values or an array of objects with the following properties that defines the data for a varying reference object. Only supported for y1 and y2 axes for all chart types.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 180
-
yAxis.referenceObjects[].items[].high :number
-
The high value of this point of a reference area.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 184
-
yAxis.referenceObjects[].items[].low :number
-
The low value of this point of a reference area.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 183
-
yAxis.referenceObjects[].items[].max :number
-
The high value of this point of a reference area.
- Default Value:
null
- Deprecated:
- Use 'high' instead
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 182
-
yAxis.referenceObjects[].items[].min :number
-
The low value of this point of a reference area.
- Default Value:
null
- Deprecated:
- Use 'low' instead
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 181
-
yAxis.referenceObjects[].items[].value :number
-
The value of this point of a line object.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 185
-
yAxis.referenceObjects[].items[].x :number|Date
-
The x-value on a data axis or date on a time axis for this point, not used for categorical axis.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 186
-
yAxis.referenceObjects[].lineStyle :string
-
The line style of the reference line.
- Default Value:
"solid"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 171
Supported Values:
Name Type "dotted"
string "dashed"
string "solid"
string -
yAxis.referenceObjects[].lineType :string
-
The line type of the reference line. Only applies if the line value is not constant. centeredStepped and centeredSegmented are not supported for polar, scatter, and bubble charts.
- Default Value:
"straight"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 172
Supported Values:
Name Type "curved"
string "stepped"
string "centeredStepped"
string "segmented"
string "centeredSegmented"
string "straight"
string -
yAxis.referenceObjects[].lineWidth :number
-
The width of the reference line.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 170
-
yAxis.referenceObjects[].location :string
-
The location of the reference object relative to the data items.
- Default Value:
"back"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 168
Supported Values:
Name Type "front"
string "back"
string -
yAxis.referenceObjects[].low :number
-
The low value of a reference area. This property defines a constant value across the entire reference area and is ignored if the items array is specified.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 176
-
yAxis.referenceObjects[].max :number
-
The high value of a reference area. This property defines a constant value across the entire reference area and is ignored if the items array is specified.
- Default Value:
null
- Deprecated:
- Use 'high' instead
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 175
-
yAxis.referenceObjects[].min :number
-
The low value of a reference area. This property defines a constant value across the entire reference area and is ignored if the items array is specified.
- Default Value:
null
- Deprecated:
- Use 'low' instead
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 174
-
yAxis.referenceObjects[].shortDesc :string
-
The description of this object. This is used for accessibility and also for customizing the tooltip text.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 178
-
yAxis.referenceObjects[].text :string
-
The text displayed in the legend for the reference object.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 166
-
yAxis.referenceObjects[].type :string
-
The type of reference object being shown.
- Default Value:
"line"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 167
Supported Values:
Name Type "area"
string "line"
string -
yAxis.referenceObjects[].value :number
-
The value of a reference line. This property defines a constant value across the entire reference line and is ignored if the items array is specified.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 173
-
yAxis.rendered :string
-
Defines whether the axis is rendered.
- Default Value:
"on"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 159
Supported Values:
Name Type "off"
string "on"
string -
yAxis.scale :string
-
Defines the axis scale. Only applies to numerical axes.
- Default Value:
"linear"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 194
Supported Values:
Name Type "log"
string "linear"
string -
yAxis.size :string
-
Defines the size of the axis in pixels (e.g. '50px') or percent (e.g. '15%').
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 160
-
yAxis.step :number
-
The increment between major tick marks. Defaults to null for automatic calculation based on the data.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 191
-
yAxis.tickLabel :object
-
An object defining the properties of the tick labels.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 196
-
yAxis.tickLabel.converter :object
-
The converter to format the labels. 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
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 201
-
yAxis.tickLabel.position :string
-
Defines the position of the tick labels relative to the plot area. Inside position is not supported for scatter and bubble charts.
- Default Value:
"outside"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 198
Supported Values:
Name Type "inside"
string "outside"
string -
yAxis.tickLabel.rendered :string
-
Defines whether the tick labels are rendered.
- Default Value:
"on"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 197
Supported Values:
Name Type "off"
string "on"
string -
yAxis.tickLabel.scaling :string
-
The scaling behavior of the labels. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
- Default Value:
"auto"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 200
Supported Values:
Name Type "none"
string "thousand"
string "million"
string "billion"
string "trillion"
string "quadrillion"
string "auto"
string -
yAxis.tickLabel.style :string
-
The CSS style string defining the style of the labels.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 199
-
yAxis.title :string
-
The axis title. Does not apply to polar charts.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 162
-
yAxis.titleStyle :string
-
The CSS style string defining the style of the axis title.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 195
-
yAxis.viewportMax :number
-
Specifies the maximum y coordinate of the current viewport for zoom and scroll. Only applies to bubble and scatter charts. If not specified, this value will be the axis max.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 221
-
yAxis.viewportMin :number
-
Specifies the minimum y coordinate of the current viewport for zoom and scroll. Only applies to bubble and scatter charts. If not specified, this value will be the axis min.
- Default Value:
null
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 220
-
zoomAndScroll :string
-
Specifies the zoom and scroll behavior of the chart. "Live" behavior means that the chart will be updated continuously as it is being manipulated, while "delayed" means that the update will wait until the zoom/scroll action is done. While "live" zoom and scroll provides the best end user experience, no guarantess are made about the rendering performance or usability for large data sets or slow client environments. If performance is an issue, "delayed" zoom and scroll should be used instead.
- Default Value:
"off"
- Source:
- 3rdparty/dvt/doc/ojchart_options.js, line 373
Supported Values:
Name Type "delayedScrollOnly"
string "liveScrollOnly"
string "delayed"
string "live"
string "off"
string
Sub-ID's
Each sub-ID is a string that identifies a particular DOM node in this component.
-
oj-chart-axis-title
-
Sub-ID for the title of the specified axis.
See the getNodeBySubId and getSubIdByNode methods for details.
The locator object also contains the following properties:- axis:
xAxis
,yAxis
, ory2Axis
- Source:
Example
Get the title for the x-axis:
var nodes = $( ".selector" ).ojChart( "getNodeBySubId", {'subId': 'oj-chart-axis-title', 'axis': 'xAxis'} );
- axis:
-
oj-chart-group
-
Sub-ID for a categorical axis label that represents the group with the specified index.
See the getNodeBySubId and getSubIdByNode methods for details.
The locator object also contains the following properties:- indexPath: The array of indices corresponding to the position of the group in the options array.
- Source:
Example
Get the categorical axis label that represents the first group:
var nodes = $( ".selector" ).ojChart( "getNodeBySubId", {'subId': 'oj-chart-group', 'indexPath': [0]} );
-
oj-chart-item
-
Sub-ID for chart data items indexed by series and group indices. The group index is not required for pie and funnel charts.
See the getNodeBySubId and getSubIdByNode methods for details.
The locator object also contains the following properties:- seriesIndex
- itemIndex
- Source:
Example
Get the data item from the first series and second group:
var nodes = $( ".selector" ).ojChart( "getNodeBySubId", {'subId': 'oj-chart-item', 'seriesIndex': 0, 'itemIndex': 1} );
-
oj-chart-reference-object
-
Sub-ID for the reference object of the specified axis with the given index.
See the getNodeBySubId and getSubIdByNode methods for details.
The locator object also contains the following properties:- axis:
xAxis
,yAxis
, ory2Axis
- index: The index of the reference object for the specified axis.
- Source:
Example
Get the first reference object of the y-axis:
var nodes = $( ".selector" ).ojChart( "getNodeBySubId", {'subId': 'oj-chart-reference-object', 'axis': 'yAxis', 'index': 0} );
- axis:
-
oj-chart-series
-
Sub-ID for a legend item that represents the series with the specified index.
See the getNodeBySubId and getSubIdByNode methods for details.
The locator object also contains the following properties:- index
- Source:
Example
Get the legend item that represents the first series:
var nodes = $( ".selector" ).ojChart( "getNodeBySubId", {'subId': 'oj-chart-series', 'index': 0} );
-
oj-chart-tooltip
-
Sub-ID for the the chart tooltip.
See the getNodeBySubId and getSubIdByNode methods for details.
- Source:
Example
Get the tooltip object of the chart, if displayed:
var nodes = $( ".selector" ).ojChart( "getNodeBySubId", {'subId': 'oj-chart-tooltip'} );
-
oj-legend-item
-
Sub-ID for a legend item indexed by its position in its parent section's item array and its parent's sectionIndex.
See the getNodeBySubId and getSubIdByNode methods for details.
The locator object also contains the following properties:- sectionIndexPath: The array of numerical indices for the section.
- itemIndex: The index of the item within the specified section
- Source:
Example
Get the first legend item from the first legend section:
var nodes = $( ".selector" ).ojChart( "getNodeBySubId", {'subId': 'oj-legend-item', sectionIndexPath: [0], itemIndex: 1} );
Events
-
categoryFilter
-
Triggered when a category of data items is hidden or shown.
- Deprecated:
- Use the
optionChange
listener to detect changes to thehiddenCategories
property instead.
- Use the
- Source:
Properties:
Name Type Description ui
Object event payload Properties
Name Type Description category
Object the category that was filtered on type
string specifies whether the category is being filtered 'in' or 'out' Examples
Initialize the component with the
categoryFilter
callback specified:$(".selector").ojChart({ "categoryFilter": function(event, ui){} });
Bind an event listener to the
ojcategoryfilter
event:$(".selector").on("ojcategoryfilter", function(event, ui){});
-
categoryHighlight
-
Triggered when a category of data items is highlighted.
- Deprecated:
- Use the
optionChange
listener to detect changes to thehighlightedCategories
property instead.
- Use the
- Source:
Properties:
Name Type Description ui
Object event payload Properties
Name Type Description categories
Array the categories that are being highlighted type
string specifies whether highlighting is being turned 'on' or 'off' Examples
Initialize the component with the
categoryHighlight
callback specified:$(".selector").ojChart({ "categoryHighlight": function(event, ui){} });
Bind an event listener to the
ojcategoryhighlight
event:$(".selector").on("ojcategoryhighlight", function(event, ui){});
-
destroy
-
Triggered before the component is destroyed. This event cannot be canceled; the component will always be destroyed regardless.
- Inherited From:
- Source:
Examples
Initialize component with the
destroy
callback// Foo is Button, InputText, etc. $(".selector").ojFoo({ 'destroy': function (event, data) {} });
Bind an event listener to the destroy event
$(".selector").on({ 'ojdestroy': function (event, data) { window.console.log("The DOM node id for the destroyed component is : %s", event.target.id); }; });
-
drill
-
Triggered during a drill gesture (double click if selection is enabled, single click otherwise).
- Source:
Properties:
Name Type Description ui
Object event payload Properties
Name Type Description id
string the id of the drilled object series
string the series name of the drilled object, if applicable group
string the group name of the drilled object, if applicable Examples
Initialize the component with the
drill
callback specified:$(".selector").ojChart({ "drill": function(event, ui){} });
Bind an event listener to the
ojdrill
event:$(".selector").on("ojdrill", function(event, ui){});
-
optionChange
-
Fired whenever a supported component option changes, whether due to user interaction or programmatic intervention. If the new value is the same as the previous value, no event will be fired.
- Source:
Properties:
Name Type Description data
Object event payload Properties
Name Type Description option
string the name of the option that changed, i.e. "value" previousValue
Object an Object holding the previous value of the option value
Object an Object holding the current value of the option ui.optionMetadata
Object information about the option that is changing Properties
Name Type Description writeback
string "shouldWrite"
or"shouldNotWrite"
. For use by the JET writeback mechanism.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 Examples
Initialize the component with the
optionChange
callback:$(".selector").ojChart({ 'optionChange': function (event, data) {} });
Bind an event listener to the
ojoptionchange
event:$(".selector").on({ 'ojoptionchange': function (event, data) { window.console.log("option changing is: " + data['option']); }; });
-
selectInput
-
Triggered during a selection gesture, such as a change in the marquee selection rectangle.
- Source:
Properties:
Name Type Description ui
Object event payload Properties
Name Type Description items
Array an array containing objects describing the selected data items Properties
Name Type Description id
string the id of the data item, if one was specified group
string the group of the data item series
string the series of the data 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 Examples
Initialize the component with the
selectInput
callback specified:$(".selector").ojChart({ "selectInput": function(event, ui){} });
Bind an event listener to the
ojselectinput
event:$(".selector").on("ojselectinput", function(event, ui){});
-
viewportChange
-
Triggered after the viewport is changed due to a zoom or scroll operation.
- Source:
Properties:
Name Type Description ui
Object event payload Properties
Name Type Description endGroup
string the end group of the new viewport on a chart with categorical axis startGroup
string the start group of the new viewport on a chart with categorical axis xMax
number the maximum x value of the new viewport xMin
number the minimum x value of the new viewport yMax
number the maximum y value of the new viewport yMin
number the minimum y value of the new viewport Examples
Initialize the component with the
viewportChange
callback specified:$(".selector").ojChart({ "viewportChange": function(event, ui){} });
Bind an event listener to the
ojviewportchange
event:$(".selector").on("ojviewportchange", function(event, ui){});
-
viewportChangeInput
-
Triggered during a viewport change gesture, such as a drag operation on the overview window. Note: There are situations where the component cannot determine whether the viewport change gesture is still in progress, such as with mouse wheel zoom interactions. Standard viewportChange events are fired in these cases.
- Source:
Properties:
Name Type Description ui
Object event payload Properties
Name Type Description endGroup
string the end group of the new viewport on a chart with categorical axis startGroup
string the start group of the new viewport on a chart with categorical axis xMax
number the maximum x value of the new viewport xMin
number the minimum x value of the new viewport yMax
number the maximum y value of the new viewport yMin
number the minimum y value of the new viewport Examples
Initialize the component with the
viewportChangeInput
callback specified:$(".selector").ojChart({ "viewportChangeInput": function(event, ui){} });
Bind an event listener to the
ojviewportchangeinput
event:$(".selector").on("ojviewportchangeinput", function(event, ui){});
Methods
-
getDataItem(seriesIndex, groupIndex) → {Object|null}
-
Returns an object with the following properties for automation testing verification of the data item with the specified series and group indices.
Parameters:
Name Type Description seriesIndex
number groupIndex
number - Source:
Properties:
Name Type Description borderColor
string color
string close
number The closing value for a stock item group
string The group id. high
number The high value for a range or stock item label
string low
number The low value for a range or stock item open
number The opening value for a stock item selected
boolean series
string The series id. targetValue
number The target value for a funnel slice. tooltip
string value
number volume
number The volume of a stock item x
number y
number z
number getBorderColor
Function Deprecated: Use borderColor
instead.getColor
Function Deprecated: Use color
instead.getGroup
Function Deprecated: Use group
instead.getLabel
Function Deprecated: Use label
instead.getSeries
Function Deprecated: Use series
instead.getTargetValue
Function Deprecated: Use targetValue
instead.getTooltip
Function Deprecated: Use tooltip
instead.getValue
Function Deprecated: Use value
instead.getX
Function Deprecated: Use x
instead.getY
Function Deprecated: Use y
instead.getZ
Function Deprecated: Use z
instead.isSelected
Function Deprecated: Use selected
instead.Returns:
An object containing properties for the data item, or null if none exists.- Type
- Object | null
-
getGroup(groupIndex) → {String}
-
Returns the group corresponding to the given index
Parameters:
Name Type Description groupIndex
String the group index - Source:
Returns:
The group name corresponding to the given group index- Type
- String
-
getGroupCount() → {Number}
-
Returns number of groups in the chart data
- Source:
Returns:
The number of groups- Type
- Number
-
getLegend() → {Object}
-
Returns an object with the following properties for automation testing verification of the chart legend.
- Source:
Properties:
Name Type Description bounds
Object An object containing the bounds of the legend. Properties
Name Type x
number y
number width
number height
number title
string getBounds
Function Deprecated: Use bounds
instead.getTitle
Function Deprecated: Use title
instead.Returns:
An object containing properties for the chart legend.- Type
- Object
-
getNodeBySubId(locator) → {Element|null}
-
Returns the component DOM node indicated by the
locator
parameter.If the
locator
or itssubId
isnull
, then this method returns the element on which this component was initialized.If a
subId
was provided but no corresponding node can be located, then this method returnsnull
.Parameters:
Name Type Description locator
Object An Object containing, at minimum, a subId
property, whose value is a string that identifies a particular DOM node in this component.If this component has (or inherits) any subIds, then they are documented in the "Sub-ID's" section of this document.
Subclasses of this component may support additional fields of the
locator
Object, to further specify the desired node.- Inherited From:
- Source:
Returns:
The DOM node located by thesubId
string passed inlocator
, ornull
if none is found.- Type
- Element | null
Example
Get the node for a certain subId:
// Foo is ojInputNumber, ojInputDate, etc. var node = $( ".selector" ).ojFoo( "getNodeBySubId", {'subId': 'oj-some-sub-id'} );
-
getPlotArea() → {Object}
-
Returns an object with the following properties for automation testing verification of the chart plot area.
- Source:
Properties:
Name Type Description bounds
Object An object containing the bounds of the plot area. Properties
Name Type x
number y
number width
number height
number getBounds
Function Deprecated: Use bounds
instead.Returns:
An object containing properties for the chart plot area.- Type
- Object
-
getSeries(seriesIndex) → {String}
-
Returns the series corresponding to the given index
Parameters:
Name Type Description seriesIndex
String the series index - Source:
Returns:
The series name corresponding to the given series index- Type
- String
-
getSeriesCount() → {Number}
-
Returns number of series in the chart data
- Source:
Returns:
The number of series- Type
- Number
-
getTitle() → {String}
-
Returns the chart title.
- Source:
Returns:
The chart title- Type
- String
-
getValuesAt(x, y) → {Object}
-
Returns the x, y, and y2 axis values at the specified X and Y coordinate.
Parameters:
Name Type Description x
Number The X coordinate relative to the component. y
Number The Y coordinate relative to the component. - Source:
Returns:
An object containing the "x", "y", and "y2" axis values.- Type
- Object
-
getXAxis() → {Object}
-
Returns an object with the following properties for automation testing verification of the x axis.
- Source:
Properties:
Name Type Description bounds
Object An object containing the bounds of the legend. Properties
Name Type x
number y
number width
number height
number title
string getPreferredSize
Function(number, number) Returns the preferred size of the axis, given the available width and height. This value can be passed into the size
andmaxSize
options of the axis. A re-render must be triggered by callingrefresh
after invoking this function.Properties
Name Type width
number height
number getBounds
Function Deprecated: Use bounds
instead.getTitle
Function Deprecated: Use title
instead.Returns:
An object containing properties for the x axis.- Type
- Object
-
getY2Axis() → {Object}
-
Returns an object with the following properties for automation testing verification of the y2 axis.
- Source:
Properties:
Name Type Description bounds
Object An object containing the bounds of the legend. Properties
Name Type x
number y
number width
number height
number title
string getPreferredSize
Function(number, number) Returns the preferred size of the axis, given the available width and height. This value can be passed into the size
andmaxSize
options of the axis. A re-render must be triggered by callingrefresh
after invoking this function.Properties
Name Type width
number height
number getBounds
Function Deprecated: Use bounds
instead.getTitle
Function Deprecated: Use title
instead.Returns:
An object containing properties for the y2 axis.- Type
- Object
-
getYAxis() → {Object}
-
Returns an object with the following properties for automation testing verification of the y axis.
- Source:
Properties:
Name Type Description bounds
Object An object containing the bounds of the legend. Properties
Name Type x
number y
number width
number height
number title
string getPreferredSize
Function(number, number) Returns the preferred size of the axis, given the available width and height. This value can be passed into the size
andmaxSize
options of the axis. A re-render must be triggered by callingrefresh
after invoking this function.Properties
Name Type width
number height
number getBounds
Function Deprecated: Use bounds
instead.getTitle
Function Deprecated: Use title
instead.Returns:
An object containing properties for the y axis.- Type
- Object
-
option(optionName, value) → {Object|undefined}
-
This method has several overloads, which get and set component options and their fields. The functionality is unchanged from that provided by JQUI. See the examples for details on each overload.
Parameters:
Name Type Argument Description optionName
string | Object <optional>
the option name (string, first two overloads), or the map (Object, last overload). Omitted in the third overload. value
Object <optional>
a value to set for the option. Second overload only. - Inherited From:
- Source:
Returns:
The getter overloads return the retrieved value(s). When called via the public jQuery syntax, the setter overloads return the object on which they were called, to facilitate method chaining.- Type
- Object | undefined
Examples
First overload: get one option:
This overload accepts a (possibly dot-separated)
optionName
param as a string, and returns the current value of that option.var isDisabled = $( ".selector" ).ojFoo( "option", "disabled" ); // Foo is Button, Menu, etc. // For object-valued options, dot notation can be used to get the value of a field or nested field. var startIcon = $( ".selector" ).ojButton( "option", "icons.start" ); // icons is object with "start" field
Second overload: set one option:
This overload accepts two params: a (possibly dot-separated)
optionName
string, and a new value to which that option will be set.$( ".selector" ).ojFoo( "option", "disabled", true ); // Foo is Button, Menu, etc. // For object-valued options, dot notation can be used to set the value // of a field or nested field, without altering the rest of the object. $( ".selector" ).ojButton( "option", "icons.start", myStartIcon ); // icons is object with "start" field
Third overload: get all options:
This overload accepts no params, and returns a map of key/value pairs representing all the component options and their values.
var options = $( ".selector" ).ojFoo( "option" ); // Foo is Button, Menu, etc.
Fourth overload: set one or more options:
This overload accepts a single map of option-value pairs to set on the component. Unlike the first two overloads, dot notation cannot be used.
$( ".selector" ).ojFoo( "option", { disabled: true, bar: 42 } ); // Foo is Button, Menu, etc.
-
refresh()
-
Refreshes the component.
- Inherited From:
- Source:
Returns:
When called via the public jQuery syntax, this method returns the object on which it was called, to facilitate method chaining.
Non-public Methods
Note: Extending JET components is not currently supported. Thus, non-public methods are for internal use only.
-
<protected> _AddAutomationGetters(map)
-
Adds getters for the properties on the specified map.
Parameters:
Name Type Description map
Object | null - Inherited From:
- Source:
-
<protected> _AfterCreate()
-
This method is called after _ComponentCreate, but before the
create
event is fired. The JET base component does tasks here that must happen after the component (subclass) has created itself in its override of _ComponentCreate. Notably, the base component handles the rootAttributes and contextMenu options here, since those options operate on the component root node, which for some components is created in their override of _ComponentCreate.Subclasses should override this method only if they have tasks that must happen after a superclass's implementation of this method, e.g. tasks that must happen after the context menu is set on the component.
Overrides of this method should call
this._super
first.- Inherited From:
- Source:
-
<protected> _AfterCreateEvent()
-
This method is called after the
create
event is fired. Components usually should not override this method, as it is rarely correct to wait until after thecreate
event to perform a create-time task.An example of a correct usage of this method is Dialog's auto-open behavior, which needs to happen after the
create
event.Only behaviors (like Dialog auto-open behavior) should occur in this method. Component initialization must occur earlier, before the
create
event is fired, so thatcreate
listeners see a fully inited component.Overrides of this method should call
this._super
first.Do not confuse this method with the _AfterCreate method, which is more commonly used.
- Inherited From:
- Source:
-
<protected> _CompareOptionValues(option, value1, value2) → {boolean}
-
Compares 2 option values for equality and returns true if they are equal; false otherwise.
Parameters:
Name Type Description option
String the name of the option value1
Object first value value2
Object another value - Inherited From:
- Source:
Returns:
- Type
- boolean
-
<protected> _ComponentCreate()
-
All component create-time initialization lives in this method, except the logic that specifically needs to live in _InitOptions, _AfterCreate, or _AfterCreateEvent, per the documentation for those methods. All DOM creation must happen here, since the intent of _AfterCreate, which is called next, is to contain superclass logic that must run after that DOM is created.
Overrides of this method should call
this._super
first.Summary of create-time methods that components can override, in the order that they are called:
- _InitOptions
- _ComponentCreate (this method)
- _AfterCreate
- (The
create
event is fired here.) - _AfterCreateEvent
For all of these methods, the contract is that overrides must call
this._super
first, so e.g., the_ComponentCreate
entry meansbaseComponent._ComponentCreate
, then_ComponentCreate
in any intermediate subclasses, then_ComponentCreate
in the leaf subclass.- Inherited From:
- Source:
-
<protected> _ConvertLocatorToSubId(locator) → {string|null}
-
Converts the specified locator object into a subId string.
Parameters:
Name Type Description locator
Object - Inherited From:
- Source:
Returns:
- Type
- string | null
-
<protected> _ConvertSubIdToLocator(subId) → {Object|null}
-
Converts the specified subId string into a locator object.
Parameters:
Name Type Description subId
string - Inherited From:
- Source:
Returns:
- Type
- Object | null
-
<protected> _create()
-
This method is final in JET. Components should instead override one or more of the overridable create-time methods listed in _ComponentCreate.
- Inherited From:
- Source:
-
<protected> _CreateDvtComponent(context, callback, callbackObj)
-
Called by _create to instantiate the specific DVT component instance. Subclasses must override.
Parameters:
Name Type Description context
dvt.DvtContext callback
Function callbackObj
Object - Inherited From:
- Source:
-
<protected> _GetChildStyleClasses() → {Object}
-
Returns a map of the style classes associated with a component's children.
- Inherited From:
- Source:
Returns:
- Type
- Object
-
<protected> _GetComponentStyleClasses() → {Array}
-
Returns the style classes associated with the component.
- Inherited From:
- Source:
Returns:
- Type
- Array
-
<protected> _getCreateOptions()
-
This method is not used in JET. Components should instead override _InitOptions.
- Inherited From:
- Source:
-
<protected> _GetDvtComponent(element) → {Object}
-
Returns a DVT component associated with a DOMElement
Parameters:
Name Type Description element
Element The DOMElement to get the DVT component from. - Inherited From:
- Source:
Returns:
The DVT component associated with the DOMElement or null- Type
- Object
-
<protected> _GetEventTypes() → {Array}
-
Returns an array of supported event types. Used in conjunction with _setOptions to skip unnecessary rendering when event listeners are bound. Subclasses must override to return supported event types.
- Inherited From:
- Source:
Returns:
- Type
- Array
-
<protected> _GetReadingDirection() → {string}
-
Determines whether the component is LTR or RTL.
Component responsibilities:
- All components must determine directionality exclusively by calling this protected superclass method. (So that any future updates to the logic can be made in this one place.)
- Components that need to know the directionality must call this method at create-time
and from
refresh()
, and cache the value. - Components should not call this at other times, and should instead use the cached value. (This avoids constant DOM queries, and avoids any future issues with component reparenting (i.e. popups) if support for directional islands is added.)
App responsibilities:
- The app specifies directionality by setting the HTML
"dir"
attribute on the<html>
node. When omitted, the default is"ltr"
. (Per-component directionality / directional islands are not currently supported due to inadequate CSS support.) - As with any DOM change, the app must
refresh()
the component if the directionality changes dynamically. (This provides a hook for component housekeeping, and allows caching.)
- Default Value:
"ltr"
- Inherited From:
- Source:
Returns:
the reading direction, either"ltr"
or"rtl"
- Type
- string
-
<protected> _GetSavedAttributes(element) → {Object|null}
-
Gets the saved attributes for the provided element.
If you don't override _SaveAttributes and _RestoreAttributes, then this will return null.
If you override _SaveAttributes to call _SaveAllAttributes, then this will return all the attributes. If you override _SaveAttributes/_RestoreAttributes to do your own thing, then you may also have to override _GetSavedAttributes to return whatever you saved if you need access to the saved attributes.
Parameters:
Name Type Description element
Object jQuery selection, should be a single entry - Inherited From:
- Source:
Returns:
savedAttributes - attributes that were saved for this element in _SaveAttributes, or null if none were saved.- Type
- Object | null
-
<protected> _GetTranslatedResource(key, params)
-
Retrieves the translated resource with the specified
Parameters:
Name Type Description key
string The key used to retrieve the translated resource. params
Array.<string> The array of named parameters that need to be converted into index based parameters. - Inherited From:
- Source:
-
<protected> _GetTranslationMap() → {Object}
-
Returns a map containing keys corresponding to the string ids in ojtranslations.js and values corresponding to the toolkit constants for the DvtBundle objects. This map must be guaranteed to be a new instance so that subclasses can add their translations to it.
- Inherited From:
- Source:
Returns:
- Type
- Object
-
<protected> _HandleEvent(event)
-
Called by the component to process events. Subclasses should override to delegate DVT component events to their JQuery listeners.
Parameters:
Name Type Description event
Object - Inherited From:
- Source:
-
<protected> _init()
-
JET components should almost never implement this JQUI method. Please consult an architect if you believe you have an exception. Reasons:
- This method is called at create time, after the
create
event is fired. It is rare for that to be the appropriate time to perform a create-time task. For those rare cases, we have the _AfterCreateEvent method, which is preferred over this method since it is called only at that time, not also at re-init time (see next). - This method is also called at "re-init" time, i.e. when the initializer is called after the component has already been created. JET has not yet identified any desired semantics for re-initing a component.
- Inherited From:
- Source:
- This method is called at create time, after the
-
<protected> _InitOptions(originalDefaults, constructorOptions)
-
This method is called before _ComponentCreate, at which point the component has not yet been rendered. Component options should be initialized in this method, so that their final values are in place when _ComponentCreate is called.
This includes getting option values from the DOM, where applicable, and coercing option values (however derived) to their appropriate data type if needed.
No work other than setting options should be done in this method. In particular, nothing should be set on the DOM until _ComponentCreate, e.g. setting the
disabled
DOM attribute from thedisabled
option.A given option (like
disabled
) appears in theconstructorOptions
param iff the app set it in the constructor:- If it appears in
constructorOptions
, it should win over what's in the DOM (e.g.disabled
DOM attribute). If for some reason you need to tweak the value that the app set, then enable writeback when doing so:this.option('foo', bar, {'_context': {writeback: true, internalSet: true}})
. - If it doesn't appear in
constructorOptions
, then that option definitely is not bound, so writeback is not needed. So if you need to set the option (e.g. from a DOM attribute), usethis.option('foo', bar, {'_context': {internalSet: true}})
.
Overrides of this method should call
this._super
first.Parameters:
Name Type Argument Description originalDefaults
Object original default options defined on the component and its ancestors constructorOptions
Object <nullable>
options passed into the widget constructor - Inherited From:
- Source:
- If it appears in
-
<protected> _IsEffectivelyDisabled() → {boolean}
-
Determines whether this component is effectively disabled, i.e. it has its 'disabled' attribute set to true or it has been disabled by its ancestor component.
- Inherited From:
- Source:
Returns:
true if the component has been effectively disabled, false otherwise- Type
- boolean
-
<protected> _LoadResources()
-
Called once during component creation to load resources.
- Inherited From:
- Source:
-
<protected> _NotifyAttached()
-
Notifies the component that its subtree has been connected to the document programmatically after the component has been created.
- Inherited From:
- Source:
-
<protected> _NotifyContextMenuGesture(menu, event, eventType)
-
When the contextMenu option is set, this method is called when the user invokes the context menu via the default gestures: right-click, Press & Hold, and Shift-F10. Components should not call this method directly.
The default implementation simply calls this._OpenContextMenu(event, eventType). Overrides of this method should call that same method, perhaps with additional params, not menu.open().
This method may be overridden by components needing to do things like the following:
- Customize the launcher or position passed to _OpenContextMenu(). See that method for guidance on these customizations.
- Customize the menu contents. E.g. some components need to enable/disable built-in commands like Cut and Paste, based on state at launch time.
- Bail out in some cases. E.g. components with UX approval to use PressHoldRelease rather than Press & Hold can override this method
to say
if (eventType !== "touch") this._OpenContextMenu(event, eventType);
. When those components detect the alternate context menu gesture (e.g. PressHoldRelease), that separate listener should call this._OpenContextMenu(), not this method (_NotifyContextMenuGesture()
), and not menu.open().
Components needing to do per-launch setup like the above tasks should do so in an override of this method, not in a beforeOpen listener or an _OpenContextMenu() override. This is discussed more fully here.
Parameters:
Name Type Description menu
Object The JET Menu to open as a context menu. Always non- null
.event
Event What triggered the menu launch. Always non- null
.eventType
string "mouse", "touch", or "keyboard". Never null
.- Inherited From:
- Source:
-
<protected> _NotifyDetached()
-
Notifies the component that its subtree has been removed from the document programmatically after the component has been created.
- Inherited From:
- Source:
-
<protected> _NotifyHidden()
-
Notifies the component that its subtree has been made hidden programmatically after the component has been created.
- Inherited From:
- Source:
-
<protected> _NotifyShown()
-
Notifies the component that its subtree has been made visible programmatically after the component has been created.
- Inherited From:
- Source:
-
<protected> _OpenContextMenu(event, eventType, openOptions, submenuOpenOptions, shallow)
-
The only correct way for a component to open its context menu is by calling this method, not by calling Menu.open() or _NotifyContextMenuGesture(). This method should be called in two cases:
- This method is called by _NotifyContextMenuGesture() and its overrides. That method is called when the baseComponent detects the default context menu gestures: right-click, Press & Hold, and Shift-F10.
- Components with UX-approved support for alternate context menu gestures like PressHoldRelease should call this method directly when those gestures are detected.
Components needing to customize how the context menu is launched, or do any per-launch setup, should do so in the caller of this method, (which is one of the two callers listed above), often by customizing the params passed to this method (
_OpenContextMenu
) per the guidance below. This setup should not be done in the following ways:- Components should not perform setup in a beforeOpen listener, as this can cause a race
condition where behavior depends on who got their listener registered first: the component or the app. The only correct component use
of a
beforeOpen
listener is when there's a need to detect whether something else launched the menu. - Components should not override this method (
_OpenContextMenu
), as this method is final. Instead, customize the params that are passed to it.
Guidance on setting OpenOptions fields:
Launcher:
Depending on individual component needs, any focusable element within the component can be the appropriate launcher for this launch.
Browser focus returns to the launcher on menu dismissal, so the launcher must at least be focusable. Typically a tabbable (not just focusable) element is safer, since it just focuses something the user could have focused on their own.
By default (i.e. if
openOptions
is not passed, or if it lacks alauncher
field), the component init node is used as the launcher for this launch. If that is not focusable or is suboptimal for a given component, that component should pass something else. E.g. components with a "roving tabstop" (like Toolbar) should typically choose the current tabstop as their launcher.The :focusable and :tabbable selectors may come in handy for choosing a launcher, e.g. something like
this.widget().find(".my-class:tabbable").first()
.Position:
By default, this method applies positioning that differs from Menu's default in the following ways: (The specific settings are subject to change.)
- For mouse and touch events, the menu is positioned relative to the event, not the launcher.
- For touch events,
"my"
is set to"start>40 center"
, to avoid having the context menu obscured by the user's finger.
Usually, if
position
needs to be customized at all, the only thing that needs changing is its"of"
field, and only for keyboard launches (since mouse/touch launches should almost certainly keep the default"event"
positioning). This situation arises anytime the element relative to which the menu should be positioned for keyboard launches is different than thelauncher
element (the element to which focus should be returned upon dismissal). For this case,{ "position": {"of": eventType==="keyboard" ? someElement : "event"} }
can be passed as theopenOptions
param.Be careful not to clobber useful defaults by specifying too much. E.g. if you only want to customize
"of"
, don't pass other fields like"my"
, since your value will be used for all modalities (mouse, touch, keyboard), replacing the modality-specific defaults that are usually correct. Likewise, don't forget theeventType==="keyboard"
check if you only want to customize"of"
for keyboard launches.InitialFocus:
This method forces initialFocus to
"menu"
for this launch, so the caller needn't specify it.Parameters:
Name Type Argument Description event
Event What triggered the context menu launch. Must be non- null
.eventType
string "mouse", "touch", or "keyboard". Must be non- null
. Passed explicitly since caller knows what it's listening for, and since events likecontextmenu
andclick
can be generated by various input modalities, making it potentially error-prone for this method to determine how they were generated.openOptions
Object <optional>
Options to merge with this method's defaults, which are discussed above. The result will be passed to Menu.open(). May be null
or omitted. See also theshallow
param.submenuOpenOptions
Object <optional>
Options to be passed through to Menu.open(). May be null
or omitted.shallow
boolean <optional>
Whether to perform a deep or shallow merge of openOptions
with this method's default value. The default and most commonly correct / useful value isfalse
.- If
true
, a shallow merge is performed, meaning that the caller'sposition
object, if passed, will completely replace this method's defaultposition
object. - If
false
or omitted, a deep merge is performed. For example, if the caller wishes to tweakposition.of
while keeping this method's defaults forposition.my
,position.at
, etc., it can pass{"of": anOfValue}
as theposition
value.
The
shallow
param is n/a forsubmenuOpenOptions
, since this method doesn't apply any defaults to that. (It's a direct pass-through.)- Inherited From:
- Source:
-
<protected> _ProcessStyles()
-
Create dummy divs for style classes and merge style class values with json . options object
- Inherited From:
- Source:
-
<protected> _Render(isResize)
-
Called to render the component at the current size.
Parameters:
Name Type Description isResize
boolean (optional) Whether it is a resize rerender. - Inherited From:
- Source:
-
<protected> _RestoreAllAttributes()
-
Restores all the element's attributes which were saved in _SaveAllAttributes. This method is final in JET.
If a subclass wants to save/restore all attributes on create/destroy, then the subclass can override _SaveAttributes and call _SaveAllAttributes and also override _RestoreAttributes and call _RestoreAllAttributes.
- Inherited From:
- Source:
-
<protected> _RestoreAttributes()
-
Restore the attributes saved in _SaveAttributes.
_SaveAttributes is called during _create. And _RestoreAttributes is called during _destroy.
This base class default implementation does nothing.
We also have _SaveAllAttributes and _RestoreAllAttributes methods that save and restore all the attributes on an element. Component subclasses can opt into these _SaveAllAttributes/_RestoreAllAttributes implementations by overriding _SaveAttributes and _RestoreAttributes to call _SaveAllAttributes/_RestoreAllAttributes. If the subclass wants a different implementation (like save only the 'class' attribute), it can provide the implementation itself in _SaveAttributes/_GetSavedAttributes/_RestoreAttributes.
- Inherited From:
- Source:
-
<protected> _SaveAllAttributes(element)
-
Saves all the element's attributes within an internal variable. _RestoreAllAttributes will restore the attributes from this internal variable.
This method is final in JET. Subclasses can override _RestoreAttributes and call _RestoreAllAttributes.
The JSON variable will be held as:
[ { "element" : element[i], "attributes" : { attributes[m]["name"] : {"attr": attributes[m]["value"], "prop": $(element[i]).prop(attributes[m]["name"]) } } ]
Parameters:
Name Type Description element
Object jQuery selection to save attributes for - Inherited From:
- Source:
-
<protected> _SaveAttributes(element)
-
Saves the element's attributes. This is called during _create. _RestoreAttributes will restore all these attributes and is called during _destroy.
This base class default implementation does nothing.
We also have _SaveAllAttributes and _RestoreAllAttributes methods that save and restore all the attributes on an element. Component subclasses can opt into these _SaveAllAttributes/_RestoreAllAttributes implementations by overriding _SaveAttributes and _RestoreAttributes to call _SaveAllAttributes/_RestoreAllAttributes. If the subclass wants a different implementation (like save only the 'class' attribute), it can provide the implementation itself in _SaveAttributes/_RestoreAttributes.
Parameters:
Name Type Description element
Object jQuery selection to save attributes for - Inherited From:
- Source:
-
<protected> _SetRootAttributes()
-
Reads the
rootAttributes
option, and sets the root attributes on the component's root DOM element. See rootAttributes for the set of supported attributes and how they are handled.- Inherited From:
- Source:
Throws:
if unsupported attributes are supplied. -
<protected> _UnregisterChildNode()
-
Remove all listener references that were attached to the element which includes _activeable, _focusable and hoverable.
- Inherited From:
- Source:
-
<protected> _UserOptionChange(key, value, optionMetadata)
-
Sets an option change that was driven by user gesture. Used in conjunction with _setOption to ensure that the correct optionMetadata flag for writeback is set.
Parameters:
Name Type Description key
string The name of the option to set. value
Object The value to set for the option. optionMetadata
Object The optionMetadata for the optionChange event - Inherited From:
- Source: