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: Aggregation type used for the gauge.
Must be one of the values allowed by Web, excluding "no.
axisLabelsSymbol
Type: undefined | Web
Description: Axis labels text symbol (font, color, style).
axisLinesSymbol
Type: undefined | I
Description: Axis lines symbol (line width, style, color).
axisTickVisibility
Type: boolean
Description: Whether axis ticks are visible.
backgroundColor
Type: undefined | Color
Description: The background color of the chart.
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.
config
Type: Chart
Description: The current chart configuration object.
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.
endAngle
Type: number
Description: End angle of the gauge.
featureIndex
Type: undefined | null | number
Description: Gets the index of the feature to be rendered.
fetchNULLValues
Type: boolean
Description: Whether to fetch null values for them to be counted or displayed as categories on the chart.
field
Type: string
Description: Data field used for the gauge.
gaugeSubType
Type: Gauge
Description: Type of Gauge chart, like FeatureGauge and StatisticGauge.
guideLabelsSymbol
Type: undefined | Web
Description: The guide labels text symbol (font, color, style).
innerLabelContent
Type: undefined | Web
Description: Content symbol for the inner label.
innerLabelVisible
Type: boolean
Description: Whether the inner label is visible.
innerRadius
Type: number
Description: Inner radius of the gauge.
labelsIncrement
Type: undefined | number
Description: Labels increment for the gauge.
layer
Type: undefined | Supported
Description: The associated layer.
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.
needleDisplayPin
Type: boolean
Description: Whether to display the pin for the gauge's needle.
needleEndWidth
Type: undefined | null | number
Description: End width of the gauge's needle.
needleInnerRadius
Type: undefined | null | number
Description: Inner radius of the gauge's needle.
needleStartWidth
Type: undefined | null | number
Description: Start width of the gauge's needle.
needleSymbol
Type: undefined | I
Description: Symbol of the gauge's needle.
needleVisibility
Type: boolean
Description: Visibility of the gauge's needle.
onlyShowFirstAndLastLabels
Type: boolean
Description: Whether to only show the first and last axis labels.
seriesLength
Type: number
Description: The length of the series array.
splitByValues
Type: string[]
Description: The split-by values for the chart.
startAngle
Type: number
Description: Start angle of the gauge.
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.
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.
valueConversion
Type: undefined | Value
Description: Conversion to apply to the gauge value.
version
Type: undefined | string
Description: The version of the chart configuration.
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
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
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 from the current config.
Returns: string
getDataFilters
Signature: get
Description: Gets the data filter for the bar chart.
Returns: undefined | Web
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
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
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
getSeriesVisibility
Signature: get
Description: Gets the visibility of a series.
Parameters:
series– The series indexIndex : number
Returns: boolean
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
getXGuidesLength
Signature: get
Description: Gets the number guides in the X-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
removeFeatureIndex
Signature: remove
Description: Removes the existing feature index from the config object
Returns: void
setDataFilters
Signature: set
Description: Shared method for all chart types.
Parameters:
new– No description.Data Filters : undefined | Web Chart Data Filters
Returns: Promise
Async: This method is async and must be awaited.
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
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
setSeriesVisibility
Signature: set
Description: Sets the visibility of a series.
Parameters:
props– No description.: Legend Item Visibility
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.