Scatterplot Model

Name	Description
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`
addYAxisGuide	Signature: `addYAxisGuide(name: string, index: number): void` Description: Adds a Y-axis guide. Parameters: `name: string` - The name of the guide. Optional `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. 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`
deleteYAxisGuide	Signature: `deleteYAxisGuide(index: number): void` Description: Deletes a Y-axis guide. Parameters: Optional `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. 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.
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`
getBackgroundColor	Signature: `getBackgroundColor(): undefined \| Color` Description: Gets the background color of the chart. Returns: `undefined \| Color`
getBuffer	Signature: `getBuffer(axisIndex: number): boolean` Description: Gets the buffer setting for the specified axis. Parameters: `axisIndex: number` - The index of the axis Returns: `boolean`
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`
getColorMatch	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`
getConfig	Signature: `getConfig(): ChartConfig` Description: Gets the current chart configuration object. Returns: `ChartConfig`
getCursorCrosshair	Signature: `getCursorCrosshair(): undefined \| WebChartCursorCrosshair` Description: Gets the cursor crosshair from the chart config. Returns: `undefined \| WebChartCursorCrosshair`
getCursorCrosshairHorizontalLineVisibility	Signature: `getCursorCrosshairHorizontalLineVisibility(): boolean` Description: Gets the visibility of the horizontal line of the cursor's crosshair. Returns: `boolean`
getCursorCrosshairStyle	Signature: `getCursorCrosshairStyle(): undefined \| ISimpleLineSymbol` Description: Gets the style of the cursor's crosshair from the chart config. Returns: `undefined \| ISimpleLineSymbol`
getCursorCrosshairVerticalLineVisibility	Signature: `getCursorCrosshairVerticalLineVisibility(): boolean` Description: Gets the visibility of the vertical line of the cursor's crosshair. Returns: `boolean`
getDataLabelsSymbol	Signature: `getDataLabelsSymbol(): undefined \| WebChartTextSymbol` Description: Gets the data labels text symbol. Contains styling information such as font, color, and symbol style. Returns: `undefined \| WebChartTextSymbol`
getDataLabelsVisibility	Signature: `getDataLabelsVisibility(): boolean` Description: Gets whether the data labels are visible.true: Data labels are visible.false: Data labels are hidden. Returns: `boolean`
getDataTooltipReverseColor	Signature: `getDataTooltipReverseColor(seriesIndex: number): boolean` Description: Gets the setting of the dataTooltipReverseColor property. Parameters: Optional `seriesIndex: number` - The index of the series. Returns: `boolean`
getDataTooltipVisibility	Signature: `getDataTooltipVisibility(seriesIndex: number): boolean` Description: Gets the visibility of the data tooltips. Parameters: Optional `seriesIndex: number` - The index of the series. Returns: `boolean`
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`
getDisplayCursorTooltip	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. Returns: `boolean`
getDisplayZeroLine	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. Returns: `boolean`
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`
getFixedMarkerSymbol	Signature: `getFixedMarkerSymbol(): ISimpleMarkerSymbol` Description: Gets the marker symbol used for the scatter plot points when using a fixed symbol (i.e. no size policy is set). Returns: `ISimpleMarkerSymbol`
getGridLinesSymbol	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`
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`
getHorizontalAxisLabelsBehavior	Signature: `getHorizontalAxisLabelsBehavior(): WebChartLabelBehavior` Description: Gets the horizontal axis labels behavior for the chart. Returns: `WebChartLabelBehavior`
getIntegerOnlyValues	Signature: `getIntegerOnlyValues(axisIndex: number): boolean` Description: Gets the integer only values setting for the specified axis. Parameters: `axisIndex: number` - The index of the axis Returns: `boolean`
getLayer	Signature: `getLayer(): undefined \| SupportedLayer` Description: Gets the associated layer. Returns: `undefined \| SupportedLayer`
getLegendMaxHeight	Signature: `getLegendMaxHeight(): undefined \| number` Description: Gets the maximum height of the legend. Returns: `undefined \| number`
getLegendPosition	Signature: `getLegendPosition(): WebChartLegendPositions` Description: Gets the legend position: top, bottom, left, or right. Returns: `WebChartLegendPositions`
getLegendRoundMarker	Signature: `getLegendRoundMarker(): boolean` Description: Gets the indicator for whether the legend markers should be rounded. Returns: `boolean`
getLegendTextSymbol	Signature: `getLegendTextSymbol(): undefined \| WebChartTextSymbol` Description: Gets the legend text symbol. Contains styling information such as font, color, and symbol style. Returns: `undefined \| WebChartTextSymbol`
getLegendTitleSymbol	Signature: `getLegendTitleSymbol(): undefined \| WebChartTextSymbol` Description: Gets the legend title symbol. Contains styling information such as font, color, and symbol style. Returns: `undefined \| WebChartTextSymbol`
getLegendTitleText	Signature: `getLegendTitleText(): string` Description: Gets the legend title text. Returns: `string`
getLegendTitleVisibility	Signature: `getLegendTitleVisibility(): boolean` Description: Gets whether the legend title is visible.true: Legend title is visible.false: Legend title is hidden. Returns: `boolean`
getLegendVisibility	Signature: `getLegendVisibility(): boolean` Description: Gets whether the legend title is visible.true: Legend title is visible.false: Legend title is hidden. Returns: `boolean`
getLinearTrendSymbol	Signature: `getLinearTrendSymbol(): ISimpleLineSymbol` Description: Gets the line symbol for the linear trend line. Returns: `ISimpleLineSymbol`
getMaxXBound	Signature: `getMaxXBound(): null \| number` Description: Gets the maximum bound that is currently set for the x-axis. Returns: `null \| number`
getMaxYBound	Signature: `getMaxYBound(): null \| number` Description: Gets the maximum bound for the y-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`
getMinYBound	Signature: `getMinYBound(): null \| number` Description: Gets the minimum bound for the y-axis. Returns: `null \| number`
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`
getSeriesOverlays	Signature: `getSeriesOverlays(): undefined \| ScatterplotOverlays` Description: Gets the chart overlays. The scatter plot implements only 1 overlay, trendLine. Returns: `undefined \| ScatterplotOverlays`
getSeriesVisibility	Signature: `getSeriesVisibility(seriesIndex: number): boolean` Description: Gets the visibility of a series. Parameters: `seriesIndex: number` - The series index Returns: `boolean`
getShowLinearTrend	Signature: `getShowLinearTrend(): boolean` Description: Gets whether the linear trend line is shown. Returns: `boolean`
getSizePolicy	Signature: `getSizePolicy(): undefined \| SizePolicy` Description: Gets the size policy for the scatter plot points. This is used to scale the size of the marker symbol based on a given field. Returns: `undefined \| SizePolicy`
getSplitByValues	Signature: `getSplitByValues(): string[]` Description: Gets the split-by values for the chart. Returns: `string[]`
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`
getTickSpacing	Signature: `getTickSpacing(axisIndex: number): undefined \| number` Description: Gets the tick spacing setting for the specified axis. Parameters: `axisIndex: number` - The index of the axis Returns: `undefined \| number`
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`
getVersion	Signature: `getVersion(): string` Description: Gets the version of the chart configuration. Returns: `string`
getVerticalAxisLabelsBehavior	Signature: `getVerticalAxisLabelsBehavior(): WebChartLabelBehavior` Description: Gets the vertical axis labels behavior for the chart. Returns: `WebChartLabelBehavior`
getXAxisField	Signature: `getXAxisField(): string` Description: Gets the x-axis field. Returns: `string`
getXAxisScrollbar	Signature: `getXAxisScrollbar(): undefined \| WebChartAxisScrollBar` Description: Gets the x-axis scrollbar configuration. Returns: `undefined \| WebChartAxisScrollBar`
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`
getXAxisValueFormat	Signature: `getXAxisValueFormat(): undefined \| CategoryFormatOptions \| DateTimeFormatOptions \| NumberFormatOptions` Description: Gets the value format options for the x-axis. Returns: `undefined \| CategoryFormatOptions \| DateTimeFormatOptions \| NumberFormatOptions`
getXGuidesLength	Signature: `getXGuidesLength(): undefined \| number` Description: Gets the number guides in the X-axis guides list. Returns: `undefined \| number`
getXLogarithmic	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`
getYAxisField	Signature: `getYAxisField(): string` Description: Gets the y-axis field. Returns: `string`
getYAxisScrollbar	Signature: `getYAxisScrollbar(): undefined \| WebChartAxisScrollBar` Description: Gets the y-axis scrollbar configuration. Returns: `undefined \| WebChartAxisScrollBar`
getYAxisTitleSymbol	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`
getYAxisTitleText	Signature: `getYAxisTitleText(): string` Description: Gets the Y-axis title text. Returns: `string`
getYAxisTitleVisibility	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`
getYAxisValueFormat	Signature: `getYAxisValueFormat(): undefined \| NumberFormatOptions` Description: Gets the value format options for the y-axis. Returns: `undefined \| NumberFormatOptions`
getYGuidesLength	Signature: `getYGuidesLength(): undefined \| number` Description: Gets the number guides in the Y-axis guides list. Returns: `undefined \| number`
getYLogarithmic	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`
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.
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`
setBackgroundColor	Signature: `setBackgroundColor(backgroundColor: undefined \| Color): void` Description: Sets the background color of the chart. Parameters: `backgroundColor: undefined \| Color` - The background color. Returns: `void`
setBuffer	Signature: `setBuffer(buffer: boolean, axisIndex: number): void` Description: Sets the buffer for the specified axis. Parameters: `buffer: boolean` - The setting for the buffer `axisIndex: number` - The index of the axis 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`
setColorMatch	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. Returns: `void`
setConfig	Signature: `setConfig(config: ChartConfig): void` Description: Sets the chart configuration object. Parameters: `config: ChartConfig` - The configuration object. Returns: `void`
setCursorCrosshair	Signature: `setCursorCrosshair(cursorCrosshair: WebChartCursorCrosshair): void` Description: Sets the cursor crosshair in the chart config. Parameters: `cursorCrosshair: WebChartCursorCrosshair` - The cursor crosshair to set Returns: `void`
setCursorCrosshairHorizontalLineVisibility	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 line Returns: `void`
setCursorCrosshairStyle	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 crosshair Returns: `void`
setCursorCrosshairVerticalLineVisibility	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 line Returns: `void`
setDataLabelsSymbol	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. Returns: `void`
setDataLabelsVisibility	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. Returns: `void`
setDataTooltipReverseColor	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. Optional `seriesIndex: number` - The index of the series to set the reverse color. Returns: `void`
setDataTooltipVisibility	Signature: `setDataTooltipVisibility(visibility: boolean, seriesIndex: number): void` Description: Sets the visibility of the data tooltips. Parameters: `visibility: boolean` - The visibility of the data tooltips. Optional `seriesIndex: number` - The index of the series to set the visibility. 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`
setDisplayCursorTooltip	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. Returns: `void`
setDisplayZeroLine	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. Returns: `void`
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`
setFixedMarkerSymbol	Signature: `setFixedMarkerSymbol(symbol: ISimpleMarkerSymbol): void` Description: Sets the marker symbol used for the scatter plot points when using a fixed symbol (i.e. no size policy is set). Parameters: `symbol: ISimpleMarkerSymbol` - No description. Returns: `void`
setGridLinesSymbol	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. Returns: `void`
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`
setHorizontalAxisLabelsBehavior	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. Returns: `void`
setIntegerOnlyValues	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 setting `axisIndex: number` - The index of the axis Returns: `void`
setLegendMaxHeight	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 legend Returns: `void`
setLegendPosition	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. Returns: `void`
setLegendRoundMarker	Signature: `setLegendRoundMarker(roundMarker: boolean): void` Description: Sets the indicator for whether the legend markers should be rounded. Parameters: `roundMarker: boolean` - the round marker indicator Returns: `void`
setLegendTextSymbol	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. Returns: `void`
setLegendTitleSymbol	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. Returns: `void`
setLegendTitleText	Signature: `setLegendTitleText(legendTitleText: string): void` Description: Sets the legend title text. Parameters: `legendTitleText: string` - No description. Returns: `void`
setLegendTitleVisibility	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. Returns: `void`
setLegendVisibility	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. Returns: `void`
setLinearTrendSymbol	Signature: `setLinearTrendSymbol(symbol: ISimpleLineSymbol): void` Description: Sets the line symbol for the linear trend line. Parameters: `symbol: ISimpleLineSymbol` - No description. 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.
setMaxYBound	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. 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.
setMinYBound	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. Returns: `Promise` Async: This method is async and must be awaited for the changes to take effect.
setSeriesOverlays	Signature: `setSeriesOverlays(overlays: ScatterplotOverlays): void` Description: Sets the chart overlays. The scatter plot implements only 1 overlay, trendLine. Parameters: `overlays: ScatterplotOverlays` - The overlays Returns: `void`
setSeriesVisibility	Signature: `setSeriesVisibility(props: LegendItemVisibility): void` Description: Sets the visibility of a series. Parameters: `props: LegendItemVisibility` - No description. Returns: `void`
setShowLinearTrend	Signature: `setShowLinearTrend(show: boolean): void` Description: Sets whether to show the linear trend line. Parameters: `show: boolean` - No description. Returns: `void`
setSizePolicy	Signature: `setSizePolicy(sizePolicy: undefined \| SizePolicy): void` Description: Sets the size policy for the scatter plot points. This is used to scale the size of the marker symbol based on a given field. Parameters: `sizePolicy: undefined \| SizePolicy` - No description. 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`
setTickSpacing	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 spacing `axisIndex: number` - The index of the axis 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.
setVerticalAxisLabelsBehavior	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. Returns: `void`
setXAxisField	Signature: `setXAxisField(fieldName: string): Promise` Description: Sets the x-axis field. Parameters: `fieldName: string` - No description. Returns: `Promise` Async: This method is async and must be awaited for the changes to take effect.
setXAxisScrollbar	Signature: `setXAxisScrollbar(scrollbar: WebChartAxisScrollBar): void` Description: Sets the x-axis scrollbar configuration. Parameters: `scrollbar: WebChartAxisScrollBar` - The x-axis scrollbar configuration. 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`
setXAxisValueFormat	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. Returns: `Promise` Async: This method is async and must be awaited for the changes to take effect.
setXLogarithmic	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. Returns: `Promise` Async: This method is async and must be awaited for the changes to take effect.
setYAxisField	Signature: `setYAxisField(fieldName: string): Promise` Description: Sets the y-axis field. Parameters: `fieldName: string` - No description. Returns: `Promise` Async: This method is async and must be awaited for the changes to take effect.
setYAxisScrollbar	Signature: `setYAxisScrollbar(scrollbar: WebChartAxisScrollBar): void` Description: Sets the y-axis scrollbar configuration. Parameters: `scrollbar: WebChartAxisScrollBar` - The y-axis scrollbar configuration. Returns: `void`
setYAxisTitleSymbol	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. Returns: `void`
setYAxisTitleText	Signature: `setYAxisTitleText(titleText: string): void` Description: Sets the Y-axis title text. Parameters: `titleText: string` - The Y-axis title text. Returns: `void`
setYAxisTitleVisibility	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. Returns: `void`
setYAxisValueFormat	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. Returns: `Promise` Async: This method is async and must be awaited for the changes to take effect.
setYLogarithmic	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. Returns: `Promise` Async: This method is async and must be awaited for the changes to take effect.