Signature: addXAxisGuide(name: string, index: number): void
Description: Adds an X-axis guide.
Parameters:
name: string - The name of the guide.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.void
Signature: deleteXAxisGuide(index: number): void
Description: Deletes an X-axis guide.
Parameters:
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.void
Signature: emitConfigUpdate(functionCalled: string): void
Description: Emits a config update event.
Parameters:
functionCalled: string - No description.void
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.
Signature: getAggregationType(): WebChartStatisticType
Description: Gets the aggregation type used for the gauge.
Returns: WebChartStatisticType
Signature: getAxisLabelsSymbol(): undefined | WebChartTextSymbol
Description: Gets the axis labels text symbol. Contains styling information such as font, color, and symbol style.
Returns: undefined | WebChartTextSymbol
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
Signature: getAxisTickVisibility(): boolean
Description: Gets whether the axis ticks are visible.
Returns: boolean
Signature: getBackgroundColor(): undefined | Color
Description: Gets the background color of the chart.
Returns: undefined | Color
Signature: getChartId(): undefined | string
Description: Gets the chart id.
Returns: undefined | string
Signature: getChartRenderer(): any
Description: Gets the chart renderer.
Returns: any
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
Signature: getChartSubType(): ChartSubType
Description: Gets the chart sub type of the series.
Returns: ChartSubType
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
Signature: getChartType(): ChartTypes
Description: Gets the chart type.
Returns: ChartTypes
Signature: getConfig(): ChartConfig
Description: Gets the current chart configuration object.
Returns: ChartConfig
Signature: getDescriptionSymbol(): undefined | WebChartTextSymbol
Description: Gets the description text symbol. Contains styling information such as font, color, and symbol style.
Returns: undefined | WebChartTextSymbol
Signature: getDescriptionText(): string
Description: Gets the chart description text.
Returns: string
Signature: getDescriptionVisibility(): boolean
Description: Gets whether or not the chart description is visible.true: Description is visible.false: Description is hidden.
Returns: boolean
Signature: getEndAngle(): number
Description: Gets the end angle of the gauge.
Returns: number
Signature: getFeatureIndex(): undefined | number
Description: Gets the index of the feature to be rendered.
Returns: undefined | number
Signature: getFetchNULLValues(): boolean
Description: Gets whether to fetch null values for them to be counted or displayed as categories on the chart.
Returns: boolean
Signature: getField(): string
Description: Gets the data field used for the gauge.
Returns: string
Signature: getGaugeSubType(): GaugeChartSubTypes
Description: Gets the type of Gauge chart, like FeatureGauge and StatisticGauge.
Returns: GaugeChartSubTypes
Signature: getGuideAbove(index: number, orientation: GuideOrientation): boolean
Description: Gets whether the guide should be rendered above the other chart elements.
Parameters:
index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.orientation: GuideOrientation - Default y. The axis orientation of the guide.boolean
Signature: getGuideEnd(index: number, orientation: GuideOrientation): undefined | null | string | number | Date
Description: Gets the end value of a guide.
Parameters:
index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.orientation: GuideOrientation - Default y. The axis orientation of the guide.undefined | null | string | number | Date
Signature: getGuideLabelsSymbol(): undefined | WebChartTextSymbol
Description: Gets the guide labels text symbol. Contains styling information such as font, color, and symbol style.
Returns: undefined | WebChartTextSymbol
Signature: getGuideLabelText(index: number, orientation: GuideOrientation): undefined | string
Description: Gets the guide label text.
Parameters:
index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.orientation: GuideOrientation - Default y. The axis orientation of the guide.undefined | string
Signature: getGuideName(index: number, orientation: GuideOrientation): undefined | string
Description: Gets the name of a guide.
Parameters:
index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.orientation: GuideOrientation - Default y. The axis orientation of the guide.undefined | string
Signature: getGuideStart(index: number, orientation: GuideOrientation): null | string | number | Date
Description: Gets the start value of a guide.
Parameters:
index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.orientation: GuideOrientation - Default y. The axis orientation of the guide.null | string | number | Date
Signature: getGuideStyle(index: number, orientation: GuideOrientation): undefined | ISimpleLineSymbol | ISimpleFillSymbol
Description: Gets the guide style.
Parameters:
index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.orientation: GuideOrientation - Default y. The axis orientation of the guide.undefined | ISimpleLineSymbol | ISimpleFillSymbol
Signature: getGuideVisibility(index: number, orientation: GuideOrientation): boolean
Description: Gets whether a guide is visible.
Parameters:
index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.orientation: GuideOrientation - Default y. The axis orientation of the guide.boolean
Signature: getInnerLabelContent(): undefined | WebChartTextSymbol
Description: Gets the inner label content symbol.
Returns: undefined | WebChartTextSymbol
Signature: getInnerLabelVisible(): boolean
Description: Gets whether the inner label is visible.
Returns: boolean
Signature: getInnerRadius(): number
Description: Gets the inner radius of the gauge.
Returns: number
Signature: getLabelsIncrement(): undefined | number
Description: Gets the labels increment for the gauge.
Returns: undefined | number
Signature: getLayer(): undefined | SupportedLayer
Description: Gets the associated layer.
Returns: undefined | SupportedLayer
Signature: getMaxXBound(): null | number
Description: Gets the maximum bound that is currently set for the x-axis.
Returns: null | number
Signature: getMinXBound(): null | number
Description: Gets the minimum bound that is currently set for the x-axis.
Returns: null | number
Signature: getNeedleDisplayPin(): boolean
Description: Gets whether to display the pin for the gauge's needle.
Returns: boolean
Signature: getNeedleEndWidth(): undefined | null | number
Description: Gets the end width of the gauge's needle.
Returns: undefined | null | number
Signature: getNeedleInnerRadius(): undefined | null | number
Description: Gets the inner radius of the gauge's needle.
Returns: undefined | null | number
Signature: getNeedleStartWidth(): undefined | null | number
Description: Gets the start width of the gauge's needle.
Returns: undefined | null | number
Signature: getNeedleSymbol(): undefined | ISimpleFillSymbol
Description: Gets the symbol of the gauge's needle.
Returns: undefined | ISimpleFillSymbol
Signature: getNeedleVisibility(): boolean
Description: Gets the visibility of the gauge's needle.
Returns: boolean
Signature: getOnlyShowFirstAndLastLabels(): boolean
Description: Gets whether to only show the first and last labels.
Returns: boolean
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.undefined | string
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.undefined | number
Signature: getSeriesLength(): number
Description: Gets the length of the series array.
Returns: number
Signature: getSeriesVisibility(seriesIndex: number): boolean
Description: Gets the visibility of a series.
Parameters:
seriesIndex: number - The series indexboolean
Signature: getSplitByValues(): string[]
Description: Gets the split-by values for the chart.
Returns: string[]
Signature: getStartAngle(): number
Description: Gets the start angle of the gauge.
Returns: number
Signature: getSubtitleSymbol(): undefined | WebChartTextSymbol
Description: Gets the subtitle text symbol. Contains styling information such as font, color, and symbol style.
Returns: undefined | WebChartTextSymbol
Signature: getSubtitleText(): string
Description: Gets the chart subtitle text.
Returns: string
Signature: getTitleSymbol(): undefined | WebChartTextSymbol
Description: Gets the title text symbol. Contains styling information such as font, color, and symbol style.
Returns: undefined | WebChartTextSymbol
Signature: getTitleText(): string
Description: Gets the chart title text.
Returns: string
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.orientation: GuideOrientation - The axis orientation of the guide.boolean
Signature: getValueConversion(): undefined | ValueConversion
Description: Gets the conversion to apply to the gauge value
Returns: undefined | ValueConversion
Signature: getVersion(): string
Description: Gets the version of the chart configuration.
Returns: string
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
Signature: getXAxisTitleText(): string
Description: Gets the x-axis title text.
Returns: string
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
Signature: getXGuidesLength(): undefined | number
Description: Gets the number guides in the X-axis guides list.
Returns: undefined | number
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.boolean
Signature: loadConfigFromLayer(params: ModelParams): Promise
Description: A function that loads the config based on the provided props.
Parameters:
params: ModelParams - No description.Promise
Signature: removeFeatureIndex(): void
Description: Removes the existing feature index from the config object
Returns: void
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".Promise
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.void
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.void
Signature: setAxisTickVisibility(visibile: boolean): void
Description: Sets whether the axis ticks are visible.
Parameters:
visibile: boolean - The visibility state to set.void
Signature: setBackgroundColor(backgroundColor: undefined | Color): void
Description: Sets the background color of the chart.
Parameters:
backgroundColor: undefined | Color - The background color.void
Signature: setChartId(id: string): void
Description: Sets the chart id.
Parameters:
id: string - No description.void
Signature: setChartRenderer(renderer: any): void
Description: Sets the chart renderer.
Parameters:
renderer: any - The chart renderer to set.void
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.void
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.void
Signature: setConfig(config: ChartConfig): void
Description: Sets the chart configuration object.
Parameters:
config: ChartConfig - The configuration object.void
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.void
Signature: setDescriptionText(description: string): void
Description: Sets the chart description text.
Parameters:
description: string - The description text.void
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.void
Signature: setEndAngle(endAngle: number): void
Description: Sets the end angle of the gauge.
Parameters:
endAngle: number - The end angle to set.void
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 renderedPromise
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.void
Signature: setField(field: string): Promise
Description: Sets the data field used for the gauge.
Parameters:
field: string - The field to set.Promise
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.index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.orientation: GuideOrientation - Default y. The axis orientation of the guide.void
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.index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.orientation: GuideOrientation - Default y. The axis orientation of the guide.void
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.void
Signature: setGuideLabelText(labelText: string, index: number, orientation: GuideOrientation): void
Description: Sets the guide label text.
Parameters:
labelText: string - New label text to set.index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.orientation: GuideOrientation - Default y. The axis orientation of the guide.void
Signature: setGuideName(name: string, index: number, orientation: GuideOrientation): void
Description: Sets the name of a guide.
Parameters:
name: string - New name to set.index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.orientation: GuideOrientation - Default y. The axis orientation of the guide.void
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.index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.orientation: GuideOrientation - Default y. The axis orientation of the guide.void
Signature: setGuideStyle(style: ISimpleLineSymbol | ISimpleFillSymbol, index: number, orientation: GuideOrientation): void
Description: Sets the guide style.
Parameters:
style: ISimpleLineSymbol | ISimpleFillSymbol - New style to set.index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.orientation: GuideOrientation - Default y. The axis orientation of the guide.void
Signature: setGuideVisibility(visible: boolean, index: number, orientation: GuideOrientation): void
Description: Sets whether a guide is visible
Parameters:
visible: boolean - New visibility to set.index: number - Default 0. The index of the guide in the list of guides for the given axis orientation.orientation: GuideOrientation - Default y. The axis orientation of the guide.void
Signature: setInnerLabelContent(innerLabelContent: undefined | WebChartTextSymbol): void
Description: Sets the inner label content symbol.
Parameters:
innerLabelContent: undefined | WebChartTextSymbol - The content symbol to set.void
Signature: setInnerLabelVisibility(visible: boolean): void
Description: Sets whether the inner label is visible.
Parameters:
visible: boolean - The visibility state to set.void
Signature: setInnerRadius(innerRadius: number): void
Description: Sets the inner radius of the gauge.
Parameters:
innerRadius: number - The inner radius to set.void
Signature: setLabelsIncrement(increment: undefined | number): void
Description: Sets the labels increment for the gauge.
Parameters:
increment: undefined | number - The increment to set.void
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.Promise
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.Promise
Signature: setNeedleDisplayPin(displayPin: boolean): void
Description: Sets whether to display the pin for the gauge's needle.
Parameters:
displayPin: boolean - The display pin state.void
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.void
Signature: setNeedleInnerRadius(innerRadius: number): void
Description: Sets the inner radius of the gauge's needle.
Parameters:
innerRadius: number - The inner radius to set.void
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.void
Signature: setNeedleSymbol(needleSymbol: undefined | ISimpleFillSymbol): void
Description: Sets the symbol of the gauge's needle.
Parameters:
needleSymbol: undefined | ISimpleFillSymbol - The needle symbol to set.void
Signature: setNeedleVisibility(visible: boolean): void
Description: Sets the visibility of the gauge's needle.
Parameters:
visible: boolean - The visibility to set.void
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 labelsvoid
Signature: setSeriesVisibility(props: LegendItemVisibility): void
Description: Sets the visibility of a series.
Parameters:
props: LegendItemVisibility - No description.void
Signature: setStartAngle(startAngle: number): void
Description: Sets the start angle of the gauge.
Parameters:
startAngle: number - The start angle to set.void
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.void
Signature: setSubtitleText(subtitle: string): void
Description: Sets the chart subtitle text.
Parameters:
subtitle: string - The subtitle text.void
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.void
Signature: setTitleText(title: string): void
Description: Sets the chart title text.
Parameters:
title: string - The title text.void
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.orientation: GuideOrientation - The axis orientation of the guide.void
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.Promise
Signature: setValueConversion(valueConversion: ValueConversion): void
Description: Sets the conversion to apply to the gauge value
Parameters:
valueConversion: ValueConversion - The conversion to applyvoid
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.void
Signature: setXAxisTitleText(newXAxisTitleText: string): void
Description: Sets the x-axis title text.
Parameters:
newXAxisTitleText: string - The new x-axis title text.void
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.void
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4