@arcgis/charts-components 5.0.0-next.1 → 5.0.0-next.100

package/dist/model/pie-chart-model/utils/pie-chart-series.d.ts

@@ -3,20 +3,20 @@ import { ChartConfig } from '../../../utils';
 import { ModelTypes, PieChartSlicesDisplay } from '../../interfaces/common';
 /**
  * Gets the inner radius size of the pie chart.
- * @param config The chart configuration.
- * @returns {number | null | undefined}
+ *
+ * @param config - The chart configuration.
  */
 export declare const getInnerRadiusSize: (config: ChartConfig<typeof ModelTypes.PieChart>) => number | null | undefined;
 /**
  * Sets the inner radius size of the pie chart.
- * @param radius The inner radius size for the pie chart.
- * @param config The chart configuration.
+ *
+ * @param radius - The inner radius size for the pie chart.
+ * @param config - The chart configuration.
  */
 export declare const setInnerRadiusSize: (radius: number, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the label character limit from the chart config.
  * @param config The chart configuration.
- * @returns {number | null | undefined}
  */
 export declare const getLabelCharacterLimit: (config: ChartConfig<typeof ModelTypes.PieChart>) => number | null | undefined;
 /**
@@ -28,7 +28,6 @@ export declare const setLabelCharacterLimit: (characterLimit: number | null, con
 /**
  * Gets the start angle of the pie chart.
  * @param config The chart configuration.
- * @returns {number | null | undefined}
  */
 export declare const getStartAngle: (config: ChartConfig<typeof ModelTypes.PieChart>) => number | null | undefined;
 /**
@@ -40,7 +39,6 @@ export declare const setStartAngle: (angle: number | null | undefined, config: C
 /**
  * Gets the end angle of the pie chart.
  * @param config The chart configuration.
- * @returns {number | null | undefined}
  */
 export declare const getEndAngle: (config: ChartConfig<typeof ModelTypes.PieChart>) => number | null | undefined;
 /**
@@ -51,35 +49,66 @@ export declare const getEndAngle: (config: ChartConfig<typeof ModelTypes.PieChar
 export declare const setEndAngle: (angle: number | null | undefined, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the display category value on tooltip setting from the chart config.
- * @param config The chart configuration.
- * @returns {boolean}
- * @remarks If the setting is not found in the config, it will default to `true`.
+ *
+ * **Note**: If the setting is not found in the config, it will default to `true`.
+ *
+ * @param config - The chart configuration.
  */
 export declare const getDisplayCategoryValueOnTooltip: (config: ChartConfig<typeof ModelTypes.PieChart>) => boolean;
 /**
  * Gets the display category value on data label setting from the chart config.
- * @param config The chart configuration.
- * @returns {boolean}
- * @remarks If the setting is not found in the config, it will default to `true`.
+ *
+ * **Note**: If the setting is not found in the config, it will default to `true`.
+ *
+ * @param config - The chart configuration.
  */
 export declare const getDisplayCategoryOnDataLabel: (config: ChartConfig<typeof ModelTypes.PieChart>) => boolean;
 /**
  * Sets the display category value on data label setting in the chart config.
- * @param display The boolean value to set the displayCategoryOnDataLabel to
- * @param config The chart configuration.
+ *
+ * @param display - The boolean value to set the displayCategoryOnDataLabel to
+ * @param config - The chart configuration.
  */
 export declare const setDisplayCategoryOnDataLabel: (display: boolean, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
- * Gets the display numeric value on tooltip setting from the chart config.
+ * Gets the display numeric value on data label setting from the chart config.
+ * @param config The chart configuration.
+ * @returns {boolean}
+ * **Note:** If the setting is not found in the config, it will default to `true`.
+ */
+export declare const getDisplayNumericValueOnDataLabel: (config: ChartConfig<typeof ModelTypes.PieChart>) => boolean;
+/**
+ * Sets the display numeric value on data label setting in the chart config.
+ * @param display The boolean value to set the displayNumericValueOnDataLabel to
+ * @param config The chart configuration.
+ */
+export declare const setDisplayNumericValueOnDataLabel: (display: boolean, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
+/**
+ * Gets whether the percentage is displayed on the data label.
  * @param config The chart configuration.
  * @returns {boolean}
- * @remarks If the setting is not found in the config, it will default to `true`.
+ * **Note:** If the setting is not found in the config, it will default to `false`.
+ */
+export declare const getDisplayPercentageOnDataLabel: (config: ChartConfig<typeof ModelTypes.PieChart>) => boolean;
+/**
+ * Whether to display the percentage on the data label.
+ * @param display The boolean value to set the displayPercentageOnDataLabel to
+ * @param config The chart configuration.
+ */
+export declare const setDisplayPercentageOnDataLabel: (display: boolean, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
+/**
+ * Gets the display numeric value on tooltip setting from the chart config.
+ *
+ * **Note**: If the setting is not found in the config, it will default to `true`.
+ *
+ * @param config - The chart configuration.
  */
 export declare const getDisplayNumericValueOnTooltip: (config: ChartConfig<typeof ModelTypes.PieChart>) => boolean;
 /**
  * Sets the display category value on tooltip setting in the chart config.
- * @param display The boolean value to set the displayCategoryOnTooltip to
- * @param config The chart configuration.
+ *
+ * @param display - The boolean value to set the displayCategoryOnTooltip to
+ * @param config - The chart configuration.
  */
 export declare const setDisplayCategoryOnTooltip: (display: boolean, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
@@ -90,69 +119,75 @@ export declare const setDisplayCategoryOnTooltip: (display: boolean, config: Cha
 export declare const setDisplayNumericValueOnTooltip: (display: boolean, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the display percentage on tooltip setting from the chart config.
- * @param config The chart configuration.
- * @returns {boolean}
- * @remarks If the setting is not found in the config, it will default to `true`.
+ *
+ * **Note**: If the setting is not found in the config, it will default to `true`.
+ *
+ * @param config - The chart configuration.
  */
 export declare const getDisplayPercentageOnTooltip: (config: ChartConfig<typeof ModelTypes.PieChart>) => boolean;
 /**
  * Sets the display percentage on tooltip setting in the chart config.
- * @param display The boolean value to set the displayPercentageOnTooltip to
- * @param config The chart configuration.
+ *
+ * @param display - The boolean value to set the `displayPercentageOnTooltip` to
+ * @param config - The chart configuration.
  */
 export declare const setDisplayPercentageOnTooltip: (display: boolean, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the prefix for the slice values in the chart config.
- * @param config The chart configuration.
- * @returns {string | undefined}
+ *
+ * @param config - The chart configuration.
  */
 export declare const getValuePrefix: (config: ChartConfig<typeof ModelTypes.PieChart>) => string | undefined;
 /**
  * Set the prefix for the slice values in the chart config.
- * @param prefix The prefix to set for the values in the chart config.
- * @param config The chart configuration.
+ *
+ * @param prefix - The prefix to set for the values in the chart config.
+ * @param config - The chart configuration.
  */
 export declare const setValuePrefix: (prefix: string | undefined, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the suffix for the slice values in the chart config.
- * @param config The chart configuration.
- * @returns {string | undefined}
+ *
+ * @param config - The chart configuration.
  */
 export declare const getValueSuffix: (config: ChartConfig<typeof ModelTypes.PieChart>) => string | undefined;
 /**
  * Sets the suffix for the slice values in the chart config.
- * @param suffix The suffix to set for the slice values in the chart config.
- * @param config The chart configuration.
+ *
+ * @param suffix - The suffix to set for the slice values in the chart config.
+ * @param config - The chart configuration.
  */
 export declare const setValueSuffix: (suffix: string | undefined, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the prefix for the slice percentage values in the chart config.
- * @param config The chart configuration.
- * @returns {string | undefined}
+ *
+ * @param config - The chart configuration.
  */
 export declare const getPercentagePrefix: (config: ChartConfig<typeof ModelTypes.PieChart>) => string | undefined;
 /**
  * Sets the prefix for the slice percentage values in the chart config.
- * @param prefix The prefix to set for the slice percentage values in the chart config.
- * @param config The chart configuration.
+ *
+ * @param prefix - The prefix to set for the slice percentage values in the chart config.
+ * @param config - The chart configuration.
  */
 export declare const setPercentagePrefix: (prefix: string | undefined, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the suffix for the slice percentage values in the chart config.
- * @param config The chart configuration.
- * @returns {string | undefined}
+ *
+ * @param config - The chart configuration.
  */
 export declare const getPercentageSuffix: (config: ChartConfig<typeof ModelTypes.PieChart>) => string | undefined;
 /**
  * Sets the suffix for the slice percentage values in the chart config.
- * @param suffix The suffix to set for the slice percentage values in the chart config.
- * @param config The chart configuration.
+ *
+ * @param suffix - The suffix to set for the slice percentage values in the chart config.
+ * @param config - The chart configuration.
  */
 export declare const setPercentageSuffix: (suffix: string | undefined, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the display type for the slices in the pie chart.
- * @param config The chart configuration.
- * @returns {PieChartSlicesDisplay}
+ *
+ * @param config - The chart configuration.
  */
 export declare const getDisplayType: (config: ChartConfig<typeof ModelTypes.PieChart>) => PieChartSlicesDisplay;
 /**
@@ -163,9 +198,10 @@ export declare const getDisplayType: (config: ChartConfig<typeof ModelTypes.PieC
 export declare const setDisplayType: (type: PieChartSlicesDisplay, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the setting for aligning the data labels in the chart config.
- * @param config The chart configuration.
- * @returns {boolean}
- * @remarks If the setting is not found in the config, it will default to `false`.
+ *
+ * **Note**: If the setting is not found in the config, it will default to `true`.
+ *
+ * @param config - The chart configuration.
  */
 export declare const getAlignDataLabels: (config: ChartConfig<typeof ModelTypes.PieChart>) => boolean;
 /**
@@ -176,76 +212,85 @@ export declare const getAlignDataLabels: (config: ChartConfig<typeof ModelTypes.
 export declare const setAlignDataLabels: (align: boolean | undefined, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the setting for placing the data labels inside of the slices from the chart config.
- * @param config The chart configuration.
- * @returns {boolean}
- * @remarks If the setting is not found in the config, it will default to `false`.
+ *
+ * **Note**: If the setting is not found in the config, it will default to `true`.
+ *
+ * @param config - The chart configuration.
  */
 export declare const getDataLabelsInside: (config: ChartConfig<typeof ModelTypes.PieChart>) => boolean;
 /**
  * Sets the setting for placing the data labels inside of the slices in the chart config.
- * @param align The boolean value to set the dataLabelsInside to
- * @param config The chart configuration.
+ *
+ * @param align - The boolean value to set the dataLabelsInside to
+ * @param config - The chart configuration.
  */
 export declare const setDataLabelsInside: (align: boolean | undefined, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the data labels offset from the chart config.
- * @param config The chart configuration.
- * @returns {number}
- * @remarks If the setting is not found in the config, it will default to `10`.
+ *
+ * **Note**: If the setting is not found in the config, it will default to `10`.
+ *
+ * @param config - The chart configuration.
  */
 export declare const getDataLabelsOffset: (config: ChartConfig<typeof ModelTypes.PieChart>) => number;
 /**
  * Sets the data labels offset in the chart config.
- * @param offset The offset to set for the data labels in the chart config.
- * @param config The chart configuration.
+ *
+ * @param offset - The offset to set for the data labels in the chart config.
+ * @param config - The chart configuration.
  */
 export declare const setDataLabelsOffset: (offset: number | undefined, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the decimal places limit from the chart config.
- * @param config The chart configuration.
- * @returns {number | undefined}
+ *
+ * @param config - The chart configuration.
  */
 export declare const getDecimalPlaces: (config: ChartConfig<typeof ModelTypes.PieChart>) => number | undefined;
 /**
  * Sets the decimal places limit for numeric value and percent value formats in the chart config.
- * @param decimalPlaces The decimal places limit to set in the chart config.
- * @param config The chart configuration.
+ *
+ * @param decimalPlaces - The decimal places limit to set in the chart config.
+ * @param config - The chart configuration.
  */
 export declare const setDecimalPlaces: (decimalPlaces: number, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the setting for optimizing data labels overlapping in the chart config.
- * @param config The chart configuration.
- * @returns {boolean}
- * @remarks If the setting is not found in the config, it will default to `false`.
+ *
+ * **Note**: If the setting is not found in the config, it will default to `false`.
+ *
+ * @param config - The chart configuration.
  */
 export declare const getOptimizeDataLabelsOverlapping: (config: ChartConfig<typeof ModelTypes.PieChart>) => boolean;
 /**
  * Sets the setting for optimizing data labels overlapping in the chart config.
- * @param optimize The boolean value to set the optimizeDataLabelsOverlapping to
- * @param config The chart configuration.
+ *
+ * @param optimize - The boolean value to set the `optimizeDataLabelsOverlapping` to
+ * @param config - The chart configuration.
  */
 export declare const setOptimizeDataLabelsOverlapping: (optimize: boolean | undefined, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the ticks' visible setting from the chart config.
+ *
  * @param config - The chart configuration.
- * @returns {boolean}
  */
 export declare const getTicksVisibility: (config: ChartConfig<typeof ModelTypes.PieChart>) => boolean;
 /**
  * Sets the ticks' visible setting in the chart config.
+ *
  * @param visibility - The visibility setting for the ticks.
  * @param config - The chart configuration.
  */
 export declare const setTicksVisibility: (visibility: boolean, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the ticks' symbol from the chart config.
- * @param config The chart configuration.
- * @returns {ISimpleLineSymbol | undefined}
+ *
+ * @param config - The chart configuration.
  */
 export declare const getTicksSymbol: (config: ChartConfig<typeof ModelTypes.PieChart>) => ISimpleLineSymbol | undefined;
 /**
  * Sets the ticks' symbol in the chart config.
- * @param config The chart configuration.
- * @param linesSymbol The ticks' symbol to set.
+ *
+ * @param config - The chart configuration.
+ * @param linesSymbol - The ticks' symbol to set.
  */
 export declare const setTicksSymbol: (linesSymbol: ISimpleLineSymbol | undefined, config: ChartConfig<typeof ModelTypes.PieChart>) => void;

package/dist/model/pie-chart-model/utils/pie-chart-slices.d.ts

@@ -6,7 +6,6 @@ export declare const getOriginalName: (sliceIndex: number, config: ChartConfig<t
  * Gets the name of the slice
  * @param sliceIndex The index of the slice
  * @param config The chart configuration
- * @returns {string | undefined}
  */
 export declare const getName: (sliceIndex: number, config: ChartConfig<typeof ModelTypes.PieChart>) => string | undefined;
 /**
@@ -20,7 +19,6 @@ export declare const setName: (name: string, sliceIndex: number, config: ChartCo
  * Gets the color of the slice
  * @param sliceIndex The index of the slice
  * @param config The chart configuration
- * @returns {Color | undefined}
  */
 export declare const getColor: (sliceIndex: number, config: ChartConfig<typeof ModelTypes.PieChart>) => Color | undefined;
 /**
@@ -33,7 +31,6 @@ export declare const setColor: (color: Color | undefined, sliceIndex: number, co
 /**
  * Gets original values of the slice
  * @param config The chart configuration
- * @returns {string[] | undefined}
  */
 export declare const getOrderOfSlices: (config: ChartConfig<typeof ModelTypes.PieChart>) => string[] | undefined;
 /**
@@ -45,7 +42,6 @@ export declare const setOrderOfSlices: (sliceOrder: string[], config: ChartConfi
 /**
  * Gets the grouping of slices
  * @param config The chart configuration
- * @returns {WebChartPieChartGroupSlice | undefined}
  */
 export declare const getSliceGrouping: (config: ChartConfig<typeof ModelTypes.PieChart>) => WebChartPieChartGroupSlice | undefined;
 /**
@@ -57,7 +53,6 @@ export declare const setSliceGrouping: (sliceGrouping: WebChartPieChartGroupSlic
 /**
  * Gets the grouping threshold
  * @param config The chart configuration
- * @returns {number | undefined}
  */
 export declare const getGroupingThreshold: (config: ChartConfig<typeof ModelTypes.PieChart>) => number | undefined;
 /**
@@ -69,7 +64,6 @@ export declare const setGroupingThreshold: (groupingThreshold: number, config: C
 /**
  * Gets the slices of the pie chart
  * @param config The chart configuration
- * @returns {WebChartPieChartSlice[] | undefined}
  */
 export declare const getSlices: (config: ChartConfig<typeof ModelTypes.PieChart>) => WebChartPieChartSlice[] | undefined;
 /**
@@ -87,19 +81,16 @@ export declare const resetSlices: (config: ChartConfig<typeof ModelTypes.PieChar
  * Gets the slice id
  * @param sliceIndex The index of the slice
  * @param config The chart configuration
- * @returns {string | undefined}
  */
 export declare const getSliceId: (sliceIndex: number, config: ChartConfig<typeof ModelTypes.PieChart>) => string | undefined;
 /**
  * Gets the slice index
  * @param sliceId The slice id
  * @param config The chart configuration
- * @returns {number | undefined}
  */
 export declare const getSliceIndex: (sliceId: string, config: ChartConfig<typeof ModelTypes.PieChart>) => number | undefined;
 /**
  * Gets the number of slices in a pie chart
  * @param config The chart configuration
- * @returns {number}
  */
 export declare const getSlicesLength: (config: ChartConfig<typeof ModelTypes.PieChart>) => number;

package/dist/model/properties/background-color.d.ts

@@ -0,0 +1,21 @@
+import { Color } from '../../spec';
+import { ChartConfig } from '../../utils/types';
+import { ChartModelBase } from '../chart-model/chart-model-base';
+/**
+ * Gets the background color from the chart config.
+ */
+export declare const getBackgroundColor: (config: ChartConfig) => Color | undefined;
+/**
+ * Sets the background color on the chart config.
+ */
+export declare const setBackgroundColor: (backgroundColor: Color | undefined, config: ChartConfig) => void;
+/**
+ * Adds support for working with the chart background color.
+ */
+export declare abstract class WithBackgroundColor extends ChartModelBase {
+    /**
+     * The background color of the chart.
+     */
+    get backgroundColor(): Color | undefined;
+    set backgroundColor(backgroundColor: Color | undefined);
+}

package/dist/model/properties/chart-id.d.ts

@@ -0,0 +1,20 @@
+import { ChartConfig } from '../../utils';
+import { ChartModelBase } from '../chart-model/chart-model-base';
+/**
+ * Gets the chart ID from the config.
+ */
+export declare const getChartId: (config: ChartConfig) => string | undefined;
+/**
+ * Sets the chart ID in the config.
+ */
+export declare const setChartId: (id: string | undefined, config: ChartConfig) => void;
+/**
+ * Adds getter/setter support for the chart identifier.
+ */
+export declare abstract class WithChartId extends ChartModelBase {
+    /**
+     * The chart ID.
+     */
+    get chartId(): string | undefined;
+    set chartId(id: string | undefined);
+}

package/dist/model/properties/chart-renderer.d.ts

@@ -0,0 +1,21 @@
+import { IDrawingInfo } from '../../spec';
+import { ChartConfig } from '../../utils/types';
+import { ChartModelBase } from '../chart-model/chart-model-base';
+/**
+ * Gets the chart renderer from the config.
+ */
+export declare const getChartRenderer: (config: ChartConfig) => IDrawingInfo["renderer"] | undefined;
+/**
+ * Sets the chart renderer on the config.
+ */
+export declare const setChartRenderer: (renderer: IDrawingInfo["renderer"] | undefined, config: ChartConfig) => void;
+/**
+ * Adds support for working with chart renderer.
+ */
+export declare abstract class WithChartRenderer extends ChartModelBase {
+    /**
+     * The chart renderer.
+     */
+    get chartRenderer(): IDrawingInfo["renderer"] | undefined;
+    set chartRenderer(renderer: IDrawingInfo["renderer"]);
+}

package/dist/model/properties/chart-sub-type.d.ts

@@ -0,0 +1,15 @@
+import { ChartConfig, ChartSubType } from '../../utils';
+import { ChartModelBase } from '../chart-model/chart-model-base';
+/**
+ * Gets the chart sub type for the current series configuration.
+ */
+export declare const getSeriesChartSubType: (config: ChartConfig) => ChartSubType;
+/**
+ * Adds support for reading the chart sub type.
+ */
+export declare abstract class WithChartSubType extends ChartModelBase {
+    /**
+     * The chart sub type of the series.
+     */
+    get chartSubType(): ChartSubType;
+}

package/dist/model/properties/chart-type.d.ts

@@ -0,0 +1,10 @@
+import { ChartModelBase } from '../chart-model/chart-model-base';
+/**
+ * Adds getter support for the chart type.
+ */
+export declare abstract class WithChartType extends ChartModelBase {
+    /**
+     * The chart type.
+     */
+    get chartType(): typeof this._chartType;
+}

package/dist/model/properties/config.d.ts

@@ -0,0 +1,12 @@
+import { ChartModelBase } from '../chart-model/chart-model-base';
+import { ChartConfig } from '../../utils';
+/**
+ * Adds getter/setter support for the chart configuration object.
+ */
+export declare abstract class WithConfig extends ChartModelBase {
+    /**
+     * The current chart configuration object.
+     */
+    get config(): ChartConfig;
+    set config(config: ChartConfig);
+}

package/dist/model/properties/data-filters.d.ts

@@ -0,0 +1,26 @@
+import { WebChartDataFilters } from '../../spec';
+import { ChartConfig } from '../../utils';
+import { ChartModelBase } from '../chart-model/chart-model-base';
+/**
+ * Get the data filter from the config.
+ */
+export declare const getDataFilters: (config: ChartConfig) => WebChartDataFilters | undefined;
+/**
+ * Set the data filter in the config.
+ */
+export declare const setDataFilters: (dataFilter: WebChartDataFilters | undefined, config: ChartConfig) => void;
+/**
+ * Adds support for working with chart data filters.
+ */
+export declare abstract class WithDataFilters extends ChartModelBase {
+    /**
+     * Gets the data filter for the bar chart.
+     */
+    getDataFilters(): WebChartDataFilters | undefined;
+    /**
+     * Sets the data filter for the chart.
+     *
+     * @param newDataFilters - The new data filter.
+     */
+    setDataFilters(newDataFilters: WebChartDataFilters | undefined): Promise<void>;
+}

package/dist/model/properties/data-tooltip-value-format.d.ts

@@ -0,0 +1,34 @@
+import { NumberFormatOptions, WebChartSeriesType } from '../../spec';
+import { ChartModelBase } from '../chart-model/chart-model-base';
+/**
+ * Gets the data tooltip value format for a series from the chart series collection.
+ */
+export declare const getDataTooltipValueFormat: (series: WebChartSeriesType[], seriesIndex: number) => NumberFormatOptions | undefined;
+/**
+ * Sets the data tooltip value format for a series in the chart series collection.
+ */
+export declare const setDataTooltipValueFormat: (props: {
+    series: WebChartSeriesType[];
+    seriesIndex: number;
+    valueFormat: NumberFormatOptions | undefined;
+}) => void;
+/**
+ * Adds support for working with data tooltip value formats.
+ */
+export declare abstract class WithSeriesDataTooltipValueFormat extends ChartModelBase {
+    /**
+     * Gets the data tooltip value format for a series.
+     *
+     * If the series index is out of bounds or the series list is empty, this function will return `undefined`.
+     *
+     * @param seriesIndex - The index of the series to retrieve the value format for.
+     */
+    getDataTooltipValueFormat(seriesIndex: number): NumberFormatOptions | undefined;
+    /**
+     * Sets the data tooltip value format for a series.
+     *
+     * @param seriesIndex - The index of the series to set the value format for.
+     * @param valueFormat - The value format to set.
+     */
+    setDataTooltipValueFormat(seriesIndex: number, valueFormat: NumberFormatOptions | undefined): void;
+}

package/dist/model/properties/description/description-symbol.d.ts

@@ -0,0 +1,21 @@
+import { WebChartTextSymbol } from '../../../spec/web-chart';
+import { ChartConfig } from '../../../utils/types';
+import { ChartModelBase } from '../../chart-model/chart-model-base';
+/**
+ * Gets the description text symbol from the chart config.
+ */
+export declare const getDescriptionSymbol: (config: ChartConfig) => WebChartTextSymbol | undefined;
+/**
+ * Sets the description text symbol in the chart config.
+ */
+export declare const setDescriptionSymbol: (textSymbol: WebChartTextSymbol | undefined, config: ChartConfig) => void;
+/**
+ * Adds support for working with chart description symbols.
+ */
+export declare abstract class WithDescriptionSymbol extends ChartModelBase {
+    /**
+     * The description text symbol. Contains styling information such as font, color, and symbol style.
+     */
+    get descriptionSymbol(): WebChartTextSymbol | undefined;
+    set descriptionSymbol(descriptionSymbol: WebChartTextSymbol | undefined);
+}

package/dist/model/properties/description/description-text.d.ts

@@ -0,0 +1,17 @@
+import { ChartConfig } from '../../../utils';
+import { ChartModelBase } from '../../chart-model/chart-model-base';
+/**
+ * Gets the description text from the chart config.
+ */
+export declare const getDescriptionText: (config: ChartConfig) => string;
+/**
+ * Sets the description text on the chart config.
+ */
+export declare const setDescriptionText: (descriptionText: string, config: ChartConfig) => void;
+/**
+ * Adds support for working with chart description text.
+ */
+export declare abstract class WithDescriptionText extends ChartModelBase {
+    get descriptionText(): string;
+    set descriptionText(description: string);
+}

package/dist/model/properties/description/description-visibility.d.ts

@@ -0,0 +1,26 @@
+import { ChartConfig } from '../../../utils/types';
+import { ChartModelBase } from '../../chart-model/chart-model-base';
+/**
+ * Gets whether the chart description is visible.
+ */
+export declare const getDescriptionVisibility: (config: ChartConfig) => boolean;
+/**
+ * Sets whether the chart description is visible.
+ */
+export declare const setDescriptionVisibility: (visibility: boolean, config: ChartConfig) => void;
+/**
+ * Adds support for working with chart description visibility.
+ */
+export declare abstract class WithDescriptionVisibility extends ChartModelBase {
+    /**
+     * Whether or not the chart description is visible.
+     *
+     * `true`: Description is visible.
+     *
+     * `false`: Description is hidden.
+     *
+     * **Note:** Even if the description is visible, it may not be displayed if the description text is empty.
+     */
+    get descriptionVisibility(): boolean;
+    set descriptionVisibility(visibility: boolean);
+}