@arcgis/charts-components 4.34.0-next.16 → 4.34.0-next.160

package/dist/model/mixins/model-with-basic-x-axis.d.ts

@@ -1,86 +1,47 @@
-import { ISimpleLineSymbol, WebChartTextSymbol } from '@arcgis/charts-spec';
+import { ISimpleLineSymbol, WebChartTextSymbol } from '../../spec';
 import { ChartModel } from '../chart-model/chart-model';
 export declare abstract class ModelWithBasicXAxis extends ChartModel {
     /**
-     * Gets the x-axis title text.
-     * @returns {string}
-     */
-    getXAxisTitleText(): string;
-    /**
-     * Sets the x-axis title text.
-     * @param {string} newXAxisTitleText - The new x-axis title text.
+     * The x-axis title text.
      */
-    setXAxisTitleText(newXAxisTitleText: string): void;
+    get xAxisTitleText(): string;
+    set xAxisTitleText(newXAxisTitleText: string);
     /**
-     * Gets whether the x-axis title is visible or not.
-     *
-     * `true`: X-axis title is visible.
-     *
-     * `false`: X-axis title is hidden.
-     *
-     * @returns {boolean}
-     */
-    getXAxisTitleVisibility(): boolean;
-    /**
-     * Sets the visibility of the x-axis title.
-     *
-     * `true`: X-axis title is visible.
-     *
-     * `false`: X-axis title is hidden.
-     *
-     * @param {boolean} newXAxisTitleVisibility - Whether the x-axis title is visible or not.
+     * Whether the x-axis title is visible.
+     * true: X-axis title is visible.
+     * false: X-axis title is hidden.
      */
-    setXAxisTitleVisibility(newXAxisTitleVisibility: boolean): void;
+    get xAxisTitleVisibility(): boolean;
+    set xAxisTitleVisibility(newXAxisTitleVisibility: boolean);
     /**
-     * Gets the maximum bound that is currently set for the x-axis.
-     * @returns {number | null}
+     * Maximum bound set for the x-axis. Null indicates no explicit maximum.
      */
-    getMaxXBound(): number | null;
+    get maxXBound(): number | null;
+    set maxXBound(newMaxXBound: number | null);
     /**
-     * Sets the maximum bound for the x-axis.
-     * @param {number | null} newMaxXBound - The new maximum bound for the x-axis.
-     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     * Minimum bound set for the x-axis. Null indicates no explicit minimum.
      */
-    setMaxXBound(newMaxXBound: number | null): Promise<void>;
+    get minXBound(): number | null;
+    set minXBound(newMinXBound: number | null);
     /**
-     * Gets the minimum bound that is currently set for the x-axis.
-     * @returns {number | null}
+     * X-axis title text symbol (font, color, style).
      */
-    getMinXBound(): number | null;
+    get xAxisTitleSymbol(): WebChartTextSymbol | undefined;
+    set xAxisTitleSymbol(newXAxisTitle: WebChartTextSymbol | undefined);
     /**
-     * Sets the minimum bound for the x-axis.
-     * @param {number | null} newMinXBound - The new minimum bound for the x-axis.
-     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     * Axis labels text symbol (font, color, style).
      */
-    setMinXBound(newMinXBound: number | null): Promise<void>;
+    get axisLabelsSymbol(): WebChartTextSymbol | undefined;
+    set axisLabelsSymbol(newAxisLabelsSymbol: WebChartTextSymbol | undefined);
     /**
-     * Gets the x-axis title text symbol. Contains styling information such as font, color, and symbol style.
-     * @returns {WebChartTextSymbol | undefined}
+     * Axis lines symbol (line width, style, color).
      */
-    getXAxisTitleSymbol(): WebChartTextSymbol | undefined;
+    get axisLinesSymbol(): ISimpleLineSymbol | undefined;
+    set axisLinesSymbol(newAxisLinesSymbol: ISimpleLineSymbol | undefined);
     /**
-     * Sets the x-axis title text symbol. Contains styling information such as font, color, and symbol style.
-     * @param {WebChartTextSymbol | undefined} newXAxisTitle - The new x-axis title text symbol.
-     */
-    setXAxisTitleSymbol(newXAxisTitle: WebChartTextSymbol | undefined): void;
-    /**
-     * Gets the axis labels text symbol. Contains styling information such as font, color, and symbol style.
-     * @returns {WebChartTextSymbol | undefined}
-     */
-    getAxisLabelsSymbol(): WebChartTextSymbol | undefined;
-    /**
-     * Sets the axis labels text symbol. Contains styling information such as font, color, and symbol style.
-     * @param {WebChartTextSymbol | undefined} newAxisLabelsSymbol - The new axis labels text symbol.
-     */
-    setAxisLabelsSymbol(newAxisLabelsSymbol: WebChartTextSymbol | undefined): void;
-    /**
-     * Gets the axis lines symbol. Contains styling information such as line width, line style, and line color.
-     * @returns {ISimpleLineSymbol | undefined}
-     */
-    getAxisLinesSymbol(): ISimpleLineSymbol | undefined;
-    /**
-     * Sets the axis lines symbol. Contains styling information such as line width, line style, and line color.
-     * @param {ISimpleLineSymbol | undefined} newAxisLinesSymbol - The new axis lines symbol.
+     * Generate the proper x-axis title from the current config.
+     *
+     * @returns {string}
      */
-    setAxisLinesSymbol(newAxisLinesSymbol: ISimpleLineSymbol | undefined): void;
+    abstract generateXAxisTitle(): string;
 }

package/dist/model/mixins/model-with-color-match.d.ts

@@ -1,23 +1,12 @@
 import { ChartModel } from '../chart-model/chart-model';
 export declare abstract class ModelWithColorMatch extends ChartModel {
     /**
-     * Gets whether the chart should attempt to match the data source's colors.
+     * 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}
-     */
-    getColorMatch(): boolean;
-    /**
-     * 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.
-     *
-     * @param {boolean} newColorMatch
      */
-    setColorMatch(newColorMatch: boolean): void;
+    get colorMatch(): boolean;
+    set colorMatch(newColorMatch: boolean);
 }

package/dist/model/mixins/model-with-data-labels.d.ts

@@ -1,34 +1,15 @@
-import { WebChartTextSymbol } from '@arcgis/charts-spec';
+import { WebChartTextSymbol } from '../../spec';
 import { ChartModel } from '../chart-model/chart-model';
 export declare abstract class ModelWithDataLabels extends ChartModel {
     /**
-     * Gets whether the data labels are visible.
-     *
-     * `true`: Data labels are visible.
-     *
-     * `false`: Data labels are hidden.
-     *
-     * @returns {boolean}
+     * Whether data labels are visible.
+     * true: visible, false: hidden.
      */
-    getDataLabelsVisibility(): boolean;
+    get dataLabelsVisibility(): boolean;
+    set dataLabelsVisibility(newDataLabelsVisibility: boolean);
     /**
-     * Sets the visibility of the data labels.
-     *
-     * `true`: Show data labels.
-     *
-     * `false`: Hide data labels.
-     *
-     * @param {boolean} newDataLabelsVisibility
+     * Data labels text symbol (font, color, style).
      */
-    setDataLabelsVisibility(newDataLabelsVisibility: boolean): void;
-    /**
-     * Gets the data labels text symbol. Contains styling information such as font, color, and symbol style.
-     * @returns {WebChartTextSymbol | undefined}
-     */
-    getDataLabelsSymbol(): WebChartTextSymbol | undefined;
-    /**
-     * Sets the data labels text symbol. Contains styling information such as font, color, and symbol style.
-     * @param {WebChartTextSymbol | undefined} newDataLabelsSymbol
-     */
-    setDataLabelsSymbol(newDataLabelsSymbol: WebChartTextSymbol | undefined): void;
+    get dataLabelsSymbol(): WebChartTextSymbol | undefined;
+    set dataLabelsSymbol(newDataLabelsSymbol: WebChartTextSymbol | undefined);
 }

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

@@ -1,17 +1,13 @@
-import { ISimpleFillSymbol, ISimpleLineSymbol, WebChartTextSymbol } from '@arcgis/charts-spec';
+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 {
     /**
-     * Gets the guide labels text symbol. Contains styling information such as font, color, and symbol style.
+     * The guide labels text symbol (font, color, style).
      * @returns {WebChartTextSymbol | undefined}
      */
-    getGuideLabelsSymbol(): WebChartTextSymbol | undefined;
-    /**
-     * Sets the guide labels text symbol. Contains styling information such as font, color, and symbol style.
-     * @param {WebChartTextSymbol | undefined} newGuideLabelsSymbol
-     */
-    setGuideLabelsSymbol(newGuideLabelsSymbol: WebChartTextSymbol | undefined): void;
+    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.

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

@@ -1,104 +1,52 @@
-import { WebChartLegendPositions, WebChartTextSymbol } from '@arcgis/charts-spec';
+import { WebChartLegendPositions, WebChartTextSymbol } from '../../spec';
 import { ChartModel } from '../chart-model/chart-model';
 export declare abstract class ModelWithLegend extends ChartModel {
     /**
-     * Gets whether the legend title is visible.
+     * Whether the legend title is visible.
      *
      * `true`: Legend title is visible.
      *
      * `false`: Legend title is hidden.
-     *
-     * @returns {boolean}
-     */
-    getLegendVisibility(): boolean;
-    /**
-     * Sets whether the legend title is visible.
-     *
-     * `true`: Show legend title.
-     *
-     * `false`: Hide legend title.
-     *
-     * @param {boolean} legendVisibility
      */
-    setLegendVisibility(legendVisibility: boolean): void;
+    get legendVisibility(): boolean;
+    set legendVisibility(legendVisibility: boolean);
     /**
-     * Gets the legend title text.
-     * @returns {string}
+     * The legend title text.
      */
-    getLegendTitleText(): string;
+    get legendTitleText(): string;
+    set legendTitleText(legendTitleText: string);
     /**
-     * Sets the legend title text.
-     * @param {string} legendTitleText
-     */
-    setLegendTitleText(legendTitleText: string): void;
-    /**
-     * Gets whether the legend title is visible.
+     * Whether the legend title is visible.
      *
      * `true`: Legend title is visible.
      *
      * `false`: Legend title is hidden.
-     *
-     * @returns {boolean}
-     */
-    getLegendTitleVisibility(): boolean;
-    /**
-     * Sets whether the legend title is visible.
-     *
-     * `true`: Show legend title.
-     *
-     * `false`: Hide legend title.
-     *
-     * @param {boolean} showLegendTitle
-     */
-    setLegendTitleVisibility(showLegendTitle: boolean): void;
-    /**
-     * Gets the legend position: top, bottom, left, or right.
-     * @returns {WebChartLegendPositions}
-     */
-    getLegendPosition(): WebChartLegendPositions;
-    /**
-     * Sets the legend position; where the chart legend should be displayed, top, bottom, left, or right.
-     * @param {WebChartLegendPositions} legendPosition
-     */
-    setLegendPosition(legendPosition: WebChartLegendPositions): void;
-    /**
-     * Gets the legend title symbol. Contains styling information such as font, color, and symbol style.
-     * @returns {WebChartTextSymbol | undefined}
-     */
-    getLegendTitleSymbol(): WebChartTextSymbol | undefined;
-    /**
-     * Sets the legend title symbol. Contains styling information such as font, color, and symbol style.
-     * @param {WebChartTextSymbol | undefined} legendTitle
-     */
-    setLegendTitleSymbol(legendTitle: WebChartTextSymbol | undefined): void;
-    /**
-     * Gets the legend text symbol. Contains styling information such as font, color, and symbol style.
-     * @returns {WebChartTextSymbol | undefined}
      */
-    getLegendTextSymbol(): WebChartTextSymbol | undefined;
+    get legendTitleVisibility(): boolean;
+    set legendTitleVisibility(showLegendTitle: boolean);
     /**
-     * Sets the legend text symbol. Contains styling information such as font, color, and symbol style.
-     * @param {WebChartTextSymbol | undefined} legendText
+     * Legend position: top, bottom, left, or right.
      */
-    setLegendTextSymbol(legendText: WebChartTextSymbol | undefined): void;
+    get legendPosition(): WebChartLegendPositions;
+    set legendPosition(legendPosition: WebChartLegendPositions);
     /**
-     * Gets the maximum height of the legend.
-     * @returns {number | undefined}
+     * Legend title text symbol (font, color, style).
      */
-    getLegendMaxHeight(): number | undefined;
+    get legendTitleSymbol(): WebChartTextSymbol | undefined;
+    set legendTitleSymbol(legendTitle: WebChartTextSymbol | undefined);
     /**
-     * Sets the maximum height of the legend. If not set, the legend will occupy the same height as the series container or pie chart.
-     * @param maxHeight - the maximum height for the legend
+     * Legend item text symbol (font, color, style).
      */
-    setLegendMaxHeight(maxHeight: number): void;
+    get legendTextSymbol(): WebChartTextSymbol | undefined;
+    set legendTextSymbol(legendText: WebChartTextSymbol | undefined);
     /**
-     * Gets the indicator for whether the legend markers should be rounded.
-     * @returns {boolean}
+     * Maximum legend height.
      */
-    getLegendRoundMarker(): boolean;
+    get legendMaxHeight(): number | undefined;
+    set legendMaxHeight(maxHeight: number | undefined);
     /**
-     * Sets the indicator for whether the legend markers should be rounded.
-     * @param roundMarker - the round marker indicator
+     * Whether legend markers are rounded.
      */
-    setLegendRoundMarker(roundMarker: boolean): void;
+    get legendRoundMarker(): boolean;
+    set legendRoundMarker(roundMarker: boolean);
 }

package/dist/model/mixins/model-with-line-marker-styling.d.ts

@@ -1,5 +1,5 @@
 import { ChartConfig } from '../../utils';
-import { Color, RESTSimpleLineSymbolStyle, RESTSimpleMarkerSymbolStyle } from '@arcgis/charts-spec';
+import { Color, RESTSimpleLineSymbolStyle, RESTSimpleMarkerSymbolStyle } from '../../spec';
 import { ChartModel } from '../chart-model/chart-model';
 import { ModelTypes } from '../interfaces/common';
 export declare abstract class ModelWithLineMarkerStyling extends ChartModel {
@@ -74,8 +74,8 @@ export declare abstract class ModelWithLineMarkerStyling extends ChartModel {
     isLineSmoothed(seriesIndex: number): boolean;
     /**
      * Specify whether line segments of the series should be smoothed.
-     * @param {boolean} props.smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
-     * @param {number} props.seriesIndex - The index of the series.
+     * @param {boolean} smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
+     * @param {number} seriesIndex - The index of the series.
      */
     setLineSmoothed(smoothed: boolean, seriesIndex: number): void;
     /**
@@ -86,12 +86,10 @@ export declare abstract class ModelWithLineMarkerStyling extends ChartModel {
      */
     getConnectLines(seriesIndex: number): boolean | undefined;
     /**
-     * Specify the color of the filled area for line chart.
-     * @param {boolean | undefined} props.color - The color of the filled area for line chart.
-     * @param {number} props.seriesIndex - The index of the series.
-     *
-     * NOTE: Can be overridden by the temporal data setting `nullPolicy`.
-     *
+     * Specify whether to connect the lines when there's a gap in the data.
+     * **Note:** Can be overridden by the temporal data setting `nullPolicy`.
+     * @param {boolean | undefined} connect - Whether to connect the gap in the data
+     * @param {number} seriesIndex - The index of the series.
      */
     setConnectLines(connect: boolean | undefined, seriesIndex: number): void;
     /**
@@ -104,8 +102,8 @@ export declare abstract class ModelWithLineMarkerStyling extends ChartModel {
     isAreaVisible(seriesIndex: number): boolean;
     /**
      * Specify whether the line series should show area.
-     * @param {boolean} props.visible - `true` if the line series should show area, `false` otherwise.
-     * @param {number} props.seriesIndex - The index of the series.
+     * @param {boolean} visible - `true` if the line series should show area, `false` otherwise.
+     * @param {number} seriesIndex - The index of the series.
      */
     setAreaVisible(visible: boolean, seriesIndex: number): void;
     /**
@@ -118,23 +116,21 @@ export declare abstract class ModelWithLineMarkerStyling extends ChartModel {
     isMarkerVisible(seriesIndex: number): boolean;
     /**
      * Indicate whether to show or hide the markers/bullets of the line series.
-     * @param {boolean} props.visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
-     * @param {number} props.seriesIndex - The index of the series.
+     * @param {boolean} visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
+     * @param {number} seriesIndex - The index of the series.
      */
     setMarkerVisible(visible: boolean, seriesIndex: number): void;
     /**
      * Specify the color of the filled area for line chart.
+     * **Note:** `areaColor` will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
      * @param {number} seriesIndex - The index of the series.
-     *
-     * NOTE: areaColor will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
-     *
      * @returns {Color | undefined}
      */
     getAreaColor(seriesIndex: number): Color | undefined;
     /**
      * Specify the color of the filled area for line chart.
-     * @param {Color | undefined} props.color - The color of the filled area for line chart.
-     * @param {number} props.seriesIndex - The index of the series.
+     * @param {Color | undefined} color - The color of the filled area for line chart.
+     * @param {number} seriesIndex - The index of the series.
      */
     setAreaColor(color: Color | undefined, seriesIndex: number): void;
 }