Gauge Model

NameDescription
addXAxisGuide

Signature: addXAxisGuide(name: string, index: number): void
Description: Adds an X-axis guide.
Parameters:

  • name: string - The name of the guide.
  • Optional index: number - The index to insert the new guide in the list of X-axis guides. If left undefined, the guide is appended to the end of the list.
Returns: void

deleteXAxisGuide

Signature: deleteXAxisGuide(index: number): void
Description: Deletes an X-axis guide.
Parameters:

  • Optional index: number - The index of the guide to delete in the list of X-axis guides. If left undefined, the last guide in the list is deleted.
Returns: void

emitConfigUpdate

Signature: emitConfigUpdate(functionCalled: string): void
Description: Emits a config update event.
Parameters:

  • functionCalled: string - No description.
Returns: void

generateDefaultConfig

Signature: generateDefaultConfig(): Promise
Description: A function that generates the default config object when creating a new chart.
Returns: Promise
Async: This method is async and must be awaited for the changes to take effect.

getAggregationType

Signature: getAggregationType(): WebChartStatisticType
Description: Gets the aggregation type used for the gauge.
Returns: WebChartStatisticType

getAxisLabelsSymbol

Signature: getAxisLabelsSymbol(): undefined | WebChartTextSymbol
Description: Gets the axis labels text symbol. Contains styling information such as font, color, and symbol style.
Returns: undefined | WebChartTextSymbol

getAxisLinesSymbol

Signature: getAxisLinesSymbol(): undefined | ISimpleLineSymbol
Description: Gets the axis lines symbol. Contains styling information such as line width, line style, and line color.
Returns: undefined | ISimpleLineSymbol

getAxisTickVisibility

Signature: getAxisTickVisibility(): boolean
Description: Gets whether the axis ticks are visible.
Returns: boolean

getBackgroundColor

Signature: getBackgroundColor(): undefined | Color
Description: Gets the background color of the chart.
Returns: undefined | Color

getChartId

Signature: getChartId(): undefined | string
Description: Gets the chart id.
Returns: undefined | string

getChartRenderer

Signature: getChartRenderer(): any
Description: Gets the chart renderer.
Returns: any

getChartSubtitleVisibility

Signature: getChartSubtitleVisibility(): boolean
Description: Gets whether or not the chart subtitle is visible.true: Chart subtitle is visible.false: Chart subtitle is hidden.
Returns: boolean

getChartSubType

Signature: getChartSubType(): ChartSubType
Description: Gets the chart sub type of the series.
Returns: ChartSubType

getChartTitleVisibility

Signature: getChartTitleVisibility(): boolean
Description: Gets whether or not the chart title is visible.true: Chart title is visible.false: Chart title is hidden.
Returns: boolean

getChartType

Signature: getChartType(): ChartTypes
Description: Gets the chart type.
Returns: ChartTypes

getConfig

Signature: getConfig(): ChartConfig
Description: Gets the current chart configuration object.
Returns: ChartConfig

getDescriptionSymbol

Signature: getDescriptionSymbol(): undefined | WebChartTextSymbol
Description: Gets the description text symbol. Contains styling information such as font, color, and symbol style.
Returns: undefined | WebChartTextSymbol

getDescriptionText

Signature: getDescriptionText(): string
Description: Gets the chart description text.
Returns: string

getDescriptionVisibility

Signature: getDescriptionVisibility(): boolean
Description: Gets whether or not the chart description is visible.true: Description is visible.false: Description is hidden.
Returns: boolean

getEndAngle

Signature: getEndAngle(): number
Description: Gets the end angle of the gauge.
Returns: number

getFeatureIndex

Signature: getFeatureIndex(): undefined | number
Description: Gets the index of the feature to be rendered.
Returns: undefined | number

getFetchNULLValues

Signature: getFetchNULLValues(): boolean
Description: Gets whether to fetch null values for them to be counted or displayed as categories on the chart.
Returns: boolean

getField

Signature: getField(): string
Description: Gets the data field used for the gauge.
Returns: string

getGaugeSubType

Signature: getGaugeSubType(): GaugeChartSubTypes
Description: Gets the type of Gauge chart, like FeatureGauge and StatisticGauge.
Returns: GaugeChartSubTypes

getGuideAbove

Signature: getGuideAbove(index: number, orientation: GuideOrientation): boolean
Description: Gets whether the guide should be rendered above the other chart elements.
Parameters:

  • Optional index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.
  • Optional orientation: GuideOrientation - Default y. The axis orientation of the guide.
Returns: boolean

getGuideEnd

Signature: getGuideEnd(index: number, orientation: GuideOrientation): undefined | null | string | number | Date
Description: Gets the end value of a guide.
Parameters:

  • Optional index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.
  • Optional orientation: GuideOrientation - Default y. The axis orientation of the guide.
Returns: undefined | null | string | number | Date

getGuideLabelsSymbol

Signature: getGuideLabelsSymbol(): undefined | WebChartTextSymbol
Description: Gets the guide labels text symbol. Contains styling information such as font, color, and symbol style.
Returns: undefined | WebChartTextSymbol

getGuideLabelText

Signature: getGuideLabelText(index: number, orientation: GuideOrientation): undefined | string
Description: Gets the guide label text.
Parameters:

  • Optional index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.
  • Optional orientation: GuideOrientation - Default y. The axis orientation of the guide.
Returns: undefined | string

getGuideName

Signature: getGuideName(index: number, orientation: GuideOrientation): undefined | string
Description: Gets the name of a guide.
Parameters:

  • Optional index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.
  • Optional orientation: GuideOrientation - Default y. The axis orientation of the guide.
Returns: undefined | string

getGuideStart

Signature: getGuideStart(index: number, orientation: GuideOrientation): null | string | number | Date
Description: Gets the start value of a guide.
Parameters:

  • Optional index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.
  • Optional orientation: GuideOrientation - Default y. The axis orientation of the guide.
Returns: null | string | number | Date

getGuideStyle

Signature: getGuideStyle(index: number, orientation: GuideOrientation): undefined | ISimpleLineSymbol | ISimpleFillSymbol
Description: Gets the guide style.
Parameters:

  • Optional index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.
  • Optional orientation: GuideOrientation - Default y. The axis orientation of the guide.
Returns: undefined | ISimpleLineSymbol | ISimpleFillSymbol

getGuideVisibility

Signature: getGuideVisibility(index: number, orientation: GuideOrientation): boolean
Description: Gets whether a guide is visible.
Parameters:

  • Optional index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.
  • Optional orientation: GuideOrientation - Default y. The axis orientation of the guide.
Returns: boolean

getInnerLabelContent

Signature: getInnerLabelContent(): undefined | WebChartTextSymbol
Description: Gets the inner label content symbol.
Returns: undefined | WebChartTextSymbol

getInnerLabelVisible

Signature: getInnerLabelVisible(): boolean
Description: Gets whether the inner label is visible.
Returns: boolean

getInnerRadius

Signature: getInnerRadius(): number
Description: Gets the inner radius of the gauge.
Returns: number

getLabelsIncrement

Signature: getLabelsIncrement(): undefined | number
Description: Gets the labels increment for the gauge.
Returns: undefined | number

getLayer

Signature: getLayer(): undefined | SupportedLayer
Description: Gets the associated layer.
Returns: undefined | SupportedLayer

getMaxXBound

Signature: getMaxXBound(): null | number
Description: Gets the maximum bound that is currently set for the x-axis.
Returns: null | number

getMinXBound

Signature: getMinXBound(): null | number
Description: Gets the minimum bound that is currently set for the x-axis.
Returns: null | number

getNeedleDisplayPin

Signature: getNeedleDisplayPin(): boolean
Description: Gets whether to display the pin for the gauge's needle.
Returns: boolean

getNeedleEndWidth

Signature: getNeedleEndWidth(): undefined | null | number
Description: Gets the end width of the gauge's needle.
Returns: undefined | null | number

getNeedleInnerRadius

Signature: getNeedleInnerRadius(): undefined | null | number
Description: Gets the inner radius of the gauge's needle.
Returns: undefined | null | number

getNeedleStartWidth

Signature: getNeedleStartWidth(): undefined | null | number
Description: Gets the start width of the gauge's needle.
Returns: undefined | null | number

getNeedleSymbol

Signature: getNeedleSymbol(): undefined | ISimpleFillSymbol
Description: Gets the symbol of the gauge's needle.
Returns: undefined | ISimpleFillSymbol

getNeedleVisibility

Signature: getNeedleVisibility(): boolean
Description: Gets the visibility of the gauge's needle.
Returns: boolean

getOnlyShowFirstAndLastLabels

Signature: getOnlyShowFirstAndLastLabels(): boolean
Description: Gets whether to only show the first and last labels.
Returns: boolean

getSeriesId

Signature: getSeriesId(seriesIndex: number): undefined | string
Description: Gets the series ID for a given series index.If the series index is out of bounds, this function will return undefined.
Parameters:

  • seriesIndex: number - The index of the series.
Returns: undefined | string

getSeriesIndex

Signature: getSeriesIndex(seriesId: string): undefined | number
Description: Gets the series index for a given series ID.If the series ID is not found, this function will return undefined.
Parameters:

  • seriesId: string - No description.
Returns: undefined | number

getSeriesLength

Signature: getSeriesLength(): number
Description: Gets the length of the series array.
Returns: number

getSeriesVisibility

Signature: getSeriesVisibility(seriesIndex: number): boolean
Description: Gets the visibility of a series.
Parameters:

  • seriesIndex: number - The series index
Returns: boolean

getSplitByValues

Signature: getSplitByValues(): string[]
Description: Gets the split-by values for the chart.
Returns: string[]

getStartAngle

Signature: getStartAngle(): number
Description: Gets the start angle of the gauge.
Returns: number

getSubtitleSymbol

Signature: getSubtitleSymbol(): undefined | WebChartTextSymbol
Description: Gets the subtitle text symbol. Contains styling information such as font, color, and symbol style.
Returns: undefined | WebChartTextSymbol

getSubtitleText

Signature: getSubtitleText(): string
Description: Gets the chart subtitle text.
Returns: string

getTitleSymbol

Signature: getTitleSymbol(): undefined | WebChartTextSymbol
Description: Gets the title text symbol. Contains styling information such as font, color, and symbol style.
Returns: undefined | WebChartTextSymbol

getTitleText

Signature: getTitleText(): string
Description: Gets the chart title text.
Returns: string

getTooltipReverseColor

Signature: getTooltipReverseColor(index: number, orientation: GuideOrientation): boolean
Description: Gets whether the tooltip text color should be reversed for a guide.
Parameters:

  • index: number - The index of the guide in the list of guides for the given axis orientation.
  • Optional orientation: GuideOrientation - The axis orientation of the guide.
Returns: boolean

getValueConversion

Signature: getValueConversion(): undefined | ValueConversion
Description: Gets the conversion to apply to the gauge value
Returns: undefined | ValueConversion

getVersion

Signature: getVersion(): string
Description: Gets the version of the chart configuration.
Returns: string

getXAxisTitleSymbol

Signature: getXAxisTitleSymbol(): undefined | WebChartTextSymbol
Description: Gets the x-axis title text symbol. Contains styling information such as font, color, and symbol style.
Returns: undefined | WebChartTextSymbol

getXAxisTitleText

Signature: getXAxisTitleText(): string
Description: Gets the x-axis title text.
Returns: string

getXAxisTitleVisibility

Signature: getXAxisTitleVisibility(): boolean
Description: Gets whether the x-axis title is visible or not.true: X-axis title is visible.false: X-axis title is hidden.
Returns: boolean

getXGuidesLength

Signature: getXGuidesLength(): undefined | number
Description: Gets the number guides in the X-axis guides list.
Returns: undefined | number

isSameChartAs

Signature: isSameChartAs(otherModel: undefined | ChartModel): boolean
Description: Checks if the current chart model is for the same chart as another chart model.
Parameters:

  • otherModel: undefined | ChartModel - The other chart model to compare to.
Returns: boolean

loadConfigFromLayer

Signature: loadConfigFromLayer(params: ModelParams): Promise
Description: A function that loads the config based on the provided props.
Parameters:

  • params: ModelParams - No description.
Returns: Promise
Async: This method is async and must be awaited for the changes to take effect.

removeFeatureIndex

Signature: removeFeatureIndex(): void
Description: Removes the existing feature index from the config object
Returns: void

setAggregationType

Signature: setAggregationType(aggregationType: WebChartStatisticType): Promise
Description: Sets the aggregation type used for the gauge.
Parameters:

  • aggregationType: WebChartStatisticType - The aggregation type to set. Must be one of the values allowed by WebChartStatisticType, excluding "no_aggregation".
Returns: Promise
Async: This method is async and must be awaited for the changes to take effect.

setAxisLabelsSymbol

Signature: setAxisLabelsSymbol(newAxisLabelsSymbol: undefined | WebChartTextSymbol): void
Description: Sets the axis labels text symbol. Contains styling information such as font, color, and symbol style.
Parameters:

  • newAxisLabelsSymbol: undefined | WebChartTextSymbol - The new axis labels text symbol.
Returns: void

setAxisLinesSymbol

Signature: setAxisLinesSymbol(newAxisLinesSymbol: undefined | ISimpleLineSymbol): void
Description: Sets the axis lines symbol. Contains styling information such as line width, line style, and line color.
Parameters:

  • newAxisLinesSymbol: undefined | ISimpleLineSymbol - The new axis lines symbol.
Returns: void

setAxisTickVisibility

Signature: setAxisTickVisibility(visibile: boolean): void
Description: Sets whether the axis ticks are visible.
Parameters:

  • visibile: boolean - The visibility state to set.
Returns: void

setBackgroundColor

Signature: setBackgroundColor(backgroundColor: undefined | Color): void
Description: Sets the background color of the chart.
Parameters:

  • backgroundColor: undefined | Color - The background color.
Returns: void

setChartId

Signature: setChartId(id: string): void
Description: Sets the chart id.
Parameters:

  • id: string - No description.
Returns: void

setChartRenderer

Signature: setChartRenderer(renderer: any): void
Description: Sets the chart renderer.
Parameters:

  • renderer: any - The chart renderer to set.
Returns: void

setChartSubtitleVisibility

Signature: setChartSubtitleVisibility(visibility: boolean): void
Description: Sets whether or not the chart subtitle is visible.true: Show chart subtitle.false: Hide chart subtitle.
Parameters:

  • visibility: boolean - The visibility state of the chart subtitle.Note: Even if the subtitle is visible, it may not be displayed if the subtitle text is empty.
Returns: void

setChartTitleVisibility

Signature: setChartTitleVisibility(visibility: boolean): void
Description: Sets whether or not the chart title is visible.true: Show chart title.false: Hide chart title.
Parameters:

  • visibility: boolean - The visibility state of the chart title.Note: Even if the title is visible, it may not be displayed if the title text is empty.
Returns: void

setConfig

Signature: setConfig(config: ChartConfig): void
Description: Sets the chart configuration object.
Parameters:

  • config: ChartConfig - The configuration object.
Returns: void

setDescriptionSymbol

Signature: setDescriptionSymbol(descriptionSymbol: undefined | WebChartTextSymbol): void
Description: Sets the description text symbol. Contains styling information such as font, color, and symbol style.
Parameters:

  • descriptionSymbol: undefined | WebChartTextSymbol - The description symbol.
Returns: void

setDescriptionText

Signature: setDescriptionText(description: string): void
Description: Sets the chart description text.
Parameters:

  • description: string - The description text.
Returns: void

setDescriptionVisibility

Signature: setDescriptionVisibility(visibility: boolean): void
Description: Sets whether or not the chart description is visible.true: Show description.false: Hide description.
Parameters:

  • visibility: boolean - The visibility state of the description.Note: Even if the description is visible, it may not be displayed if the description text is empty.
Returns: void

setEndAngle

Signature: setEndAngle(endAngle: number): void
Description: Sets the end angle of the gauge.
Parameters:

  • endAngle: number - The end angle to set.
Returns: void

setFeatureIndex

Signature: setFeatureIndex(featureIndex: null | number): Promise
Description: Sets the index of the feature to be rendered.
Parameters:

  • featureIndex: null | number - The index of the feature to be rendered
Returns: Promise
Async: This method is async and must be awaited for the changes to take effect.

setFetchNULLValues

Signature: setFetchNULLValues(fetchNULLValues: boolean): void
Description: Sets whether to fetch null values for them to be counted or displayed as categories on the chart.
Parameters:

  • fetchNULLValues: boolean - Whether to fetch null values.
Returns: void

setField

Signature: setField(field: string): Promise
Description: Sets the data field used for the gauge.
Parameters:

  • field: string - The field to set.
Returns: Promise
Async: This method is async and must be awaited for the changes to take effect.

setGuideAbove

Signature: setGuideAbove(above: boolean, index: number, orientation: GuideOrientation): void
Description: Sets whether the guide should be rendered above the other chart elements.
Parameters:

  • above: boolean - New above boolean to set.
  • Optional index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.
  • Optional orientation: GuideOrientation - Default y. The axis orientation of the guide.
Returns: void

setGuideEnd

Signature: setGuideEnd(end: undefined | null | string | number | Date, index: number, orientation: GuideOrientation): void
Description: Sets the end value of a guide.
Parameters:

  • end: undefined | null | string | number | Date - New end value to set.
  • Optional index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.
  • Optional orientation: GuideOrientation - Default y. The axis orientation of the guide.
Returns: void

setGuideLabelsSymbol

Signature: setGuideLabelsSymbol(newGuideLabelsSymbol: undefined | WebChartTextSymbol): void
Description: Sets the guide labels text symbol. Contains styling information such as font, color, and symbol style.
Parameters:

  • newGuideLabelsSymbol: undefined | WebChartTextSymbol - No description.
Returns: void

setGuideLabelText

Signature: setGuideLabelText(labelText: string, index: number, orientation: GuideOrientation): void
Description: Sets the guide label text.
Parameters:

  • labelText: string - New label text to set.
  • Optional index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.
  • Optional orientation: GuideOrientation - Default y. The axis orientation of the guide.
Returns: void

setGuideName

Signature: setGuideName(name: string, index: number, orientation: GuideOrientation): void
Description: Sets the name of a guide.
Parameters:

  • name: string - New name to set.
  • Optional index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.
  • Optional orientation: GuideOrientation - Default y. The axis orientation of the guide.
Returns: void

setGuideStart

Signature: setGuideStart(start: null | string | number | Date, index: number, orientation: GuideOrientation): void
Description: Sets the start value of a guide.
Parameters:

  • start: null | string | number | Date - New start value to set.
  • Optional index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.
  • Optional orientation: GuideOrientation - Default y. The axis orientation of the guide.
Returns: void

setGuideStyle

Signature: setGuideStyle(style: ISimpleLineSymbol | ISimpleFillSymbol, index: number, orientation: GuideOrientation): void
Description: Sets the guide style.
Parameters:

  • style: ISimpleLineSymbol | ISimpleFillSymbol - New style to set.
  • Optional index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.
  • Optional orientation: GuideOrientation - Default y. The axis orientation of the guide.
Returns: void

setGuideVisibility

Signature: setGuideVisibility(visible: boolean, index: number, orientation: GuideOrientation): void
Description: Sets whether a guide is visible
Parameters:

  • visible: boolean - New visibility to set.
  • Optional index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.
  • Optional orientation: GuideOrientation - Default y. The axis orientation of the guide.
Returns: void

setInnerLabelContent

Signature: setInnerLabelContent(innerLabelContent: undefined | WebChartTextSymbol): void
Description: Sets the inner label content symbol.
Parameters:

  • innerLabelContent: undefined | WebChartTextSymbol - The content symbol to set.
Returns: void

setInnerLabelVisibility

Signature: setInnerLabelVisibility(visible: boolean): void
Description: Sets whether the inner label is visible.
Parameters:

  • visible: boolean - The visibility state to set.
Returns: void

setInnerRadius

Signature: setInnerRadius(innerRadius: number): void
Description: Sets the inner radius of the gauge.
Parameters:

  • innerRadius: number - The inner radius to set.
Returns: void

setLabelsIncrement

Signature: setLabelsIncrement(increment: undefined | number): void
Description: Sets the labels increment for the gauge.
Parameters:

  • increment: undefined | number - The increment to set.
Returns: void

setMaxXBound

Signature: setMaxXBound(newMaxXBound: null | number): Promise
Description: Sets the maximum bound for the x-axis.
Parameters:

  • newMaxXBound: null | number - The new maximum bound for the x-axis.
Returns: Promise
Async: This method is async and must be awaited for the changes to take effect.

setMinXBound

Signature: setMinXBound(newMinXBound: null | number): Promise
Description: Sets the minimum bound for the x-axis.
Parameters:

  • newMinXBound: null | number - The new minimum bound for the x-axis.
Returns: Promise
Async: This method is async and must be awaited for the changes to take effect.

setNeedleDisplayPin

Signature: setNeedleDisplayPin(displayPin: boolean): void
Description: Sets whether to display the pin for the gauge's needle.
Parameters:

  • displayPin: boolean - The display pin state.
Returns: void

setNeedleEndWidth

Signature: setNeedleEndWidth(width: undefined | null | number): void
Description: Sets the end width of the gauge's needle.
Parameters:

  • width: undefined | null | number - The end width to set.
Returns: void

setNeedleInnerRadius

Signature: setNeedleInnerRadius(innerRadius: number): void
Description: Sets the inner radius of the gauge's needle.
Parameters:

  • innerRadius: number - The inner radius to set.
Returns: void

setNeedleStartWidth

Signature: setNeedleStartWidth(width: undefined | null | number): void
Description: Sets the start width of the gauge's needle.
Parameters:

  • width: undefined | null | number - The start width to set.
Returns: void

setNeedleSymbol

Signature: setNeedleSymbol(needleSymbol: undefined | ISimpleFillSymbol): void
Description: Sets the symbol of the gauge's needle.
Parameters:

  • needleSymbol: undefined | ISimpleFillSymbol - The needle symbol to set.
Returns: void

setNeedleVisibility

Signature: setNeedleVisibility(visible: boolean): void
Description: Sets the visibility of the gauge's needle.
Parameters:

  • visible: boolean - The visibility to set.
Returns: void

setOnlyShowFirstAndLastLabels

Signature: setOnlyShowFirstAndLastLabels(showOnlyFirstAndLastLabels: boolean): void
Description: Sets whether to only show the first and last axis labels.
Parameters:

  • showOnlyFirstAndLastLabels: boolean - Indicator of whether to only show the first and last axis labels
Returns: void

setSeriesVisibility

Signature: setSeriesVisibility(props: LegendItemVisibility): void
Description: Sets the visibility of a series.
Parameters:

  • props: LegendItemVisibility - No description.
Returns: void

setStartAngle

Signature: setStartAngle(startAngle: number): void
Description: Sets the start angle of the gauge.
Parameters:

  • startAngle: number - The start angle to set.
Returns: void

setSubtitleSymbol

Signature: setSubtitleSymbol(subtitleSymbol: undefined | WebChartTextSymbol): void
Description: Sets the subtitle text symbol. Contains styling information such as font, color, and symbol style.
Parameters:

  • subtitleSymbol: undefined | WebChartTextSymbol - The title symbol.
Returns: void

setSubtitleText

Signature: setSubtitleText(subtitle: string): void
Description: Sets the chart subtitle text.
Parameters:

  • subtitle: string - The subtitle text.
Returns: void

setTitleSymbol

Signature: setTitleSymbol(titleSymbol: undefined | WebChartTextSymbol): void
Description: Sets the title text symbol. Contains styling information such as font, color, and symbol style.
Parameters:

  • titleSymbol: undefined | WebChartTextSymbol - The title symbol.
Returns: void

setTitleText

Signature: setTitleText(title: string): void
Description: Sets the chart title text.
Parameters:

  • title: string - The title text.
Returns: void

setTooltipReverseColor

Signature: setTooltipReverseColor(reverseColor: boolean, index: number, orientation: GuideOrientation): void
Description: Sets whether the tooltip text color should be reversed for a guide.
Parameters:

  • reverseColor: boolean - New reverseColor boolean to set.
  • index: number - The index of the guide in the list of guides for the given axis orientation.
  • Optional orientation: GuideOrientation - The axis orientation of the guide.
Returns: void

setup

Signature: setup(params: ModelParams): Promise
Description: Completes the async setup process for the chart model. Must be called before using the model.
Parameters:

  • params: ModelParams - The parameters to be used to set up the chart model.
Returns: Promise
Async: This method is async and must be awaited for the changes to take effect.

setValueConversion

Signature: setValueConversion(valueConversion: ValueConversion): void
Description: Sets the conversion to apply to the gauge value
Parameters:

  • valueConversion: ValueConversion - The conversion to apply
Returns: void

setXAxisTitleSymbol

Signature: setXAxisTitleSymbol(newXAxisTitle: undefined | WebChartTextSymbol): void
Description: Sets the x-axis title text symbol. Contains styling information such as font, color, and symbol style.
Parameters:

  • newXAxisTitle: undefined | WebChartTextSymbol - The new x-axis title text symbol.
Returns: void

setXAxisTitleText

Signature: setXAxisTitleText(newXAxisTitleText: string): void
Description: Sets the x-axis title text.
Parameters:

  • newXAxisTitleText: string - The new x-axis title text.
Returns: void

setXAxisTitleVisibility

Signature: setXAxisTitleVisibility(newXAxisTitleVisibility: boolean): void
Description: Sets the visibility of the x-axis title.true: X-axis title is visible.false: X-axis title is hidden.
Parameters:

  • newXAxisTitleVisibility: boolean - Whether the x-axis title is visible or not.
Returns: void

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.