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: addYAxisGuide(name: string, index: number): void
Description: Adds a Y-axis guide.
Parameters:
name: string - The name of the guide.index: number - The index to insert the new guide in the list of Y-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: deleteYAxisGuide(index: number): void
Description: Deletes a Y-axis guide.
Parameters:
index: number - The index of the guide to delete in the list of Y-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: No description.
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 for the bar chart.
Returns: WebChartStatisticType
Signature: getAreaColor(seriesIndex: number): undefined | Color
Description: Specify the color of the filled area for line chart.
Parameters:
seriesIndex: number - The index of the series. NOTE: areaColor will be applied only if showArea is true, and is defaulted to the line color if not provided.undefined | Color
Signature: getAssignToSecondValueAxis(seriesIndex: number): boolean
Description: Gets whether the series should be assigned to the second value axis.
Parameters:
seriesIndex: number - The index of the series.boolean
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: getBackgroundColor(): undefined | Color
Description: Gets the background color of the chart.
Returns: undefined | Color
Signature: getBuffer(axisIndex: number): boolean
Description: Gets the buffer setting for the specified axis.
Parameters:
axisIndex: number - The index of the axisboolean
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: getColorMatch(): boolean
Description: Gets 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.
Returns: boolean
Signature: getConfig(): ChartConfig
Description: Gets the current chart configuration object.
Returns: ChartConfig
Signature: getConnectLines(seriesIndex: number): undefined | boolean
Description: Specify the color of the filled area for line chart.
Parameters:
seriesIndex: number - The index of the series.undefined | boolean
Signature: getCursorCrosshair(): undefined | WebChartCursorCrosshair
Description: Gets the cursor crosshair from the chart config.
Returns: undefined | WebChartCursorCrosshair
Signature: getCursorCrosshairHorizontalLineVisibility(): boolean
Description: Gets the visibility of the horizontal line of the cursor's crosshair.
Returns: boolean
Signature: getCursorCrosshairStyle(): undefined | ISimpleLineSymbol
Description: Gets the style of the cursor's crosshair from the chart config.
Returns: undefined | ISimpleLineSymbol
Signature: getCursorCrosshairVerticalLineVisibility(): boolean
Description: Gets the visibility of the vertical line of the cursor's crosshair.
Returns: boolean
Signature: getCustomSortValues(): Promise
Description: Gets the list of the category values for the chart.
Returns: Promise
Async: This method is async and must be awaited for the changes to take effect.
Signature: getDataFilter(): undefined | WebChartDataFilters
Description: Gets the data filter for the bar chart.
Returns: undefined | WebChartDataFilters
Signature: getDataLabelsSymbol(): undefined | WebChartTextSymbol
Description: Gets the data labels text symbol. Contains styling information such as font, color, and symbol style.
Returns: undefined | WebChartTextSymbol
Signature: getDataLabelsVisibility(): boolean
Description: Gets whether the data labels are visible.true: Data labels are visible.false: Data labels are hidden.
Returns: boolean
Signature: getDataTooltipReverseColor(seriesIndex: number): boolean
Description: Gets the setting of the dataTooltipReverseColor property.
Parameters:
seriesIndex: number - The index of the series.boolean
Signature: getDataTooltipVisibility(seriesIndex: number): boolean
Description: Gets the visibility of the data tooltips.
Parameters:
seriesIndex: number - The index of the series.boolean
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: getDisplayCursorTooltip(axisIndex: number): boolean
Description: Gets the display cursor tooltip setting for the specified axis.
Parameters:
axisIndex: number - The index of the axis to get the display cursor tooltip for.boolean
Signature: getDisplayZeroLine(axisIndex: number): boolean
Description: Gets the display zero line setting for the specified axis.
Parameters:
axisIndex: number - The index of the axis to get the display zero line for.boolean
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: getGridLinesSymbol(): undefined | ISimpleLineSymbol
Description: Gets the grid lines symbol. Contains styling information such as line width, line style, and line color.
Returns: undefined | ISimpleLineSymbol
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: getHorizontalAxisLabelsBehavior(): WebChartLabelBehavior
Description: Gets the horizontal axis labels behavior for the chart.
Returns: WebChartLabelBehavior
Signature: getIntegerOnlyValues(axisIndex: number): boolean
Description: Gets the integer only values setting for the specified axis.
Parameters:
axisIndex: number - The index of the axisboolean
Signature: getLayer(): undefined | SupportedLayer
Description: Gets the associated layer.
Returns: undefined | SupportedLayer
Signature: getLegendMaxHeight(): undefined | number
Description: Gets the maximum height of the legend.
Returns: undefined | number
Signature: getLegendPosition(): WebChartLegendPositions
Description: Gets the legend position: top, bottom, left, or right.
Returns: WebChartLegendPositions
Signature: getLegendRoundMarker(): boolean
Description: Gets the indicator for whether the legend markers should be rounded.
Returns: boolean
Signature: getLegendTextSymbol(): undefined | WebChartTextSymbol
Description: Gets the legend text symbol. Contains styling information such as font, color, and symbol style.
Returns: undefined | WebChartTextSymbol
Signature: getLegendTitleSymbol(): undefined | WebChartTextSymbol
Description: Gets the legend title symbol. Contains styling information such as font, color, and symbol style.
Returns: undefined | WebChartTextSymbol
Signature: getLegendTitleText(): string
Description: Gets the legend title text.
Returns: string
Signature: getLegendTitleVisibility(): boolean
Description: Gets whether the legend title is visible.true: Legend title is visible.false: Legend title is hidden.
Returns: boolean
Signature: getLegendVisibility(): boolean
Description: Gets whether the legend title is visible.true: Legend title is visible.false: Legend title is hidden.
Returns: boolean
Signature: getMaxXBound(): null | number
Description: Gets the maximum bound that is currently set for the x-axis.
Returns: null | number
Signature: getMaxYBound(): null | number
Description: Gets the maximum bound for the y-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: getMinYBound(): null | number
Description: Gets the minimum bound for the y-axis.
Returns: null | number
Signature: getNullPolicy(): undefined | WebChartNullPolicyTypes
Description: Gets the 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.
Returns: undefined | WebChartNullPolicyTypes
Signature: getNumericFields(): string[]
Description: Gets the numeric fields array for the chart.
Returns: string[]
Signature: getOrderByList(): string[]
Description: Gets the list of custom sort values for custom sort
Returns: string[]
Signature: getOrderOfSeries(): string[]
Description: Gets the order of the series array by returning an array of series ids.
Returns: string[]
Signature: getRotatedState(): boolean
Description: Gets whether the chart is rotated.
Returns: boolean
Signature: getSeriesColor(seriesIndex: number): undefined | Color
Description: Gets the color of the series based on the series index. If the index is out of bounds, it will return undefined.
Parameters:
seriesIndex: number - The index of the series.undefined | Color
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: getSeriesLineStyle(seriesIndex: number): undefined | RESTSimpleLineSymbolStyle
Description: Gets the line style of the series based on the series index. If the index is out of bounds, it will return undefined.
Parameters:
seriesIndex: number - The index of the series.undefined | RESTSimpleLineSymbolStyle
Signature: getSeriesLineWidth(seriesIndex: number): undefined | number
Description: Gets the line width of the series based on the series index. If the index is out of bounds, it will return undefined.
Parameters:
seriesIndex: number - The index of the series.undefined | number
Signature: getSeriesMarkerColor(seriesIndex: number): undefined | Color
Description: Gets the marker color of the series based on the series index. If the index is out of bounds, it will return undefined.
Parameters:
seriesIndex: number - The index of the series.undefined | Color
Signature: getSeriesMarkerSize(seriesIndex: number): undefined | number
Description: Gets the marker size of the series based on the series index. If the index is out of bounds, it will return undefined.
Parameters:
seriesIndex: number - The index of the series.undefined | number
Signature: getSeriesMarkerStyle(seriesIndex: number): undefined | RESTSimpleMarkerSymbolStyle
Description: Gets the marker style of the series based on the series index. If the index is out of bounds, it will return undefined.
Parameters:
seriesIndex: number - The index of the series.undefined | RESTSimpleMarkerSymbolStyle
Signature: getSeriesName(seriesIndex: number): undefined | string
Description: Gets the name of the series based on the series index.If the index is out of bounds, it will return undefined.
Parameters:
seriesIndex: number - The index of the series.undefined | string
Signature: getSeriesVisibility(seriesIndex: number): boolean
Description: Gets the visibility of a series.
Parameters:
seriesIndex: number - The series indexboolean
Signature: getSortOrder(): SerialChartDataSortingKinds
Description: Gets the sort order for the bar chart.
Returns: SerialChartDataSortingKinds
Signature: getSplitByField(): string
Description: Gets the split-by field for the chart.
Returns: string
Signature: getSplitByValues(): string[]
Description: Gets the split-by values for the chart.
Returns: string[]
Signature: getStackedType(): undefined | WebChartStackedKinds
Description: Gets 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 orwhen 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.
Returns: undefined | WebChartStackedKinds
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: getTemporalBinningSize(): undefined | number
Description: Sets the time interval size for a temporal bar/line chart.
Returns: undefined | number
Signature: getTemporalBinningUnit(): undefined | "seconds" | "minutes" | "hours" | "days" | "weeks" | "months" | "quarters" | "years"
Description: Gets the time interval units for a temporal bar/line chart.
Returns: undefined | "seconds" | "minutes" | "hours" | "days" | "weeks" | "months" | "quarters" | "years"
Signature: getTickSpacing(axisIndex: number): undefined | number
Description: Gets the tick spacing setting for the specified axis.
Parameters:
axisIndex: number - The index of the axisundefined | number
Signature: getTimeAggregationType(): undefined | WebChartTimeAggregationTypes
Description: Gets the time aggregation type for a temporal bar/line chart.
Returns: undefined | WebChartTimeAggregationTypes
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: getTrimIncompleteTimeInterval(): undefined | boolean
Description: Gets whether to trim incomplete time intervals for a temporal bar/line chart.
Returns: undefined | boolean
Signature: getVersion(): string
Description: Gets the version of the chart configuration.
Returns: string
Signature: getVerticalAxisLabelsBehavior(): WebChartLabelBehavior
Description: Gets the vertical axis labels behavior for the chart.
Returns: WebChartLabelBehavior
Signature: getXAxisField(): string
Description: Gets the x-axis field for the chart.
Returns: string
Signature: getXAxisScrollbar(): undefined | WebChartAxisScrollBar
Description: Gets the x-axis scrollbar configuration.
Returns: undefined | WebChartAxisScrollBar
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: getXAxisValueFormat(): undefined | CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions
Description: Gets the value format options for the x-axis.
Returns: undefined | CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions
Signature: getXGuidesLength(): undefined | number
Description: Gets the number guides in the X-axis guides list.
Returns: undefined | number
Signature: getXLogarithmic(): boolean
Description: Gets whether logarithmic scale is enabled for the x-axis.true: Logarithmic scale is enabled for the x-axis.false: Logarithmic scale is disabled for the x-axis.
Returns: boolean
Signature: getYAxisScrollbar(): undefined | WebChartAxisScrollBar
Description: Gets the y-axis scrollbar configuration.
Returns: undefined | WebChartAxisScrollBar
Signature: getYAxisTitleSymbol(): undefined | WebChartTextSymbol
Description: Gets the y-axis title text symbol. Contains styling information such as font, color, and symbol style.
Returns: undefined | WebChartTextSymbol
Signature: getYAxisTitleText(): string
Description: Gets the Y-axis title text.
Returns: string
Signature: getYAxisTitleVisibility(): boolean
Description: Gets the visibility of the Y-axis title.true: The Y-axis title is visible.false: The Y-axis title is hidden.
Returns: boolean
Signature: getYAxisValueFormat(): undefined | NumberFormatOptions
Description: Gets the value format options for the y-axis.
Returns: undefined | NumberFormatOptions
Signature: getYGuidesLength(): undefined | number
Description: Gets the number guides in the Y-axis guides list.
Returns: undefined | number
Signature: getYLogarithmic(): boolean
Description: Gets whether logarithmic scale is enabled for the y-axis.true: Logarithmic scale is enabled for the y-axis.false: Logarithmic scale is disabled for the y-axis.
Returns: boolean
Signature: initDefaultSeries(): Promise
Description: Initializes the default series for the radar chart. Used in resetting the series styling.
Returns: Promise
Async: This method is async and must be awaited for the changes to take effect.
Signature: isAreaVisible(seriesIndex: number): boolean
Description: Specify whether the line series should show area.
Parameters:
seriesIndex: number - The index of the series.boolean
Signature: isLineSmoothed(seriesIndex: number): boolean
Description: Specify whether line segments of the series should be smoothed.
Parameters:
seriesIndex: number - The index of the series.boolean
Signature: isMarkerVisible(seriesIndex: number): boolean
Description: Indicate whether to show or hide the markers/bullets of the line series.
Parameters:
seriesIndex: number - The index of the series.boolean
Signature: isNegativeValuesStackedToBaseline(seriesIndex: number): boolean
Description: Specify how negative values are treated in stacked series.
Parameters:
seriesIndex: number - The index of the series. NOTE: If true, negative values will be stacked on the base line.If false, negative values will be stacked in relation to their previous values in the stack.boolean
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: moveCustomSortValuesInOrderByList(fromIndex: number, toIndex: number): void
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 SerialChartDataSortingKinds.customSort.
Parameters:
fromIndex: number - The index to move the custom sort value from.toIndex: number - The index to move the custom sort value to.void
Signature: moveSeries(fromIndex: number, toIndex: number): void
Description: Moves a series from one index in the series array to another.
Parameters:
fromIndex: number - Index to move the series from.toIndex: number - Index to move the series to.void
Signature: resetAvailable(): boolean
Description: Returns whether the series styling is able to be reset.
Returns: boolean
Signature: resetConfig(): Promise
Description: Resets the config to the default config
Returns: Promise
Async: This method is async and must be awaited for the changes to take effect.
Signature: resetSeriesStyling(): void
Description: Resets the series styling to the default styling.
Returns: void
Signature: resetTimeInterval(): void
Description: Resets the time interval to default for a temporal line chart.
Returns: void
Signature: setAggregationType(newAggregationType: WebChartStatisticType): Promise
Description: Sets the aggregation type for the chart.
Parameters:
newAggregationType: WebChartStatisticType - The new aggregation type. Must be one of the values allowed by WebChartStatisticType.Promise
Signature: setAreaColor(color: undefined | Color, seriesIndex: number): void
Description: Specify the color of the filled area for line chart.
Parameters:
color: undefined | Color - No description.seriesIndex: number - No description.void
Signature: setAreaVisible(visible: boolean, seriesIndex: number): void
Description: Specify whether the line series should show area.
Parameters:
visible: boolean - No description.seriesIndex: number - No description.void
Signature: setAssignToSecondValueAxis(assign: boolean, seriesIndex: number): void
Description: Sets whether the series should be assigned to the second value axis.
Parameters:
assign: boolean - The value for the setting.seriesIndex: number - The index of the series.void
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: setBackgroundColor(backgroundColor: undefined | Color): void
Description: Sets the background color of the chart.
Parameters:
backgroundColor: undefined | Color - The background color.void
Signature: setBuffer(buffer: boolean, axisIndex: number): void
Description: Sets the buffer for the specified axis.
Parameters:
buffer: boolean - The setting for the bufferaxisIndex: number - The index of the axisvoid
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: setColorMatch(newColorMatch: boolean): void
Description: Sets 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.
Parameters:
newColorMatch: boolean - No description.void
Signature: setConfig(config: ChartConfig): void
Description: Sets the chart configuration object.
Parameters:
config: ChartConfig - The configuration object.void
Signature: setConnectLines(connect: undefined | boolean, seriesIndex: number): void
Description: Specify the color of the filled area for line chart.
Parameters:
connect: undefined | boolean - No description.seriesIndex: number - No description.void
Signature: setCursorCrosshair(cursorCrosshair: WebChartCursorCrosshair): void
Description: Sets the cursor crosshair in the chart config.
Parameters:
cursorCrosshair: WebChartCursorCrosshair - The cursor crosshair to setvoid
Signature: setCursorCrosshairHorizontalLineVisibility(visibility: boolean): void
Description: Sets the visibility of the horizontal line of the cursor's crosshair.
Parameters:
visibility: boolean - The visibility to set for the cursor's crosshair horizontal linevoid
Signature: setCursorCrosshairStyle(style: ISimpleLineSymbol): void
Description: Sets the style of the cursor's crosshair in the chart config.
Parameters:
style: ISimpleLineSymbol - The style to set for the cursor's crosshairvoid
Signature: setCursorCrosshairVerticalLineVisibility(visibility: boolean): void
Description: Sets the visibility of the vertical line of the cursor's crosshair.
Parameters:
visibility: boolean - The visibility to set for the cursor's crosshair vertical linevoid
Signature: setDataFilter(newDataFilter: undefined | WebChartDataFilters): Promise
Description: Sets the data filter for the bar chart.
Parameters:
newDataFilter: undefined | WebChartDataFilters - The new data filter.Promise
Signature: setDataLabelsSymbol(newDataLabelsSymbol: undefined | WebChartTextSymbol): void
Description: Sets the data labels text symbol. Contains styling information such as font, color, and symbol style.
Parameters:
newDataLabelsSymbol: undefined | WebChartTextSymbol - No description.void
Signature: setDataLabelsVisibility(newDataLabelsVisibility: boolean): void
Description: Sets the visibility of the data labels.true: Show data labels.false: Hide data labels.
Parameters:
newDataLabelsVisibility: boolean - No description.void
Signature: setDataTooltipReverseColor(reverseColor: boolean, seriesIndex: number): void
Description: Sets the setting of the dataTooltipReverseColor property.
Parameters:
reverseColor: boolean - Indicator of whether to reverse the color.seriesIndex: number - The index of the series to set the reverse color.void
Signature: setDataTooltipVisibility(visibility: boolean, seriesIndex: number): void
Description: Sets the visibility of the data tooltips.
Parameters:
visibility: boolean - The visibility of the data tooltips.seriesIndex: number - The index of the series to set the visibility.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: setDisplayCursorTooltip(displayCursorTooltip: boolean, axisIndex: number): void
Description: Sets the display cursor tooltip setting for the specified axis.
Parameters:
displayCursorTooltip: boolean - The display cursor tooltip setting for the axis.axisIndex: number - The index of the axis to set the display cursor tooltip for.void
Signature: setDisplayZeroLine(displayZeroLine: boolean, axisIndex: number): void
Description: Sets the display zero line setting for the specified axis.
Parameters:
displayZeroLine: boolean - The display zero line setting for the axis.axisIndex: number - The index of the axis to set the display zero line for.void
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: setGridLinesSymbol(linesSymbol: undefined | ISimpleLineSymbol): void
Description: Sets the grid lines symbol. Contains styling information such as line width, line style, and line color.
Parameters:
linesSymbol: undefined | ISimpleLineSymbol - The grid lines symbol.void
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: setHorizontalAxisLabelsBehavior(horizontalBehavior: WebChartLabelBehavior): void
Description: Sets the horizontal axis labels behavior for the chart.
Parameters:
horizontalBehavior: WebChartLabelBehavior - The behavior for the horizontal axis labels.void
Signature: setIntegerOnlyValues(integerOnlyValues: boolean, axisIndex: number): void
Description: Sets the integer only values setting for the specified axis.
Parameters:
integerOnlyValues: boolean - The boolean value to set for the integer only values settingaxisIndex: number - The index of the axisvoid
Signature: setLegendMaxHeight(maxHeight: number): void
Description: Sets the maximum height of the legend. If not set, the legend will occupy the same height as the series container or pie chart.
Parameters:
maxHeight: number - the maximum height for the legendvoid
Signature: setLegendPosition(legendPosition: WebChartLegendPositions): void
Description: Sets the legend position; where the chart legend should be displayed, top, bottom, left, or right.
Parameters:
legendPosition: WebChartLegendPositions - No description.void
Signature: setLegendRoundMarker(roundMarker: boolean): void
Description: Sets the indicator for whether the legend markers should be rounded.
Parameters:
roundMarker: boolean - the round marker indicatorvoid
Signature: setLegendTextSymbol(legendText: undefined | WebChartTextSymbol): void
Description: Sets the legend text symbol. Contains styling information such as font, color, and symbol style.
Parameters:
legendText: undefined | WebChartTextSymbol - No description.void
Signature: setLegendTitleSymbol(legendTitle: undefined | WebChartTextSymbol): void
Description: Sets the legend title symbol. Contains styling information such as font, color, and symbol style.
Parameters:
legendTitle: undefined | WebChartTextSymbol - No description.void
Signature: setLegendTitleText(legendTitleText: string): void
Description: Sets the legend title text.
Parameters:
legendTitleText: string - No description.void
Signature: setLegendTitleVisibility(showLegendTitle: boolean): void
Description: Sets whether the legend title is visible.true: Show legend title.false: Hide legend title.
Parameters:
showLegendTitle: boolean - No description.void
Signature: setLegendVisibility(legendVisibility: boolean): void
Description: Sets whether the legend title is visible.true: Show legend title.false: Hide legend title.
Parameters:
legendVisibility: boolean - No description.void
Signature: setLineSmoothed(smoothed: boolean, seriesIndex: number): void
Description: Specify whether line segments of the series should be smoothed.
Parameters:
smoothed: boolean - No description.seriesIndex: number - No description.void
Signature: setMarkerVisible(visible: boolean, seriesIndex: number): void
Description: Indicate whether to show or hide the markers/bullets of the line series.
Parameters:
visible: boolean - No description.seriesIndex: number - No description.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: setMaxYBound(maxBound: null | number): Promise
Description: Sets the maximum bound for the y-axis.
Parameters:
maxBound: null | number - The maximum bound for the y-axis. If null, the maximum bound is automatically calculated.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: setMinYBound(minBound: null | number): Promise
Description: Sets the minimum bound for the y-axis.
Parameters:
minBound: null | number - The minimum bound for the y-axis. If null, the minimum bound is automatically calculated.Promise
Signature: setNegativeValuesStackedToBaseline(stackNegativeValuesToBaseline: boolean, seriesIndex: number): void
Description: Specify how negative values are treated in stacked series.
Parameters:
stackNegativeValuesToBaseline: boolean - No description.seriesIndex: number - No description.void
Signature: setNullPolicy(newNullPolicy: undefined | WebChartNullPolicyTypes): void
Description: Sets the 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.
Parameters:
newNullPolicy: undefined | WebChartNullPolicyTypes - The new null policy.void
Signature: setNumericFields(newNumericFields: string | string[]): Promise
Description: Sets the numeric field or numeric fields array for the chart.
Parameters:
newNumericFields: string | string[] - The new numeric field string or numeric fields array.Promise
Signature: setOrderByList(newOrderByList: string[]): void
Description: Sets the list of custom sort values for custom sort
Parameters:
newOrderByList: string[] - The new list of custom sort valuesvoid
Signature: setOrderOfSeries(newOrder: string[]): void
Description: Sets the order of the series array by providing an array of series ids.
Parameters:
newOrder: string[] - The new order of the series array.void
Signature: setRotatedState(rotated: boolean): void
Description: Sets whether the chart is rotated.
Parameters:
rotated: boolean - No description.void
Signature: setSeriesColor(newColor: undefined | Color, seriesIndex: number): void
Description: Sets the color of the series based on the series index.
Parameters:
newColor: undefined | Color - The new color for the series.seriesIndex: number - The index of the series.void
Signature: setSeriesLineStyle(style: undefined | RESTSimpleLineSymbolStyle, seriesIndex: number): void
Description: Sets the line style of the series based on the series index.
Parameters:
style: undefined | RESTSimpleLineSymbolStyle - The new style for the series.seriesIndex: number - The index of the series.void
Signature: setSeriesLineWidth(width: undefined | number, seriesIndex: number): void
Description: Sets the line width of the series based on the series index.
Parameters:
width: undefined | number - The new width for the series.seriesIndex: number - The index of the series.void
Signature: setSeriesMarkerColor(color: undefined | Color, seriesIndex: number): void
Description: Sets the marker color of the series based on the series index.
Parameters:
color: undefined | Color - The new color for the series.seriesIndex: number - The index of the series.void
Signature: setSeriesMarkerSize(size: undefined | number, seriesIndex: number): void
Description: Sets the marker size of the series based on the series index.
Parameters:
size: undefined | number - The new size for the series.seriesIndex: number - The index of the series.void
Signature: setSeriesMarkerStyle(style: undefined | RESTSimpleMarkerSymbolStyle, seriesIndex: number): void
Description: Sets the marker style of the series based on the series index.
Parameters:
style: undefined | RESTSimpleMarkerSymbolStyle - The new style for the series.seriesIndex: number - The index of the series.void
Signature: setSeriesName(name: string, seriesIndex: number): void
Description: Sets name of the series based on the series index.
Parameters:
name: string - The name for the series.seriesIndex: number - The index of the series.void
Signature: setSeriesVisibility(props: LegendItemVisibility): void
Description: Sets the visibility of a series.
Parameters:
props: LegendItemVisibility - No description.void
Signature: setSortOrder(newSortOrder: SerialChartDataSortingKinds, orderByList: string[]): void
Description: Sets the sort order for the bar chart.
Parameters:
newSortOrder: SerialChartDataSortingKinds - The new sort order.orderByList: string[] - The list of category's values to order by.void
Signature: setSplitByField(newSplitByField: string): Promise
Description: Sets the split-by field for the chart.
Parameters:
newSplitByField: string - The new split-by field.Promise
Signature: setStackedType(newStackedType: undefined | WebChartStackedKinds): Promise
Description: Sets 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 orwhen 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.
Parameters:
newStackedType: undefined | WebChartStackedKinds - The new stacked type.Promise
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: setTemporalBinningSize(newSize: undefined | number): void
Description: Sets the time interval size for a temporal bar/line chart.
Parameters:
newSize: undefined | number - The new time interval size.void
Signature: setTemporalBinningUnit(newUnit: undefined | WebChartFixedDateBinningUnits): void
Description: Sets the time interval units for a temporal bar/line chart.
Parameters:
newUnit: undefined | WebChartFixedDateBinningUnits - The new time interval units.void
Signature: setTickSpacing(tickSpacing: number, axisIndex: number): void
Description: Sets the tick spacing for the specified axis.
Parameters:
tickSpacing: number - The value to set for the tick spacingaxisIndex: number - The index of the axisvoid
Signature: setTimeAggregationType(newTimeAggregationType: undefined | WebChartTimeAggregationTypes): void
Description: Sets the time aggregation type for a temporal bar/line chart.
Parameters:
newTimeAggregationType: undefined | WebChartTimeAggregationTypes - The new time aggregation type.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: setTrimIncompleteTimeInterval(newTrimIncompleteTimeInterval: undefined | boolean): void
Description: Sets whether to trim incomplete time intervals for a temporal bar/line chart.
Parameters:
newTrimIncompleteTimeInterval: undefined | boolean - The new state.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: setVerticalAxisLabelsBehavior(verticalBehavior: WebChartLabelBehavior): void
Description: Sets the vertical axis labels behavior for the chart.
Parameters:
verticalBehavior: WebChartLabelBehavior - The behavior for the vertical axis labels.void
Signature: setXAxisField(newXAxisField: string): Promise
Description: Sets the x-axis field for the chart.
Parameters:
newXAxisField: string - The new x-axis field.Promise
Signature: setXAxisScrollbar(scrollbar: WebChartAxisScrollBar): void
Description: Sets the x-axis scrollbar configuration.
Parameters:
scrollbar: WebChartAxisScrollBar - The x-axis scrollbar configuration.void
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
Signature: setXAxisValueFormat(valueFormat: undefined | CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions): Promise
Description: Sets the value format options for the x-axis.
Parameters:
valueFormat: undefined | CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions - The value format options for the x-axis.Promise
Signature: setXLogarithmic(logarithmicState: boolean): Promise
Description: Sets whether logarithmic scale is enabled for the x-axis.true: Enable logarithmic scale for the x-axis.false: Disable logarithmic scale for the x-axis.
Parameters:
logarithmicState: boolean - The state of the logarithmic scale for the x-axis.Promise
Signature: setYAxisScrollbar(scrollbar: WebChartAxisScrollBar): void
Description: Sets the y-axis scrollbar configuration.
Parameters:
scrollbar: WebChartAxisScrollBar - The y-axis scrollbar configuration.void
Signature: setYAxisTitleSymbol(titleSymbol: undefined | WebChartTextSymbol): void
Description: Sets the y-axis title text symbol. Contains styling information such as font, color, and symbol style.
Parameters:
titleSymbol: undefined | WebChartTextSymbol - The y-axis title text symbol.void
Signature: setYAxisTitleText(titleText: string): void
Description: Sets the Y-axis title text.
Parameters:
titleText: string - The Y-axis title text.void
Signature: setYAxisTitleVisibility(visibility: boolean): void
Description: Sets the visibility of the Y-axis title.true: Show the Y-axis title.false: Hide the Y-axis title.
Parameters:
visibility: boolean - The visibility state of the Y-axis title.void
Signature: setYAxisValueFormat(valueFormat: undefined | NumberFormatOptions): Promise
Description: Sets the value format options for the y-axis.
Parameters:
valueFormat: undefined | NumberFormatOptions - The value format options for the y-axis.Promise
Signature: setYLogarithmic(logarithmicState: boolean): Promise
Description: Sets whether logarithmic scale is enabled for the y-axis.true: Enable logarithmic scale for the y-axis.false: Disable logarithmic scale for the y-axis.
Parameters:
logarithmicState: boolean - The state of the logarithmic scale for the y-axis.Promise
Signature: updateSeriesFromLayerFilter(): Promise
Description: Updates the series based on the layer filter.
Returns: Promise
Async: This method is async and must be awaited for the changes to take effect.
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