Sets the value of dataCursorPosition property.
Specifies the position of the data cursor. Used for synchronizing data cursors across multiple charts. Null if the data cursor is not displayed.
The value to set for dataCursorPosition
Sets the value of hiddenCategories property.
An array of category strings used for filtering. Series or data items with any category matching an item in this array will be filtered.
The value to set for hiddenCategories
Sets the value of highlightedCategories property.
An array of category strings used for highlighting. Series or data items matching categories in this array will be highlighted.
The value to set for highlightedCategories
Gets the value of as property.
An alias for the '$current' context variable passed to slot content for the itemTemplate, seriesTemplate, or groupTemplate slots.
The value of as property.
Since 6.2.0. Set the alias directly on the template element using the data-oj-as attribute instead.
Gets the value of comboSeriesOrder property.
Specifies the series render order for combo charts. If set to 'seriesType', the combo chart rendering order between series types will follow a set z-ordering aimed at minimizing overlap: area and line with area series type in the background, then bar series, then line series in the foreground. Series within the same type are rendered in the order presented in the data. If set to 'data', series z-order follows the series order in the data. Note that, series-comparator can be used to change the series order in the data.
The value of comboSeriesOrder property.
Gets the value of dataCursorPosition property.
Specifies the position of the data cursor. Used for synchronizing data cursors across multiple charts. Null if the data cursor is not displayed.
The value of dataCursorPosition property.
Gets the value of drilling property.
Specifies whether drilling is enabled. Drillable objects will show a pointer cursor on hover and fire an ojDrill event on click (double click if selection is enabled). See the Help documentation for more information.
The value of drilling property.
Gets the value of groupComparator property.
A comparator function that determines the ordering of the chart groups when using a DataProvider. If undefined, the group will follow the order in which they are found in the data.
The value of groupComparator property.
Gets the value of groups property.
An array of strings identifying the group labels, or an array of objects specifying group labels and styles. See the Help documentation for more information.
The value of groups property.
Gets the value of hideAndShowBehavior property.
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.
The value of hideAndShowBehavior property.
Gets the value of initialZooming property.
Specifies whether automatic initial zooming is enabled. Only applies to bar, line, area, and combo charts with zoomAndScroll turned on. See the Help documentation for more information.
The value of initialZooming property.
Gets the value of multiSeriesDrilling property.
Specifies whether drilling on chart objects representing multiple series (e.g. other slice and legend item in pie charts) is enabled or not. Multiseries drill event is fired from the other slice and legend item of pieChart.
The value of multiSeriesDrilling property.
Gets the value of otherThreshold property.
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.
The value of otherThreshold property.
Get a named property value from this component. This function will wait for the application's busy context to complete before attempting to get the property value.
The name of the property
A Promise that yields a value for the named property.
Gets the value of seriesComparator property.
A comparator function that determines the ordering of the chart series when using a DataProvider. If undefined, the series will follow the order in which they are found in the data.
The value of seriesComparator property.
Gets the value of sorting property.
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.
The value of sorting property.
Gets the value of splitDualY property.
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".
The value of splitDualY property.
Gets the value of stackLabelProvider property.
A function that returns a custom stack label. The function takes a context argument, provided by the chart. See the Help documentation for more information.
The value of stackLabelProvider property.
Gets the value of styleDefaults property.
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.
The value of styleDefaults property.
Gets the value of timeAxisType property.
The type of time axis to display in the chart. Time axis is only supported for Cartesian bar, line, area, stock, box plot, and combo charts. See the Help documentation for more information.
The value of timeAxisType property.
Gets the value of touchResponse property.
Specifies configuration options for touch and hold delays on mobile devices. See the Help documentation for more information.
The value of touchResponse property.
Since 18.0.0. This attribute is deprecated and no longer recommended in the Redwood Design system. The "auto" value behavior will be applied instead.
Gets the value of trackResize property.
Defines whether the element will automatically render in response to changes in size. See the Help documentation for more information.
The value of trackResize property.
Since 20.0.0. The trackResize property is deprecated. By default, the chart will automatically re-render in response to changes to its size.
Gets the value of translations property.
A collection of translated resources from the translation bundle, or null if this component has no resources.
The value of translations property.
Gets the value of valueFormats property.
An object specifying value formatting and tooltip behavior, whose keys generally correspond to the attribute names on the data items.
The value of valueFormats property.
Protected hasCreate a wait condition that is satisfied when the element's DOM has a non-zero size.
The Condition to be used with driver.wait() that's satisfied when the element's DOM has a non-zero size.
Since 11.0.0. Call the appropriate WebElement method to test the size of the element.
Protected hasCreate a wait condition that is satisfid when the element is visible. The condition is satisfied when the element is displayed, as reported by #isDisplayed, and is scrolled into view. This is method is deprecated. Use WebElement.isDisplayed instead to test the display of the element, and scroll it into view if necessary.
Protected setSet a property value on the remote element. This function first waits for the BusyContext to clear before setting the property, then after setting, waits again to ensure that no additional busy states were created due to the property setting.
The property name to set
The value to set for the property
A Promise which resolves when the remote property has been set to the value. Any value returned from the call to set the remote property is returned in the Promise.
Returns a Promise that is resolved when the application's busy state reports ready. This method checks only that the application's busy context is ready, and not that the DOM element is actually displayed or has a physical size, such as is the case with #whenReady. Operations which are read-only in nature should call this method prior to execution.
A Promise which is resolved when the page's busy state is ready.
Returns a Promise that is resolved when the element is ready for interaction--it is visible, has a size, and the app's busy context is ready. Operations on the DOM which rely on its physical location and size to be in a "ready" state should use this command, such as clicking, sending keys, locating child elements, and so on.
A Promise that's resolved when all conditions are met.
Generated using TypeDoc
The component WebElement for oj-chart. Do not instantiate this class directly, instead, use ojChart.
Migration
oj-chart is being broken down into multiple core pack chart components. When you migrate a page from using oj-chart to new core pack chart components oj-c-line-chart, oj-c-area-chart, etc you will also need to migrate your WebDriver tests from OjChart to, LineChartWebElement, AreaChartWebElement, etc. To do that you will need to revise type and locator instances as follows Type: from OjChart to LineChartWebElement Locator: from ojChart to findLineChart For more details on migrating from legacy to core pack please see component's migration section