Properties
dataStore
Type: any
Description: Data store object that can be used to store any data needed for the chart.
Default: {}
setupFinished
Type: Promise
Description: Promise that resolves when the setup process is complete.
Note: This promise does not need to be awaited if the setup method has already been awaited. It is simply provided as a way to await the setup process from other functions if needed to avoid race conditions.
Default: ...
aggregationType
Type: Web
Description: The aggregation type for the bar chart. Must be one of the values allowed by Web.
axisLabelsSymbol
Type: undefined | Web
Description: Axis labels text symbol (font, color, style).
axisLinesSymbol
Type: undefined | I
Description: Axis lines symbol (line width, style, color).
backgroundColor
Type: undefined | Color
Description: The background color of the chart.
binTemporalData
Type: boolean
Description: Whether temporal binning is enabled for all series in the config.
Note: Setting this prop removes any existing temporal binning settings if value is set to false.
chartId
Type: undefined | string
Description: The chart ID.
chartRenderer
Type: any
Description: The chart renderer.
chartSubtitleVisibility
Type: boolean
Description: Whether or not the chart subtitle is visible.true: Chart subtitle is visible.false: Chart subtitle is hidden.
Note: Even if the subtitle is visible, it may not be displayed if the subtitle text is empty.
chartSubType
Type: Chart
Description: The chart sub type of the series.
chartTitleVisibility
Type: boolean
Description: Whether or not the chart title is visible.true: Chart title is visible.false: Chart title is hidden.
Note: Even if the title is visible, it may not be displayed if the title text is empty.
chartType
Type: Chart
Description: The chart type.
colorMatch
Type: boolean
Description: Whether the chart should attempt to match the data source's colors.true: Attempt to match the data source's colors.false: Use the colors defined in the config.
config
Type: Chart
Description: The current chart configuration object.
cursorCrosshair
Type: undefined | Web
Description: Cursor crosshair from the chart config.
Note: To set the cursor crosshair for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the set method to assign a series to the second Y-axis.
cursorCrosshairHorizontalLineVisibility
Type: boolean
Description: Visibility of the horizontal line of the cursor's crosshair.
cursorCrosshairStyle
Type: undefined | I
Description: Style of the cursor's crosshair from the chart config.
Note: To set the cursor crosshair style for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the set method to assign a series to the second Y-axis.
cursorCrosshairVerticalLineVisibility
Type: boolean
Description: Visibility of the vertical line of the cursor's crosshair.
dataLabelsSymbol
Type: undefined | Web
Description: Data labels text symbol (font, color, style).
dataLabelsVisibility
Type: boolean
Description: Whether data labels are visible.
true: visible, false: hidden.
descriptionSymbol
Type: undefined | Web
Description: The description text symbol. Contains styling information such as font, color, and symbol style.
descriptionText
Type: string
Description: The chart description text.
descriptionVisibility
Type: boolean
Description: Whether or not the chart description is visible.true: Description is visible.false: Description is hidden.
Note: Even if the description is visible, it may not be displayed if the description text is empty.
fetchNULLValues
Type: boolean
Description: Whether to fetch null values for them to be counted or displayed as categories on the chart.
guideLabelsSymbol
Type: undefined | Web
Description: The guide labels text symbol (font, color, style).
layer
Type: undefined | Supported
Description: The associated layer.
legendMaxHeight
Type: undefined | number
Description: Maximum legend height.
legendPosition
Type: Web
Description: Legend position: top, bottom, left, or right.
legendRoundMarker
Type: boolean
Description: Whether legend markers are rounded.
legendTextSymbol
Type: undefined | Web
Description: Legend item text symbol (font, color, style).
legendTitleSymbol
Type: undefined | Web
Description: Legend title text symbol (font, color, style).
legendTitleText
Type: string
Description: The legend title text.
legendTitleVisibility
Type: boolean
Description: Whether the legend title is visible.true: Legend title is visible.false: Legend title is hidden.
legendVisibility
Type: boolean
Description: Whether the legend title is visible.true: Legend title is visible.false: Legend title is hidden.
maxXBound
Type: null | number
Description: Maximum bound set for the x-axis. Null indicates no explicit maximum.
minXBound
Type: null | number
Description: Minimum bound set for the x-axis. Null indicates no explicit minimum.
nullCategory
Type: undefined | Web
Description: The null category configuration of the bar chart.
nullPolicy
Type: undefined | Web
Description: Policy which tells the chart how to handle null values.null: Break the bar where null values are present.zero: Treats null values as zero.interpolate: Bar series: same effect as null - Line series: connects the lines across null values.
numericFields
Type: string | string[]
Description: The numeric fields array for the chart.
orderByList
Type: string[]
Description: The list of custom sort values for custom sort
rotatedState
Type: boolean
Description: Whether the chart is rotated.
seriesLength
Type: number
Description: The length of the series array.
splitByField
Type: string
Description: The split-by field for the chart.
splitByValues
Type: string[]
Description: The split-by values for the chart.
stackedType
Type: undefined | Web
Description: How the bars/lines should be placed when multiple series are rendered in the same chart, say when "split by" operation is executed on any field or
when multiple attributes/fields corresponding to the same set of classes are to be visualized.
Currently this property is only used for bar and line series.
subtitleSymbol
Type: undefined | Web
Description: The subtitle text symbol. Contains styling information such as font, color, and symbol style.
subtitleText
Type: string
Description: The chart subtitle text.
temporalBinningSize
Type: undefined | number
Description: Time interval size for a temporal bar/line chart.
temporalBinningUnit
Type: undefined | Web
Description: Time interval units for a temporal bar/line chart.
timeAggregationType
Type: undefined | Web
Description: Time aggregation type for a temporal bar/line chart.
titleSymbol
Type: undefined | Web
Description: The title text symbol. Contains styling information such as font, color, and symbol style.
titleText
Type: string
Description: The chart title text.
trimIncompleteTimeInterval
Type: undefined | boolean
Description: Whether to trim incomplete time intervals for a temporal bar/line chart.
version
Type: undefined | string
Description: The version of the chart configuration.
xAxisField
Type: string
Description: The x-axis field for the chart.
xAxisTitleSymbol
Type: undefined | Web
Description: X-axis title text symbol (font, color, style).
xAxisTitleText
Type: string
Description: The x-axis title text.
xAxisTitleVisibility
Type: boolean
Description: Whether the x-axis title is visible.
true: X-axis title is visible.
false: X-axis title is hidden.
Methods
addXAxisGuide
Signature: add
Description: Adds an X-axis guide.
Parameters:
name– The name of the guide.: string - Optional
index– The index to insert the new guide in the list of X-axis guides. If left: number undefined, the guide is appended to the end of the list.
Returns: void
addYAxisGuide
Signature: add
Description: Adds a Y-axis guide.
Parameters:
name– The name of the guide.: string - Optional
index– The index to insert the new guide in the list of Y-axis guides. If left: number undefined, the guide is appended to the end of the list.
Returns: void
deleteXAxisGuide
Signature: delete
Description: Deletes an X-axis guide.
Parameters:
- Optional
index– The index of the guide to delete in the list of X-axis guides. If left: number undefined, the last guide in the list is deleted.
Returns: void
deleteYAxisGuide
Signature: delete
Description: Deletes a Y-axis guide.
Parameters:
- Optional
index– The index of the guide to delete in the list of Y-axis guides. If left: number undefined, the last guide in the list is deleted.
Returns: void
generateChartTitle
Signature: generate
Description: Generate the proper chart title given the current config.
Returns: string
generateXAxisTitle
Signature: generate
Description: Generate the proper x-axis title given the current config.
Returns: string
generateYAxisTitle
Signature: generate
Description: Generate the proper y-axis title given the current config.
Returns: string
getAssignToSecondValueAxis
Signature: get
Description: Gets whether the series should be assigned to the second value axis.
Parameters:
series– The index of the series.Index : number
Returns: boolean
getAxisScrollbar
Signature: get
Description: Gets the scrollbar configuration for the specified axis.
Parameters:
axis– The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).Index : number
Returns: undefined | Web
getAxisTitleSymbol
Signature: get
Description: Gets the specified title text symbol. Contains styling information such as font, color, and symbol style.
Parameters:
axis– No description.Index : number
Returns: undefined | Web
getAxisTitleText
Signature: get
Description: Gets the title text of the specified axis.
Parameters:
axis– The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).Index : number
Returns: string
getAxisTitleVisibility
Signature: get
Description: Gets the visibility of the specified axis title.
Parameters:
axis– The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).Index : number
Returns: boolean
getAxisValueFormat
Signature: get
Description: Gets the value format for the specified axis.
Parameters:
axis– The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).Index : number
Returns: undefined | Number
getBuffer
Signature: get
Description: Gets the buffer setting for the specified axis.
Parameters:
axis– The index of the axisIndex : number
Returns: boolean
getCustomSortValues
Signature: get
Description: Gets the list of the category values for the chart.
Returns: Promise
Async: This method is async and must be awaited.
getDataFilters
Signature: get
Description: Gets the data filter for the bar chart.
Returns: undefined | Web
getDataTooltipReverseColor
Signature: get
Description: Gets the setting of the data property.
Parameters:
- Optional
series– The index of the series.Index : number
Returns: boolean
getDataTooltipValueFormat
Signature: get
Description: Gets the data tooltip value format for a series.
If the series index is out of bounds or the series list is empty, this function will return undefined.
Parameters:
series– The index of the series to retrieve the value format for.Index : number
Returns: undefined | Number
getDataTooltipVisibility
Signature: get
Description: Gets the visibility of the data tooltips.
Parameters:
- Optional
series– The index of the series.Index : number
Returns: boolean
getDefaultXAxisTitleText
Signature: get
Description: Get the default x-axis title text.
Returns: Promise
Async: This method is async and must be awaited.
getDisplayCursorTooltip
Signature: get
Description: Gets the display cursor tooltip setting for the specified axis.
Parameters:
axis– The index of the axis to get the display cursor tooltip for.Index : number
Returns: boolean
getDisplayZeroLine
Signature: get
Description: Gets the display zero line setting for the specified axis.
Parameters:
axis– The index of the axis to get the display zero line for.Index : number
Returns: boolean
getGridLinesSymbol
Signature: get
Description: Gets the grid lines symbol. Contains styling information such as line width, line style, and line color.
Returns: undefined | I
getGuideAbove
Signature: get
Description: Gets whether the guide should be rendered above the other chart elements.
Parameters:
- Optional
index– Default: number 0. The index of the guide in the list of guides for the given axis orientation. - Optional
orientation– Default: Guide Orientation y. The axis orientation of the guide.
Returns: boolean
getGuideEnd
Signature: get
Description: Gets the end value of a guide.
Parameters:
- Optional
index– Default: number 0. The index of the guide in the list of guides for the given axis orientation. - Optional
orientation– Default: Guide Orientation y. The axis orientation of the guide.
Returns: undefined | null | string | number | Date
getGuideLabelText
Signature: get
Description: Gets the guide label text.
Parameters:
- Optional
index– Default: number 0. The index of the guide in the list of guides for the given axis orientation. - Optional
orientation– Default: Guide Orientation y. The axis orientation of the guide.
Returns: undefined | string
getGuideName
Signature: get
Description: Gets the name of a guide.
Parameters:
- Optional
index– Default: number 0. The index of the guide in the list of guides for the given axis orientation. - Optional
orientation– Default: Guide Orientation y. The axis orientation of the guide.
Returns: undefined | string
getGuideStart
Signature: get
Description: Gets the start value of a guide.
Parameters:
- Optional
index– Default: number 0. The index of the guide in the list of guides for the given axis orientation. - Optional
orientation– Default: Guide Orientation y. The axis orientation of the guide.
Returns: null | string | number | Date
getGuideStyle
Signature: get
Description: Gets the guide style.
Parameters:
- Optional
index– Default: number 0. The index of the guide in the list of guides for the given axis orientation. - Optional
orientation– Default: Guide Orientation y. The axis orientation of the guide.
Returns: undefined | I
getGuideVisibility
Signature: get
Description: Gets whether a guide is visible.
Parameters:
- Optional
index– Default: number 0. The index of the guide in the list of guides for the given axis orientation. - Optional
orientation– Default: Guide Orientation y. The axis orientation of the guide.
Returns: boolean
getHorizontalAxisLabelsBehavior
Signature: get
Description: Gets the horizontal axis labels behavior for the chart.
Returns: Web
getIntegerOnlyValues
Signature: get
Description: Gets the integer only values setting for the specified axis.
Parameters:
axis– The index of the axisIndex : number
Returns: boolean
getLogarithmic
Signature: get
Description: Gets whether logarithmic scale is enabled for the specified axis.
Parameters:
axis– The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).Index : number true: Logarithmic scale is enabled for the specified axis.false: Logarithmic scale is disabled for the specified axis.
Returns: boolean
getMaxBound
Signature: get
Description: Gets the maximum bound for the specified axis.
Parameters:
axis– The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).Index : number
Returns: number
getMinBound
Signature: get
Description: Gets the minimum bound for the specified axis.
Parameters:
axis– The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).Index : number
Returns: number
getOrderOfSeries
Signature: get
Description: Gets the order of the series array by returning an array of series ids.
Returns: string[]
getSeriesColor
Signature: get
Description: Gets the color of the series based on the series index. If the index is out of bounds, it will return undefined.
Parameters:
series– The index of the series.Index : number
Returns: undefined | Color
getSeriesHideOversizedSideBySideLabels
Signature: get
Description: Gets whether to hide oversized data labels of the side-by-side series based on the series index. If the index is out of bounds, it will return undefined.
Parameters:
series– The index of the series.Index : number
Returns: undefined | boolean
getSeriesHideOversizedStackedLabels
Signature: get
Description: Gets whether to hide oversized stacked labels of the series based on the series index. If the index is out of bounds, it will return undefined.
Parameters:
series– The index of the series.Index : number
Returns: undefined | boolean
getSeriesId
Signature: get
Description: Gets the series ID for a given series index.
If the series index is out of bounds, this function will return undefined.
Parameters:
series– The index of the series.Index : number
Returns: undefined | string
getSeriesIndex
Signature: get
Description: Gets the series index for a given series ID.
If the series ID is not found, this function will return undefined.
Parameters:
series– No description.Id : string
Returns: undefined | number
getSeriesName
Signature: get
Description: Gets the name of the series based on the series index.
If the index is out of bounds, it will return undefined.
Parameters:
series– The index of the series.Index : number
Returns: undefined | string
getSeriesVisibility
Signature: get
Description: Gets the visibility of a series.
Parameters:
series– The series indexIndex : number
Returns: boolean
getSortOrder
Signature: get
Description: Gets the sort order for the bar chart.
Returns: Serial
getTickSpacing
Signature: get
Description: Gets the tick spacing setting for the specified axis.
Parameters:
axis– The index of the axisIndex : number
Returns: undefined | number
getTooltipReverseColor
Signature: get
Description: Gets whether the tooltip text color should be reversed for a guide.
Parameters:
index– The index of the guide in the list of guides for the given axis orientation.: number - Optional
orientation– The axis orientation of the guide.: Guide Orientation
Returns: boolean
getVerticalAxisLabelsBehavior
Signature: get
Description: Gets the vertical axis labels behavior for the chart.
Returns: Web
getXGuidesLength
Signature: get
Description: Gets the number guides in the X-axis guides list.
Returns: undefined | number
getYGuidesLength
Signature: get
Description: Gets the number guides in the Y-axis guides list.
Returns: undefined | number
isSameChartAs
Signature: is
Description: Checks if the current chart model is for the same chart as another chart model.
Parameters:
other– The other chart model to compare to.Model : undefined | Chart Model
Returns: boolean
moveCustomSortValuesInOrderByList
Signature: move
Description: Moves the custom sort values in-place for the order by list in the config.
Note: This method should be only used when the sort order is set to Serial.
Parameters:
from– The index to move the custom sort value from.Index : number to– The index to move the custom sort value to.Index : number
Returns: void
moveSeries
Signature: move
Description: Moves a series from one index in the series array to another.
Parameters:
from– Index to move the series from.Index : number to– Index to move the series to.Index : number
Returns: void
resetAvailable
Signature: reset
Description: Returns whether the series styling is able to be reset.
Returns: boolean
resetSeriesStyling
Signature: reset
Description: Resets the series styling to the default styling.
Returns: void
resetTimeInterval
Signature: reset
Description: Resets the time interval to default for a temporal line chart.
Returns: void
setAssignToSecondValueAxis
Signature: set
Description: Sets whether the series should be assigned to the second value axis.
Parameters:
assign– The value for the setting.: boolean series– The index of the series.Index : number
Returns: void
setAxisScrollbar
Signature: set
Description: Sets the scrollbar configuration for the specified axis.
Note: The scrollbar configuration for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the set method to assign a series to the second Y-axis.
Parameters:
scrollbar– The scrollbar configuration to set.: Web Chart Axis Scroll Bar axis– The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).Index : number
Returns: void
setAxisTitleSymbol
Signature: set
Description: Sets the title text symbol for the specified axis. Contains styling information such as font, color, and symbol style.
Note: The title text symbol for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the set method to assign a series to the second Y-axis.
Parameters:
title– The title text symbol to set.Symbol : undefined | Web Chart Text Symbol axis– The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).Index : number
Returns: void
setAxisTitleText
Signature: set
Description: Sets the title text for the specified axis.
Note: The title text for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the set method to assign a series to the second Y-axis.
Parameters:
title– The title text for the axis.Text : string axis– The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).Index : number
Returns: void
setAxisTitleVisibility
Signature: set
Description: Sets the visibility of the specified axis title.
Note: The title visibility for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the set method to assign a series to the second Y-axis.
Parameters:
is– The visibility state for the axis title.Visible : boolean axis– The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).Index : number
Returns: void
setAxisValueFormat
Signature: set
Description: Sets the value format for the specified axis.
Note: The value format for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the set method to assign a series to the second Y-axis.
Parameters:
axis– The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).Index : number - Optional
value– The value format to set.Format : Number Format Options | Date Time Format Options | Category Format Options
Returns: void
setBuffer
Signature: set
Description: Sets the buffer for the specified axis.
Parameters:
buffer– The setting for the buffer: boolean axis– The index of the axisIndex : number
Returns: void
setDataFilters
Signature: set
Description: Sets the data filter for the bar chart.
Parameters:
new– The new data filter.Data Filter : undefined | Web Chart Data Filters
Returns: Promise
Async: This method is async and must be awaited.
setDataTooltipReverseColor
Signature: set
Description: Sets the setting of the data property.
Parameters:
reverse– Indicator of whether to reverse the color.Color : boolean - Optional
series– The index of the series to set the reverse color.Index : number
Returns: void
setDataTooltipValueFormat
Signature: set
Description: Sets the data tooltip value format for a series.
Parameters:
series– The index of the series to set the value format for.Index : number value– The value format to set.Format : undefined | Number Format Options
Returns: void
setDataTooltipVisibility
Signature: set
Description: Sets the visibility of the data tooltips.
Parameters:
visibility– The visibility of the data tooltips.: boolean - Optional
series– The index of the series to set the visibility.Index : number
Returns: void
setDisplayCursorTooltip
Signature: set
Description: Sets the display cursor tooltip setting for the specified axis.
Parameters:
display– The display cursor tooltip setting for the axis.Cursor Tooltip : boolean axis– The index of the axis to set the display cursor tooltip for.Index : number
Returns: void
setDisplayZeroLine
Signature: set
Description: Sets the display zero line setting for the specified axis.
Parameters:
display– The display zero line setting for the axis.Zero Line : boolean axis– The index of the axis to set the display zero line for.Index : number
Returns: void
setGridLinesSymbol
Signature: set
Description: Sets the grid lines symbol. Contains styling information such as line width, line style, and line color.
Note: To set the grid lines symbol for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the set method to assign a series to the second Y-axis.
Parameters:
lines– The grid lines symbol.Symbol : undefined | I Simple Line Symbol - Optional
axis– The indices of the axes to set the grid lines symbol for.Indices : number[]
Returns: void
setGuideAbove
Signature: set
Description: Sets whether the guide should be rendered above the other chart elements.
Parameters:
above– New above boolean to set.: boolean - Optional
index– Default: number 0. The index of the guide in the list of guides for the given axis orientation. - Optional
orientation– Default: Guide Orientation y. The axis orientation of the guide.
Returns: void
setGuideEnd
Signature: set
Description: Sets the end value of a guide.
Parameters:
end– New end value to set.: undefined | null | string | number | Date - Optional
index– Default: number 0. The index of the guide in the list of guides for the given axis orientation. - Optional
orientation– Default: Guide Orientation y. The axis orientation of the guide.
Returns: void
setGuideLabelText
Signature: set
Description: Sets the guide label text.
Parameters:
label– New label text to set.Text : string - Optional
index– Default: number 0. The index of the guide in the list of guides for the given axis orientation. - Optional
orientation– Default: Guide Orientation y. The axis orientation of the guide.
Returns: void
setGuideName
Signature: set
Description: Sets the name of a guide.
Parameters:
name– New name to set.: string - Optional
index– Default: number 0. The index of the guide in the list of guides for the given axis orientation. - Optional
orientation– Default: Guide Orientation y. The axis orientation of the guide.
Returns: void
setGuideStart
Signature: set
Description: Sets the start value of a guide.
Parameters:
start– New start value to set.: null | string | number | Date - Optional
index– Default: number 0. The index of the guide in the list of guides for the given axis orientation. - Optional
orientation– Default: Guide Orientation y. The axis orientation of the guide.
Returns: void
setGuideStyle
Signature: set
Description: Sets the guide style.
Parameters:
style– New style to set.: I Simple Line Symbol | I Simple Fill Symbol - Optional
index– Default: number 0. The index of the guide in the list of guides for the given axis orientation. - Optional
orientation– Default: Guide Orientation y. The axis orientation of the guide.
Returns: void
setGuideVisibility
Signature: set
Description: Sets whether a guide is visible
Parameters:
visible– New visibility to set.: boolean - Optional
index– Default: number 0. The index of the guide in the list of guides for the given axis orientation. - Optional
orientation– Default: Guide Orientation y. The axis orientation of the guide.
Returns: void
setHorizontalAxisLabelsBehavior
Signature: set
Description: Sets the horizontal axis labels behavior for the chart.
Note: The horizontal axis labels behavior for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the set method to assign a series to the second Y-axis.
Parameters:
horizontal– The behavior for the horizontal axis labels.Behavior : Web Chart Label Behavior
Returns: void
setIntegerOnlyValues
Signature: set
Description: Sets the integer only values setting for the specified axis.
Parameters:
integer– The boolean value to set for the integer only values settingOnly Values : boolean axis– The index of the axisIndex : number
Returns: void
setLogarithmic
Signature: set
Description: Sets whether logarithmic scale is enabled for the specified axis.true: Enable logarithmic scale for the specified axis.false: Disable logarithmic scale for the specified axis.
Note: The logarithmic scale for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the set method to assign a series to the second Y-axis.
Parameters:
is– Whether to enable logarithmic scale for the specified axis.Logarithmic : boolean axis– The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).Index : number
Returns: void
setMaxBound
Signature: set
Description: Sets the maximum bound for the specified axis.
Note: The maximum bound for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the set method to assign a series to the second Y-axis.
Parameters:
new– The value to set as the maximum bound.Max Bound : null | number axis– The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).Index : number
Returns: void
setMinBound
Signature: set
Description: Sets the minimum bound for the specified axis.
Note: The minimum bound for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the set method to assign a series to the second Y-axis.
Parameters:
new– The value to set as the minimum bound.Min Bound : null | number axis– The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).Index : number
Returns: void
setOrderOfSeries
Signature: set
Description: Sets the order of the series array by providing an array of series ids.
Parameters:
new– The new order of the series array.Order : string[]
Returns: void
setSeriesColor
Signature: set
Description: Sets the color of the series based on the series index.
Parameters:
new– The new color for the series.Color : undefined | Color series– The index of the series.Index : number
Returns: void
setSeriesHideOversizedSideBySideLabels
Signature: set
Description: Sets whether to hide oversized data labels of the side-by-side series based on the series index.
Parameters:
hide– The value for hiding oversized data labels.: undefined | boolean series– The index of the series.Index : number
Returns: void
setSeriesHideOversizedStackedLabels
Signature: set
Description: Sets whether to hide oversized stacked labels of the series based on the series index.
Parameters:
hide– The value for hiding oversized stacked labels.: undefined | boolean series– The index of the series.Index : number
Returns: void
setSeriesName
Signature: set
Description: Sets name of the series based on the series index.
Parameters:
name– The name for the series.: string series– The index of the series.Index : number
Returns: void
setSeriesVisibility
Signature: set
Description: Sets the visibility of a series.
Parameters:
props– No description.: Legend Item Visibility
Returns: void
setSortOrder
Signature: set
Description: Sets the sort order for the bar chart.
Parameters:
new– The new sort order.Sort Order : Serial Chart Data Sorting Kinds - Optional
order– The list of category's values to order by.By List : string[]
Returns: void
setTickSpacing
Signature: set
Description: Sets the tick spacing for the specified axis.
Parameters:
tick– The value to set for the tick spacingSpacing : number axis– The index of the axisIndex : number
Returns: void
setTooltipReverseColor
Signature: set
Description: Sets whether the tooltip text color should be reversed for a guide.
Parameters:
reverse– New reverseColor boolean to set.Color : boolean index– The index of the guide in the list of guides for the given axis orientation.: number - Optional
orientation– The axis orientation of the guide.: Guide Orientation
Returns: void
setup
Signature: setup(params
Description: Completes the async setup process for the chart model. Must be called before using the model.
Parameters:
params– The parameters to be used to set up the chart model.: Model Params
Returns: Promise
Async: This method is async and must be awaited.
setVerticalAxisLabelsBehavior
Signature: set
Description: Sets the vertical axis labels behavior for the chart.
Note: The vertical axis labels behavior for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the set method to assign a series to the second Y-axis.
Parameters:
vertical– The behavior for the vertical axis labels.Behavior : Web Chart Label Behavior
Returns: void
updateSeriesFromLayerFilter
Signature: update
Description: Updates the series based on the layer filter.
Returns: Promise
Async: This method is async and must be awaited.