@geoscene/charts-components 5.0.19

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

@@ -0,0 +1,199 @@
+import type { ChartModel } from "../chart-model/chart-model.js";
+import type { ModelParams } from "../interfaces/chart-interfaces.js";
+import type { ModelTypes, PieChartDataSortingKinds, PieChartSlicesDisplay, PieChartDataModes } from "../interfaces/common.js";
+import type { WithColorMatch } from "../properties/color-match.js";
+import type { WithDataLabelsVisibility } from "../properties/data-labels/data-labels-visibility.js";
+import type { WithDataLabelsSymbol } from "../properties/data-labels/data-labels-symbol.js";
+import type { PieChartLegendModel } from "./pie-chart-legend-model.js";
+import type { ChartConfig } from "../../utils/types/index.js";
+import type { WebChartPieChartGroupSlice, WebChartPieChartSlice } from "../../spec/web-chart.js";
+import type { WebChartStatisticType } from "../../spec/chart-object-literals.js";
+import type { Color, ISimpleLineSymbol } from "../../spec/rest-js-types.js";
+import type { ModelWithTooltips } from "../mixins/model-with-tooltips.js";
+
+export class PieChartModel extends PieChartModelSuperclass {
+  /** Aggregation type for the pie chart. */
+  accessor aggregationType: WebChartStatisticType;
+  /** Align the data labels on the left or right side of the chart instead of the default position around the chart. */
+  accessor alignDataLabels: boolean | undefined;
+  /** Category field for the pie chart. */
+  accessor category: string;
+  /** Setting for placing the data labels inside of the slices. */
+  accessor dataLabelsInside: boolean | undefined;
+  /** Offset for the data labels. */
+  accessor dataLabelsOffset: number;
+  /** Number of decimal places to display in the slice values. */
+  accessor decimalPlaces: number;
+  /**
+   * Whether to display the category on the data label.
+   * **Note:** If the setting is not found in the config, it will default to `true`.
+   */
+  accessor displayCategoryOnDataLabel: boolean;
+  /**
+   * Display category value on tooltip setting from the chart config.
+   *
+   * **Note**: If the setting is not found in the config, it will default to `true`.
+   */
+  accessor displayCategoryValueOnTooltip: boolean;
+  /**
+   * Whether to display the numeric value on the data label.
+   * **Note:** If the setting is not found in the config, it will default to `true`.
+   */
+  accessor displayNumericValueOnDataLabel: boolean;
+  /**
+   * 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`.
+   */
+  accessor displayNumericValueOnTooltip: boolean;
+  /**
+   * Whether to display the percentage on the data label.
+   *
+   * **Note:** If the setting is not found in the config, it will default to `true`.
+   */
+  accessor displayPercentageOnDataLabel: boolean;
+  /**
+   * Display percentage on tooltip setting from the chart config.
+   *
+   * **Note**: If the setting is not found in the config, it will default to `true`.
+   */
+  accessor displayPercentageOnTooltip: boolean;
+  /** Display type for the pie chart slices. Specifies whether to display the slices as a `percentage`, `value`, or `both`. */
+  accessor displayType: PieChartSlicesDisplay;
+  /** End angle of the pie chart. */
+  accessor endAngle: number | null | undefined;
+  /** Array of grouped slice ids for the pie chart. */
+  accessor groupedSliceIds: string[];
+  /** Threshold below which slices will be grouped. */
+  accessor groupingThreshold: number;
+  /** Inner radius size for the pie chart. */
+  accessor innerRadiusSize: number;
+  /** Character limit for the slice labels. */
+  accessor labelCharacterLimit: number | null;
+  /**
+   * The pie chart data mode.
+   *
+   * `category` - The chart is using values from the category field to determine each slice.
+   * `fields` - The chart is using aggregated values from the numeric fields to determine each slice.
+   */
+  accessor mode: PieChartDataModes;
+  /** Numeric fields for the pie chart. */
+  get numericFields(): string[];
+  set numericFields(value: string[] | string);
+  /** Optimize data labels overlapping setting for the pie chart. */
+  accessor optimizeDataLabelsOverlapping: boolean | undefined;
+  /**
+   * List of category's values for custom sort.
+   *
+   * @example
+   * ```ts
+   * pieChartModel.orderByList = ["Field1", "Field2", "Field3"];
+   * ```
+   */
+  accessor orderByList: string[];
+  /** Order of the slice array by returning an array of slice ids */
+  accessor orderOfSlices: string[] | undefined;
+  /** Prefix of the percentages of the slices. */
+  accessor percentagePrefix: string | undefined;
+  /** Suffix of the percentages of the slices. */
+  accessor percentageSuffix: string | undefined;
+  /** Slice grouping configuration for the pie chart. */
+  accessor sliceGrouping: WebChartPieChartGroupSlice | undefined;
+  /** Array of slices for the pie chart. */
+  accessor slices: WebChartPieChartSlice[] | undefined;
+  /** Start angle of the pie chart. */
+  accessor startAngle: number | null | undefined;
+  /** Ticks symbol connecting slices to labels. */
+  accessor ticksSymbol: ISimpleLineSymbol | undefined;
+  /** Visibility of the ticks. */
+  accessor ticksVisibility: boolean;
+  /** Prefix of the values of the slices. */
+  accessor valuePrefix: string | undefined;
+  /** Suffix of the values of the slice. */
+  accessor valueSuffix: string | undefined;
+  /** Generate the proper chart title given the current config. */
+  generateChartTitle(): string;
+  /** Gets the list of the category values for the chart. */
+  getCustomSortValues(): Promise<string[]>;
+  /**
+   * Gets the original name of the slice based on the slice index.
+   *
+   * @param sliceIndex - The index of the slice.
+   */
+  getOriginalSliceName(sliceIndex: number): Date | number | string | null | undefined;
+  /**
+   * Gets the color of the slice based on the slice index. If the index is out of bounds, this function will return `undefined`.
+   *
+   * @param sliceIndex - The index of the slice.
+   */
+  getSliceColor(sliceIndex: number): Color | undefined;
+  /**
+   * Gets the slice id for a given slice index. If the index is out of bounds, this function will return `undefined`.
+   *
+   * @param sliceIndex - The index of the slice.
+   */
+  getSliceId(sliceIndex: number): string | undefined;
+  /**
+   * Gets the slice index for a given slice id. If the `sliceId` is not found, this function will return `undefined`.
+   *
+   * @param sliceId - The id of the slice.
+   */
+  getSliceIndex(sliceId: string): number | undefined;
+  /**
+   * Gets the name of the slice based on the slice index. If the index is out of bounds, this function will return `undefined`.
+   *
+   * @param sliceIndex - The index of the slice.
+   */
+  getSliceName(sliceIndex: number): string | undefined;
+  /** Gets the length of the slices array. */
+  getSlicesLength(): number;
+  /** Gets the sort order for the pie chart. */
+  getSortOrder(): PieChartDataSortingKinds;
+  /**
+   * 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 `customSort`.
+   *
+   * @param fromIndex - The index to move the custom sort item from.
+   * @param toIndex - The index to move the category item to.
+   */
+  moveCustomSortValuesInOrderByList(fromIndex: number, toIndex: number): void;
+  /**
+   * Moves a series from one index in the series array to another.
+   *
+   * @param fromIndex - Index to move the series from.
+   * @param toIndex - Index to move the series to.
+   */
+  moveSeries(fromIndex: number, toIndex: number): void;
+  /** Returns whether the series styling is able to be reset. */
+  resetAvailable(): boolean;
+  /** Resets the slices styling to the default styling. */
+  resetSlices(): void;
+  /**
+   * Sets the color of the slice based on the slice index.
+   *
+   * @param color - The color for the slice.
+   * @param sliceIndex - The index of the slice.
+   */
+  setSliceColor(color: Color | undefined, sliceIndex: number): void;
+  /**
+   * Sets name of the slice based on the slice index.
+   *
+   * @param name - The name for the slice.
+   * @param sliceIndex - The index of the slice.
+   */
+  setSliceName(name: string, sliceIndex: number): void;
+  /**
+   * Sets the sort order for the pie chart.
+   *
+   * @param sortOrder - The sort order.
+   * @param orderByList - The list of category values.
+   */
+  setSortOrder(sortOrder: PieChartDataSortingKinds, orderByList?: string[]): void;
+  /**
+   * Completes the async setup process for the chart model. Must be called before using the model.
+   *
+   * @param params
+   */
+  setup(params: ModelParams<ChartConfig<typeof ModelTypes.PieChart>>): Promise<void>;
+}
+declare const PieChartModelSuperclass: typeof ChartModel & typeof WithDataLabelsSymbol & typeof WithDataLabelsVisibility & typeof WithColorMatch & typeof ModelWithTooltips & typeof PieChartLegendModel

package/dist/model/properties/axes/axis-labels-symbol.d.ts

@@ -0,0 +1,8 @@
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+import type { WebChartTextSymbol } from "../../../spec/web-chart.js";
+
+/** Adds support for configuring the axis labels symbol. */
+export abstract class WithAxisLabelsSymbol extends ChartModelBase {
+  /** Axis labels text symbol (font, color, style). */
+  accessor axisLabelsSymbol: WebChartTextSymbol | undefined;
+}

package/dist/model/properties/axes/axis-lines-symbol.d.ts

@@ -0,0 +1,8 @@
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+import type { ISimpleLineSymbol } from "../../../spec/rest-js-types.js";
+
+/** Adds support for configuring the axis lines symbol. */
+export abstract class WithAxisLinesSymbol extends ChartModelBase {
+  /** Axis lines symbol (line width, style, color). */
+  accessor axisLinesSymbol: ISimpleLineSymbol | undefined;
+}

package/dist/model/properties/axes/x-axis/generate-x-axis-title.d.ts

@@ -0,0 +1,7 @@
+import type { ChartModelBase } from "../../../chart-model/chart-model-base.js";
+
+/** Adds support for computing an x-axis title based on chart type. */
+export abstract class WithGenerateXAxisTitle extends ChartModelBase {
+  /** Generate the proper x-axis title from the current config. */
+  generateXAxisTitle(): string;
+}

package/dist/model/properties/axes/x-axis/max-x-bound.d.ts

@@ -0,0 +1,11 @@
+import type { ChartModelBase } from "../../../chart-model/chart-model-base.js";
+
+/** Adds support for configuring the maximum x-axis bound. */
+export abstract class WithMaxXBound extends ChartModelBase {
+  /**
+   * Maximum bound set for the x-axis.
+   *
+   * `null` indicates no explicit maximum.
+   */
+  accessor maxXBound: number | null;
+}

package/dist/model/properties/axes/x-axis/min-x-bound.d.ts

@@ -0,0 +1,11 @@
+import type { ChartModelBase } from "../../../chart-model/chart-model-base.js";
+
+/** Adds support for configuring the minimum x-axis bound. */
+export abstract class WithMinXBound extends ChartModelBase {
+  /**
+   * Minimum bound set for the x-axis.
+   *
+   * `null` indicates no explicit minimum.
+   */
+  accessor minXBound: number | null;
+}

package/dist/model/properties/axes/x-axis/x-axis-labels-visibility.d.ts

@@ -0,0 +1,7 @@
+import type { ChartModelBase } from "../../../chart-model/chart-model-base.js";
+
+/** Adds support for configuring the x-axis labels visibility. */
+export abstract class WithXAxisLabelsVisibility extends ChartModelBase {
+  /** Whether the x-axis labels are visible. */
+  accessor xAxisLabelsVisibility: boolean;
+}

package/dist/model/properties/axes/x-axis/x-axis-title-symbol.d.ts

@@ -0,0 +1,8 @@
+import type { WebChartTextSymbol } from "../../../../spec/web-chart.js";
+import type { ChartModelBase } from "../../../chart-model/chart-model-base.js";
+
+/** Adds support for configuring the x-axis title symbol. */
+export abstract class WithXAxisTitleSymbol extends ChartModelBase {
+  /** X-axis title text symbol (font, color, style). */
+  accessor xAxisTitleSymbol: WebChartTextSymbol | undefined;
+}

package/dist/model/properties/axes/x-axis/x-axis-title-text.d.ts

@@ -0,0 +1,7 @@
+import type { ChartModelBase } from "../../../chart-model/chart-model-base.js";
+
+/** Adds support for configuring the x-axis title text. */
+export abstract class WithXAxisTitleText extends ChartModelBase {
+  /** The x-axis title text. */
+  accessor xAxisTitleText: string;
+}

package/dist/model/properties/axes/x-axis/x-axis-title-visibility.d.ts

@@ -0,0 +1,11 @@
+import type { ChartModelBase } from "../../../chart-model/chart-model-base.js";
+
+/** Adds support for toggling the x-axis title visibility. */
+export abstract class WithXAxisTitleVisibility extends ChartModelBase {
+  /**
+   * Whether the x-axis title is visible.
+   * `true`: X-axis title is visible.
+   * `false`: X-axis title is hidden.
+   */
+  accessor xAxisTitleVisibility: boolean;
+}

package/dist/model/properties/axes/x-axis/x-bounds.d.ts

@@ -0,0 +1,8 @@
+import type { ChartModelBase } from "../../../chart-model/chart-model-base.js";
+import type { WithMaxXBound } from "./max-x-bound.js";
+import type { WithMinXBound } from "./min-x-bound.js";
+
+/** Adds support for configuring both minimum and maximum x-axis bounds. */
+export abstract class WithXBounds extends ChartModelBase {}
+
+export interface WithXBounds extends WithMaxXBound, WithMinXBound {}

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

@@ -0,0 +1,8 @@
+import type { Color } from "../../spec/rest-js-types.js";
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+
+/** Adds support for working with the chart background color. */
+export abstract class WithBackgroundColor extends ChartModelBase {
+  /** The background color of the chart. */
+  accessor backgroundColor: Color | undefined;
+}

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

@@ -0,0 +1,7 @@
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+
+/** Adds getter/setter support for the chart identifier. */
+export abstract class WithChartId extends ChartModelBase {
+  /** The chart ID. */
+  accessor chartId: string | undefined;
+}

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

@@ -0,0 +1,52 @@
+import type { IDrawingInfo } from "../../spec/rest-js-types.js";
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+
+/** Adds support for working with chart renderer. */
+export abstract class WithChartRenderer extends ChartModelBase {
+  /**
+   * The chart renderer.
+   *
+   * @example
+   * In this example, we set the chartRenderer for a class-break heat chart.
+   * ```ts
+   * heatChartModel.chartRenderer = {
+   *    "type": "classBreaks",
+   *    "field": "geoscene_charts_heat_chart_value",
+   *    "classBreakInfos": [
+   *        {
+   *          "label": "70 - 145",
+   *          "classMinValue": 70,
+   *          "classMaxValue": 145,
+   *          "symbol": {
+   *            "type": "esriSFS",
+   *            "color": [
+   *              212,
+   *              227,
+   *              255,
+   *              255
+   *            ],
+   *            "style": "esriSFSSolid"
+   *          }
+   *        },
+   *        {
+   *          "label": "146 - 250",
+   *          "classMinValue": 146,
+   *          "classMaxValue": 250,
+   *          "symbol": {
+   *            "type": "esriSFS",
+   *            "color": [
+   *              43,
+   *              108,
+   *              240,
+   *              255
+   *            ],
+   *            "style": "esriSFSSolid"
+   *          }
+   *        }
+   *    ]
+   *  };
+   * ```
+   */
+  get chartRenderer(): IDrawingInfo["renderer"] | undefined;
+  set chartRenderer(value: IDrawingInfo["renderer"]);
+}

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

@@ -0,0 +1,8 @@
+import type { ChartSubType } from "../../utils/misc/interfaces.js";
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+
+/** Adds support for reading the chart sub type. */
+export abstract class WithChartSubType extends ChartModelBase {
+  /** The chart sub type of the series. */
+  get chartSubType(): ChartSubType;
+}

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

@@ -0,0 +1,12 @@
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+
+/** Adds support for matching colors between the chart and its data source. */
+export abstract class WithColorMatch extends ChartModelBase {
+  /**
+   * 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.
+   */
+  accessor colorMatch: boolean;
+}

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

@@ -0,0 +1,8 @@
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+import type { ChartConfig } from "../../utils/types/index.js";
+
+/** Adds getter/setter support for the chart configuration object. */
+export abstract class WithConfig extends ChartModelBase {
+  /** The current chart configuration object. */
+  accessor config: ChartConfig;
+}

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

@@ -0,0 +1,14 @@
+import type { WebChartDataFilters } from "../../spec/web-chart.js";
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+
+/** Adds support for working with chart data filters. */
+export 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-labels/data-labels-symbol.d.ts

@@ -0,0 +1,8 @@
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+import type { WebChartTextSymbol } from "../../../spec/web-chart.js";
+
+/** Adds support for working with the data labels symbol. */
+export abstract class WithDataLabelsSymbol extends ChartModelBase {
+  /** Data labels text symbol (font, color, style). */
+  accessor dataLabelsSymbol: WebChartTextSymbol | undefined;
+}

package/dist/model/properties/data-labels/data-labels-visibility.d.ts

@@ -0,0 +1,7 @@
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for working with the data labels visibility. */
+export abstract class WithDataLabelsVisibility extends ChartModelBase {
+  /** Whether data labels are visible. */
+  accessor dataLabelsVisibility: boolean;
+}

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

@@ -0,0 +1,21 @@
+import type { NumberFormatOptions } from "../../spec/web-chart.js";
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+
+/** Adds support for working with data tooltip value formats. */
+export 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,8 @@
+import type { WebChartTextSymbol } from "../../../spec/web-chart.js";
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for working with chart description symbols. */
+export abstract class WithDescriptionSymbol extends ChartModelBase {
+  /** The description text symbol. Contains styling information such as font, color, and symbol style. */
+  accessor descriptionSymbol: WebChartTextSymbol | undefined;
+}

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

@@ -0,0 +1,6 @@
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for working with chart description text. */
+export abstract class WithDescriptionText extends ChartModelBase {
+  accessor descriptionText: string;
+}

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

@@ -0,0 +1,11 @@
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for working with chart description visibility. */
+export abstract class WithDescriptionVisibility extends ChartModelBase {
+  /**
+   * Whether or not the chart description is visible.
+   *
+   * **Note:** Even if the description is visible, it may not be displayed if the description text is empty.
+   */
+  accessor descriptionVisibility: boolean;
+}

package/dist/model/properties/fetch-null-values.d.ts

@@ -0,0 +1,7 @@
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+
+/** Adds support for working with the fetch NULL values flag. */
+export abstract class WithFetchNULLValues extends ChartModelBase {
+  /** Whether to fetch `null` values for them to be counted or displayed as categories on the chart. */
+  accessor fetchNULLValues: boolean;
+}

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

@@ -0,0 +1,8 @@
+import type { SupportedLayer } from "../../interfaces.js";
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+
+/** Adds getter support for the associated layer reference. */
+export abstract class WithLayer extends ChartModelBase {
+  /** The chart model's layer. */
+  get layer(): SupportedLayer | undefined;
+}

package/dist/model/properties/rotated-state.d.ts

@@ -0,0 +1,7 @@
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+
+/** Adds support for working with the chart rotated state. */
+export abstract class WithRotatedState extends ChartModelBase {
+  /** Whether the chart is rotated. */
+  accessor rotatedState: boolean;
+}

package/dist/model/properties/series/negative-values-stacked-to-baseline.d.ts

@@ -0,0 +1,22 @@
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for configuring whether negative values stack against the baseline. */
+export abstract class WithNegativeValuesStackedToBaseline extends ChartModelBase {
+  /**
+   * Specify how negative values are treated in stacked 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.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  isNegativeValuesStackedToBaseline(seriesIndex: number): boolean;
+  /**
+   * Specify how negative values are treated in stacked 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.
+   *
+   * @param stackNegativeValuesToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
+   * @param seriesIndex - The index of the series.
+   */
+  setNegativeValuesStackedToBaseline(stackNegativeValuesToBaseline: boolean, seriesIndex: number): void;
+}

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

@@ -0,0 +1,12 @@
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for retrieving a series ID. */
+export abstract class WithSeriesId extends ChartModelBase {
+  /**
+   * Gets the series ID for a given series index.
+   * If the series index is out of bounds, this function will return `undefined`.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  getSeriesId(seriesIndex: number): string | undefined;
+}

package/dist/model/properties/series/series-index.d.ts

@@ -0,0 +1,12 @@
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for retrieving a series index. */
+export abstract class WithSeriesIndex extends ChartModelBase {
+  /**
+   * Gets the series index for a given series ID.
+   * If the series ID is not found, this function will return `undefined`.
+   *
+   * @param seriesId - The ID of the series.
+   */
+  getSeriesIndex(seriesId: string): number | undefined;
+}

package/dist/model/properties/series/series-length.d.ts

@@ -0,0 +1,7 @@
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for reading the series length. */
+export abstract class WithSeriesLength extends ChartModelBase {
+  /** The length of the series array. */
+  get seriesLength(): number;
+}

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

@@ -0,0 +1,18 @@
+import type { LegendItemVisibility } from "../../../spec/events.js";
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for working with series visibility. */
+export abstract class WithSeriesVisibility extends ChartModelBase {
+  /**
+   * Gets the visibility of a series.
+   *
+   * @param seriesIndex - The series index
+   */
+  getSeriesVisibility(seriesIndex: number): boolean;
+  /**
+   * Sets the visibility of a series.
+   *
+   * @param props - Visibility options for the series.
+   */
+  setSeriesVisibility(props: LegendItemVisibility): void;
+}

package/dist/model/properties/split-by-values.d.ts

@@ -0,0 +1,7 @@
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+
+/** Adds support for retrieving split-by values. */
+export abstract class WithSplitByValues extends ChartModelBase {
+  /** The split-by values for the chart. */
+  get splitByValues(): string[];
+}

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

@@ -0,0 +1,8 @@
+import type { WebChartTextSymbol } from "../../../spec/web-chart.js";
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for working with chart subtitle symbols. */
+export abstract class WithSubtitleSymbol extends ChartModelBase {
+  /** The subtitle text symbol. Contains styling information such as font, color, and symbol style. */
+  accessor subtitleSymbol: WebChartTextSymbol | undefined;
+}

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

@@ -0,0 +1,7 @@
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for working with chart subtitle text. */
+export abstract class WithSubtitleText extends ChartModelBase {
+  /** The chart subtitle text. */
+  accessor subtitleText: string;
+}

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

@@ -0,0 +1,11 @@
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for working with chart subtitle visibility. */
+export abstract class WithChartSubtitleVisibility extends ChartModelBase {
+  /**
+   * Whether or not the chart subtitle is visible.
+   *
+   * **Note:** Even if the subtitle is visible, it may not be displayed if the subtitle text is empty.
+   */
+  accessor chartSubtitleVisibility: boolean;
+}