@arcgis/charts-components 5.0.0-next.16 → 5.0.0-next.161

package/dist/model/interfaces/common.d.ts

@@ -1,24 +1,31 @@
-import { IField, SupportedLayer, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartGaugeSeries, WebChartHeatChartSeries, WebChartHistogramSeries, WebChartLineChartSeries, WebChartPieChartSeries, WebChartRadarChartSeries, WebChartScatterplotSeries, WebChartTypes } from '../../spec';
-import { SupportedChartSeries } from '../../utils';
-import { BarChartModel } from '../bar-chart-model/bar-chart-model';
-import { BoxPlotModel } from '../box-plot-model/box-plot-model';
-import { ComboBarLineChartModel } from '../combo-bar-line-chart-model/combo-bar-line-chart-model';
-import { GaugeModel } from '../gauge-model/gauge-model';
-import { HistogramModel } from '../histogram-model/histogram-model';
-import { LineChartModel } from '../line-chart-model/line-chart-model';
-import { PieChartModel } from '../pie-chart-model/pie-chart-model';
-import { RadarChartModel } from '../radar-chart-model/radar-chart-model';
-import { ScatterplotModel } from '../scatterplot-model/scatterplot-model';
-export declare const customSortString = "customSort";
-export declare const SerialChartDataSortingKinds: {
+import type { SupportedLayer } from "../../interfaces.js";
+import type { WebChartTypes } from "../../spec/chart-object-literals.js";
+import type { IField } from "../../spec/rest-js-types.js";
+import type { WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartGaugeSeries, WebChartHeatChartSeries, WebChartHistogramSeries, WebChartLineChartSeries, WebChartPieChartSeries, WebChartRadarChartSeries, WebChartScatterplotSeries } from "../../spec/web-chart.js";
+import type { SupportedChartSeries } from "../../utils/types/index.js";
+import type { BarChartModel } from "../bar-chart-model/bar-chart-model.js";
+import type { BoxPlotModel } from "../box-plot-model/box-plot-model.js";
+import type { ComboBarLineChartModel } from "../combo-bar-line-chart-model/combo-bar-line-chart-model.js";
+import type { GaugeModel } from "../gauge-model/gauge-model.js";
+import type { HistogramModel } from "../histogram-model/histogram-model.js";
+import type { LineChartModel } from "../line-chart-model/line-chart-model.js";
+import type { PieChartModel } from "../pie-chart-model/pie-chart-model.js";
+import type { RadarChartModel } from "../radar-chart-model/radar-chart-model.js";
+import type { ScatterplotModel } from "../scatterplot-model/scatterplot-model.js";
+
+export const customSortString: "customSort";
+
+export const SerialChartDataSortingKinds: {
     readonly xAxisAsc: "xAxisAsc";
     readonly xAxisDesc: "xAxisDesc";
     readonly yAxisAsc: "yAxisAsc";
     readonly yAxisDesc: "yAxisDesc";
     readonly customSort: "customSort";
 };
+
 export type SerialChartDataSortingKinds = (typeof SerialChartDataSortingKinds)[keyof typeof SerialChartDataSortingKinds];
-export declare const BoxPlotDataSortingKinds: {
+
+export const BoxPlotDataSortingKinds: {
     readonly xAxisAsc: "xAxisAsc";
     readonly xAxisDesc: "xAxisDesc";
     readonly meanAsc: "meanAsc";
@@ -27,28 +34,44 @@ export declare const BoxPlotDataSortingKinds: {
     readonly medianDesc: "medianDesc";
     readonly customSort: "customSort";
 };
+
 export type BoxPlotDataSortingKinds = (typeof BoxPlotDataSortingKinds)[keyof typeof BoxPlotDataSortingKinds];
-export declare const PieChartDataSortingKinds: {
+
+export const HeatChartDataSortingKinds: {
+    readonly Asc: "Asc";
+    readonly Desc: "Desc";
+    readonly customSort: "customSort";
+};
+
+export type HeatChartDataSortingKinds = (typeof HeatChartDataSortingKinds)[keyof typeof HeatChartDataSortingKinds];
+
+export const PieChartDataSortingKinds: {
     readonly labelAsc: "labelAsc";
     readonly labelDesc: "labelDesc";
     readonly valueAsc: "valueAsc";
     readonly valueDesc: "valueDesc";
     readonly customSort: "customSort";
 };
+
 export type PieChartDataSortingKinds = (typeof PieChartDataSortingKinds)[keyof typeof PieChartDataSortingKinds];
-export declare const PieChartDataModes: {
+
+export const PieChartDataModes: {
     readonly Category: "category";
     readonly Fields: "fields";
 };
+
 export type PieChartDataModes = (typeof PieChartDataModes)[keyof typeof PieChartDataModes];
-export declare const PieChartSlicesDisplay: {
+
+export const PieChartSlicesDisplay: {
     readonly Category: "category";
     readonly Value: "value";
     readonly Percentage: "percentage";
     readonly Both: "both";
 };
+
 export type PieChartSlicesDisplay = (typeof PieChartSlicesDisplay)[keyof typeof PieChartSlicesDisplay];
-export declare const FormatKeys: {
+
+export const FormatKeys: {
     readonly TextElements: "textElements";
     readonly XAxisTitle: "xAxisTitle";
     readonly YAxisTitle: "yAxisTitle";
@@ -64,14 +87,18 @@ export declare const FormatKeys: {
     readonly AxisLines: "axisLines";
     readonly GridLines: "gridLines";
 };
+
 export type FormatKeys = (typeof FormatKeys)[keyof typeof FormatKeys];
-export declare const LineFormatKeys: {
+
+export const LineFormatKeys: {
     readonly AxisLines: "axisLines";
     readonly GridLines: "gridLines";
     readonly LeaderLines: "leaderLines";
 };
+
 export type LineFormatKeys = (typeof LineFormatKeys)[keyof typeof LineFormatKeys];
-export declare const TextFormatKeys: {
+
+export const TextFormatKeys: {
     readonly Title: "title";
     readonly XAxisTitle: "xAxisTitle";
     readonly YAxisTitle: "yAxisTitle";
@@ -82,46 +109,45 @@ export declare const TextFormatKeys: {
     readonly Description: "description";
     readonly DataLabels: "dataLabels";
 };
+
 export type TextFormatKeys = (typeof TextFormatKeys)[keyof typeof TextFormatKeys];
-export declare const ColorFormatKeys: {
-    readonly Background: "background";
-};
+
+export const ColorFormatKeys: { readonly Background: "background"; };
+
 export type ColorFormatKeys = (typeof ColorFormatKeys)[keyof typeof ColorFormatKeys];
-/**
- * Axis orientation of the guide.
- */
-export declare const GuideOrientation: {
+
+/** Axis orientation of the guide. */
+export const GuideOrientation: {
     readonly X: "x";
     readonly Y: "y";
 };
+
 export type GuideOrientation = (typeof GuideOrientation)[keyof typeof GuideOrientation];
+
 export interface SplitByFieldInfos {
-    categoriesArray: (number | string)[];
-    splitByFieldType: string | undefined;
-    numericalField: string;
+  categoriesArray: (number | string)[];
+  splitByFieldType?: string;
+  numericalField: string;
 }
+
 export interface PieSeriesDisplayOptions {
-    displayCategoryOnDataLabel: boolean;
-    displayNumericValueOnDataLabel: boolean;
-    displayPercentageOnDataLabel: boolean;
-    displayNumericValue: boolean;
-    displayPercentage: boolean;
+  displayCategoryOnDataLabel: boolean;
+  displayNumericValueOnDataLabel: boolean;
+  displayPercentageOnDataLabel: boolean;
+  displayNumericValue: boolean;
+  displayPercentage: boolean;
 }
+
 export interface LayerInfo {
-    /**
-     * Layer used for this bar chart.
-     */
-    layer: SupportedLayer;
-    /**
-     * Fields information for the layer.
-     */
-    layerFieldsInfo: IField[];
-    /**
-     * Object ID field name for the layer.
-     */
-    objectIdField: string;
+  /** Layer used for this bar chart. */
+  layer: SupportedLayer;
+  /** Fields information for the layer. */
+  layerFieldsInfo: IField[];
+  /** Object ID field name for the layer. */
+  objectIdField: string;
 }
-export declare const ModelTypes: {
+
+export const ModelTypes: {
     readonly BarChart: "barChart";
     readonly LineChart: "lineChart";
     readonly ComboBarLineChart: "comboBarLineChart";
@@ -133,7 +159,11 @@ export declare const ModelTypes: {
     readonly RadarChart: "radarChart";
     readonly HeatChart: "heatChart";
 };
+
 export type ModelTypes = (typeof ModelTypes)[keyof typeof ModelTypes];
+
 export type ModelTypeToSeriesType<T extends ModelTypes> = T extends typeof ModelTypes.BarChart ? WebChartBarChartSeries : T extends typeof ModelTypes.LineChart ? WebChartLineChartSeries : T extends typeof ModelTypes.ComboBarLineChart ? WebChartBarChartSeries | WebChartLineChartSeries : T extends typeof ModelTypes.BoxPlot ? WebChartBoxPlotSeries | WebChartLineChartSeries : T extends typeof ModelTypes.PieChart ? WebChartPieChartSeries : T extends typeof ModelTypes.Scatterplot ? WebChartScatterplotSeries : T extends typeof ModelTypes.Histogram ? WebChartHistogramSeries : T extends typeof ModelTypes.Gauge ? WebChartGaugeSeries : T extends typeof ModelTypes.RadarChart ? WebChartRadarChartSeries : T extends typeof ModelTypes.HeatChart ? WebChartHeatChartSeries : SupportedChartSeries;
+
 export type SeriesTypeToChartType<T extends SupportedChartSeries> = T extends WebChartBarChartSeries ? typeof WebChartTypes.BarSeries : T extends WebChartLineChartSeries ? typeof WebChartTypes.LineSeries : T extends WebChartBoxPlotSeries ? typeof WebChartTypes.BoxPlotSeries : T extends WebChartPieChartSeries ? typeof WebChartTypes.PieSeries : T extends WebChartScatterplotSeries ? typeof WebChartTypes.ScatterSeries : T extends WebChartHistogramSeries ? typeof WebChartTypes.HistogramSeries : T extends WebChartGaugeSeries ? typeof WebChartTypes.GaugeSeries : T extends WebChartRadarChartSeries ? typeof WebChartTypes.RadarSeries : T extends WebChartHeatChartSeries ? typeof WebChartTypes.HeatSeries : never;
-export type ModelOfType<T> = T extends typeof ModelTypes.BoxPlot ? BoxPlotModel : T extends typeof ModelTypes.LineChart ? LineChartModel : T extends typeof ModelTypes.ComboBarLineChart ? ComboBarLineChartModel : T extends typeof ModelTypes.PieChart ? PieChartModel : T extends typeof ModelTypes.Scatterplot ? ScatterplotModel : T extends typeof ModelTypes.Histogram ? HistogramModel : T extends typeof ModelTypes.Gauge ? GaugeModel : T extends typeof ModelTypes.RadarChart ? RadarChartModel : T extends typeof ModelTypes.HeatChart ? never : BarChartModel;
+
+export type ModelOfType<T> = T extends typeof ModelTypes.BoxPlot ? BoxPlotModel : T extends typeof ModelTypes.LineChart ? LineChartModel : T extends typeof ModelTypes.ComboBarLineChart ? ComboBarLineChartModel : T extends typeof ModelTypes.PieChart ? PieChartModel : T extends typeof ModelTypes.Scatterplot ? ScatterplotModel : T extends typeof ModelTypes.Histogram ? HistogramModel : T extends typeof ModelTypes.Gauge ? GaugeModel : T extends typeof ModelTypes.RadarChart ? RadarChartModel : T extends typeof ModelTypes.HeatChart ? never : BarChartModel;

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

@@ -1,37 +1,21 @@
-import { ChartConfig } from '../../utils';
-import { WebChart, WebChartLineChartSeries } from '../../spec';
-import { ModelParams } from '../interfaces/chart-interfaces';
-import { LayerInfo, ModelTypes } from '../interfaces/common';
-import { ModelWithBaselineStacking, ModelWithLineMarkerStyling } from '../mixins';
-import { SerialChartModel } from '../serial-chart-model/serial-chart-model';
-export declare class LineChartModel extends SerialChartModel {
-    /**
-     * Current configuration used for the line chart.
-     */
-    protected _config: ChartConfig<typeof ModelTypes.LineChart, WebChart>;
-    /**
-     * Default series for the line chart. Used in resetting the series styling.
-     * @category Protected
-     */
-    protected defaultSeries: WebChartLineChartSeries | undefined;
-    protected _chartType: "lineSeries";
-    protected layerInfo: LayerInfo;
-    setup(params: ModelParams<ChartConfig<typeof ModelTypes.LineChart>>): Promise<void>;
-    protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
-    /**
-     * Initializes the default series for the line chart. Used in resetting the series styling.
-     * @category Private
-     */
-    protected initDefaultSeries(): void;
-    /**
-     * Resets the series styling to the default styling.
-     */
-    resetSeriesStyling(): void;
-    /**
-     * Returns whether the series styling is able to be reset.
-     * @returns {boolean}
-     */
-    resetAvailable(): boolean;
-}
-export interface LineChartModel extends ModelWithBaselineStacking, ModelWithLineMarkerStyling {
+import type { ModelParams } from "../interfaces/chart-interfaces.js";
+import type { ModelTypes } from "../interfaces/common.js";
+import type { SerialChartModel } from "../serial-chart-model/serial-chart-model.js";
+import type { WithNegativeValuesStackedToBaseline } from "../properties/series/negative-values-stacked-to-baseline.js";
+import type { ChartConfig } from "../../utils/types/index.js";
+import type { ModelWithLineMarkerStyling } from "../mixins/model-with-line-marker-styling.js";
+
+export class LineChartModel extends LineChartModelSuperclass {
+  /** Returns whether the series styling is able to be reset. */
+  resetAvailable(): boolean;
+  /** Resets the series styling to the default styling. */
+  resetSeriesStyling(): void;
+  /**
+   * Completes the async setup process for the chart model. Must be called before using the model.
+   *
+   * @param params
+   * @async **This method is `async` and must be awaited for the changes to take effect.**
+   */
+  setup(params: ModelParams<ChartConfig<typeof ModelTypes.LineChart>>): Promise<void>;
 }
+declare const LineChartModelSuperclass: typeof SerialChartModel & typeof ModelWithLineMarkerStyling & typeof WithNegativeValuesStackedToBaseline

package/dist/model/mixins/model-with-guides.d.ts

@@ -1,123 +1,129 @@
-import { ISimpleFillSymbol, ISimpleLineSymbol, WebChartTextSymbol } from '../../spec';
-import { ChartModel } from '../chart-model/chart-model';
-import { GuideOrientation } from '../interfaces/common';
-export declare abstract class ModelWithGuides extends ChartModel {
-    /**
-     * The guide labels text symbol (font, color, style).
-     * @returns {WebChartTextSymbol | undefined}
-     */
-    get guideLabelsSymbol(): WebChartTextSymbol | undefined;
-    set guideLabelsSymbol(newGuideLabelsSymbol: WebChartTextSymbol | undefined);
-    /**
-     * Gets whether a guide is visible.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     * @returns {boolean}
-     */
-    getGuideVisibility(index?: number, orientation?: GuideOrientation): boolean;
-    /**
-     * Sets whether a guide is visible
-     * @param {boolean} visible New visibility to set.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     */
-    setGuideVisibility(visible: boolean, index?: number, orientation?: GuideOrientation): void;
-    /**
-     * Gets the start value of a guide.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     * @returns {Date | number | string | null}
-     */
-    getGuideStart(index?: number, orientation?: GuideOrientation): Date | number | string | null;
-    /**
-     * Sets the start value of a guide.
-     * @param {Date | number | string | null} start New start value to set.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     */
-    setGuideStart(start: Date | number | string | null, index?: number, orientation?: GuideOrientation): void;
-    /**
-     * Gets the end value of a guide.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     * @returns {Date | number | string | null}
-     */
-    getGuideEnd(index?: number, orientation?: GuideOrientation): Date | number | string | null | undefined;
-    /**
-     * Sets the end value of a guide.
-     * @param {Date | number | string | null | undefined} end New end value to set.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     */
-    setGuideEnd(end: Date | number | string | null | undefined, index?: number, orientation?: GuideOrientation): void;
-    /**
-     * Gets the name of a guide.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     * @returns {string | undefined}
-     */
-    getGuideName(index?: number, orientation?: GuideOrientation): string | undefined;
-    /**
-     * Sets the name of a guide.
-     * @param {string} name New name to set.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     */
-    setGuideName(name: string, index?: number, orientation?: GuideOrientation): void;
-    /**
-     * Gets the guide label text.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     * @returns {string | undefined}
-     */
-    getGuideLabelText(index?: number, orientation?: GuideOrientation): string | undefined;
-    /**
-     * Sets the guide label text.
-     * @param {string} labelText New label text to set.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     */
-    setGuideLabelText(labelText: string, index?: number, orientation?: GuideOrientation): void;
-    /**
-     * Gets whether the guide should be rendered above the other chart elements.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     * @returns {boolean}
-     */
-    getGuideAbove(index?: number, orientation?: GuideOrientation): boolean;
-    /**
-     * Sets whether the guide should be rendered above the other chart elements.
-     * @param {boolean} above New above boolean to set.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     */
-    setGuideAbove(above: boolean, index?: number, orientation?: GuideOrientation): void;
-    /**
-     * Gets the guide style.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     * @returns {ISimpleFillSymbol | ISimpleLineSymbol | undefined}
-     */
-    getGuideStyle(index?: number, orientation?: GuideOrientation): ISimpleFillSymbol | ISimpleLineSymbol | undefined;
-    /**
-     * Sets the guide style.
-     * @param {ISimpleFillSymbol | ISimpleLineSymbol} style New style to set.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     */
-    setGuideStyle(style: ISimpleFillSymbol | ISimpleLineSymbol, index?: number, orientation?: GuideOrientation): void;
-    /**
-     * Gets whether the tooltip text color should be reversed for a guide.
-     * @param index - The index of the guide in the list of guides for the given axis orientation.
-     * @param orientation - The axis orientation of the guide.
-     * @returns {boolean}
-     */
-    getTooltipReverseColor(index: number, orientation?: GuideOrientation): boolean;
-    /**
-     * Sets whether the tooltip text color should be reversed for a guide.
-     * @param reverseColor - New reverseColor boolean to set.
-     * @param index - The index of the guide in the list of guides for the given axis orientation.
-     * @param orientation - The axis orientation of the guide.
-     */
-    setTooltipReverseColor(reverseColor: boolean, index: number, orientation?: GuideOrientation): void;
-}
+import type { ChartModel } from "../chart-model/chart-model.js";
+import type { GuideOrientation } from "../interfaces/common.js";
+import type { WebChartTextSymbol } from "../../spec/web-chart.js";
+import type { ISimpleFillSymbol, ISimpleLineSymbol } from "../../spec/rest-js-types.js";
+
+export abstract class ModelWithGuides extends ChartModel {
+  /** The guide labels text symbol (font, color, style). */
+  accessor guideLabelsSymbol: WebChartTextSymbol | undefined;
+  /**
+   * Gets whether the guide should be rendered above the other chart elements.
+   *
+   * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+   * @param orientation - Default `y`. The axis orientation of the guide.
+   */
+  getGuideAbove(index?: number, orientation?: GuideOrientation): boolean;
+  /**
+   * Gets the end value of a guide.
+   *
+   * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+   * @param orientation - Default `y`. The axis orientation of the guide.
+   */
+  getGuideEnd(index?: number, orientation?: GuideOrientation): Date | number | string | null | undefined;
+  /**
+   * Gets the guide label text.
+   *
+   * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+   * @param orientation - Default `y`. The axis orientation of the guide.
+   */
+  getGuideLabelText(index?: number, orientation?: GuideOrientation): string | undefined;
+  /**
+   * Gets the name of a guide.
+   *
+   * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+   * @param orientation - Default `y`. The axis orientation of the guide.
+   */
+  getGuideName(index?: number, orientation?: GuideOrientation): string | undefined;
+  /**
+   * Gets the start value of a guide.
+   *
+   * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+   * @param orientation - Default `y`. The axis orientation of the guide.
+   */
+  getGuideStart(index?: number, orientation?: GuideOrientation): Date | number | string | null;
+  /**
+   * Gets the guide style.
+   *
+   * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+   * @param orientation - Default `y`. The axis orientation of the guide.
+   */
+  getGuideStyle(index?: number, orientation?: GuideOrientation): ISimpleFillSymbol | ISimpleLineSymbol | undefined;
+  /**
+   * Gets whether a guide is visible.
+   *
+   * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+   * @param orientation - Default `y`. The axis orientation of the guide.
+   */
+  getGuideVisibility(index?: number, orientation?: GuideOrientation): boolean;
+  /**
+   * Gets whether the tooltip text color should be reversed for a guide.
+   *
+   * @param index - The index of the guide in the list of guides for the given axis orientation.
+   * @param orientation - The axis orientation of the guide.
+   */
+  getTooltipReverseColor(index: number, orientation?: GuideOrientation): boolean;
+  /**
+   * Sets whether the guide should be rendered above the other chart elements.
+   *
+   * @param above - New above boolean to set.
+   * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+   * @param orientation - Default `y`. The axis orientation of the guide.
+   */
+  setGuideAbove(above: boolean, index?: number, orientation?: GuideOrientation): void;
+  /**
+   * Sets the end value of a guide.
+   *
+   * @param end - New end value to set.
+   * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+   * @param orientation - Default `y`. The axis orientation of the guide.
+   */
+  setGuideEnd(end: Date | number | string | null | undefined, index?: number, orientation?: GuideOrientation): void;
+  /**
+   * Sets the guide label text.
+   *
+   * @param labelText - New label text to set.
+   * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+   * @param orientation - Default `y`. The axis orientation of the guide.
+   */
+  setGuideLabelText(labelText: string, index?: number, orientation?: GuideOrientation): void;
+  /**
+   * Sets the name of a guide.
+   *
+   * @param name - New name to set.
+   * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+   * @param orientation - Default `y`. The axis orientation of the guide.
+   */
+  setGuideName(name: string, index?: number, orientation?: GuideOrientation): void;
+  /**
+   * Sets the start value of a guide.
+   *
+   * @param start - New start value to set.
+   * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+   * @param orientation - Default `y`. The axis orientation of the guide.
+   */
+  setGuideStart(start: Date | number | string | null, index?: number, orientation?: GuideOrientation): void;
+  /**
+   * Sets the guide style.
+   *
+   * @param style - New style to set.
+   * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+   * @param orientation - Default `y`. The axis orientation of the guide.
+   */
+  setGuideStyle(style: ISimpleFillSymbol | ISimpleLineSymbol, index?: number, orientation?: GuideOrientation): void;
+  /**
+   * Sets whether a guide is visible.
+   *
+   * @param visible - New visibility to set.
+   * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+   * @param orientation - Default `y`. The axis orientation of the guide.
+   */
+  setGuideVisibility(visible: boolean, index?: number, orientation?: GuideOrientation): void;
+  /**
+   * Sets whether the tooltip text color should be reversed for a guide.
+   *
+   * @param reverseColor - New reverseColor boolean to set.
+   * @param index - The index of the guide in the list of guides for the given axis orientation.
+   * @param orientation - The axis orientation of the guide.
+   */
+  setTooltipReverseColor(reverseColor: boolean, index: number, orientation?: GuideOrientation): void;
+}

package/dist/model/mixins/model-with-legend.d.ts

@@ -1,52 +1,34 @@
-import { WebChartLegendPositions, WebChartTextSymbol } from '../../spec';
-import { ChartModel } from '../chart-model/chart-model';
-export declare abstract class ModelWithLegend extends ChartModel {
-    /**
-     * Whether the legend title is visible.
-     *
-     * `true`: Legend title is visible.
-     *
-     * `false`: Legend title is hidden.
-     */
-    get legendVisibility(): boolean;
-    set legendVisibility(legendVisibility: boolean);
-    /**
-     * The legend title text.
-     */
-    get legendTitleText(): string;
-    set legendTitleText(legendTitleText: string);
-    /**
-     * Whether the legend title is visible.
-     *
-     * `true`: Legend title is visible.
-     *
-     * `false`: Legend title is hidden.
-     */
-    get legendTitleVisibility(): boolean;
-    set legendTitleVisibility(showLegendTitle: boolean);
-    /**
-     * Legend position: top, bottom, left, or right.
-     */
-    get legendPosition(): WebChartLegendPositions;
-    set legendPosition(legendPosition: WebChartLegendPositions);
-    /**
-     * Legend title text symbol (font, color, style).
-     */
-    get legendTitleSymbol(): WebChartTextSymbol | undefined;
-    set legendTitleSymbol(legendTitle: WebChartTextSymbol | undefined);
-    /**
-     * Legend item text symbol (font, color, style).
-     */
-    get legendTextSymbol(): WebChartTextSymbol | undefined;
-    set legendTextSymbol(legendText: WebChartTextSymbol | undefined);
-    /**
-     * Maximum legend height.
-     */
-    get legendMaxHeight(): number | undefined;
-    set legendMaxHeight(maxHeight: number | undefined);
-    /**
-     * Whether legend markers are rounded.
-     */
-    get legendRoundMarker(): boolean;
-    set legendRoundMarker(roundMarker: boolean);
-}
+import type { ChartModel } from "../chart-model/chart-model.js";
+import type { WebChartLegendPositions } from "../../spec/chart-object-literals.js";
+import type { WebChartTextSymbol } from "../../spec/web-chart.js";
+
+export abstract class ModelWithLegend extends ChartModel {
+  /** Maximum legend height. */
+  accessor legendMaxHeight: number | undefined;
+  /** Legend position: top, bottom, left, or right. */
+  accessor legendPosition: WebChartLegendPositions;
+  /** Whether legend markers are rounded. */
+  accessor legendRoundMarker: boolean;
+  /** Legend item text symbol (font, color, style). */
+  accessor legendTextSymbol: WebChartTextSymbol | undefined;
+  /** Legend title text symbol (font, color, style). */
+  accessor legendTitleSymbol: WebChartTextSymbol | undefined;
+  /** The legend title text. */
+  accessor legendTitleText: string;
+  /**
+   * Whether the legend title is visible.
+   *
+   * `true`: Legend title is visible.
+   *
+   * `false`: Legend title is hidden.
+   */
+  accessor legendTitleVisibility: boolean;
+  /**
+   * Whether the legend title is visible.
+   *
+   * `true`: Legend title is visible.
+   *
+   * `false`: Legend title is hidden.
+   */
+  accessor legendVisibility: boolean;
+}