@arcgis/charts-components 4.34.0-next.142 → 4.34.0-next.144

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

@@ -2,87 +2,42 @@ 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.
-     */
-    setXAxisTitleText(newXAxisTitleText: string): void;
-    /**
-     * 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.
-     */
-    setXAxisTitleVisibility(newXAxisTitleVisibility: boolean): void;
-    /**
-     * Gets the maximum bound that is currently set for the x-axis.
-     * @returns {number | null}
-     */
-    getMaxXBound(): 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.**
-     */
-    setMaxXBound(newMaxXBound: number | null): void;
-    /**
-     * Gets the minimum bound that is currently set for the x-axis.
-     * @returns {number | null}
-     */
-    getMinXBound(): number | null;
-    /**
-     * 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.**
+     * The x-axis title text.
      */
-    setMinXBound(newMinXBound: number | null): void;
+    get xAxisTitleText(): string;
+    set xAxisTitleText(newXAxisTitleText: string);
     /**
-     * Gets the x-axis title text symbol. Contains styling information such as font, color, and symbol style.
-     * @returns {WebChartTextSymbol | undefined}
+     * Whether the x-axis title is visible.
+     * true: X-axis title is visible.
+     * false: X-axis title is hidden.
      */
-    getXAxisTitleSymbol(): WebChartTextSymbol | undefined;
+    get xAxisTitleVisibility(): boolean;
+    set xAxisTitleVisibility(newXAxisTitleVisibility: boolean);
     /**
-     * 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.
+     * Maximum bound set for the x-axis. Null indicates no explicit maximum.
      */
-    setXAxisTitleSymbol(newXAxisTitle: WebChartTextSymbol | undefined): void;
+    get maxXBound(): number | null;
+    set maxXBound(newMaxXBound: number | null);
     /**
-     * Gets the axis labels text symbol. Contains styling information such as font, color, and symbol style.
-     * @returns {WebChartTextSymbol | undefined}
+     * Minimum bound set for the x-axis. Null indicates no explicit minimum.
      */
-    getAxisLabelsSymbol(): WebChartTextSymbol | undefined;
+    get minXBound(): number | null;
+    set minXBound(newMinXBound: number | null);
     /**
-     * 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.
+     * X-axis title text symbol (font, color, style).
      */
-    setAxisLabelsSymbol(newAxisLabelsSymbol: WebChartTextSymbol | undefined): void;
+    get xAxisTitleSymbol(): WebChartTextSymbol | undefined;
+    set xAxisTitleSymbol(newXAxisTitle: WebChartTextSymbol | undefined);
     /**
-     * Gets the axis lines symbol. Contains styling information such as line width, line style, and line color.
-     * @returns {ISimpleLineSymbol | undefined}
+     * Axis labels text symbol (font, color, style).
      */
-    getAxisLinesSymbol(): ISimpleLineSymbol | undefined;
+    get axisLabelsSymbol(): WebChartTextSymbol | undefined;
+    set axisLabelsSymbol(newAxisLabelsSymbol: WebChartTextSymbol | 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.
+     * Axis lines symbol (line width, style, color).
      */
-    setAxisLinesSymbol(newAxisLinesSymbol: ISimpleLineSymbol | undefined): void;
+    get axisLinesSymbol(): ISimpleLineSymbol | undefined;
+    set axisLinesSymbol(newAxisLinesSymbol: ISimpleLineSymbol | undefined);
     /**
      * Generate the proper x-axis title from the current config.
      *

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

@@ -2,33 +2,14 @@ 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

@@ -3,15 +3,11 @@ 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

@@ -2,103 +2,51 @@ 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-multi-axes.d.ts

@@ -71,13 +71,13 @@ export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
     getAxisValueFormat(axisIndex: number): CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions | undefined;
     /**
      * Sets the value format for the specified axis.
-     * @param {CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions} valueFormat The value format to set.
      * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     * @param {CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions} valueFormat The value format to set.
      *
      * **NOTE**: The value format for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart.
      * To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
-    setAxisValueFormat(axisIndex: number, valueFormat?: CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions): Promise<void>;
+    setAxisValueFormat(axisIndex: number, valueFormat?: CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions): void;
     /**
      * Gets whether logarithmic scale is enabled for the specified axis.
      * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
@@ -278,61 +278,35 @@ export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
      */
     setIntegerOnlyValues(integerOnlyValues: boolean, axisIndex: number): void;
     /**
-     * Gets the visibility of the horizontal line of the cursor's crosshair.
-     * @returns {boolean}
+     * Visibility of the horizontal line of the cursor's crosshair.
      * @remarks if the cursor crosshair or its horizontal line visibility is not set, the default value of `false` will be returned.
-     */
-    getCursorCrosshairHorizontalLineVisibility(): boolean;
-    /**
-     * Sets the visibility of the horizontal line of the cursor's crosshair.
-     * @param visibility The visibility to set for the cursor's crosshair horizontal line
-     * @remarks if the cursor crosshair is not set, it will be created with the default values.
      *
      * **NOTE**: To set the cursor crosshair horizontal line visibility for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
-    setCursorCrosshairHorizontalLineVisibility(visibility: boolean): void;
+    get cursorCrosshairHorizontalLineVisibility(): boolean;
+    set cursorCrosshairHorizontalLineVisibility(visibility: boolean);
     /**
-     * Gets the visibility of the vertical line of the cursor's crosshair.
-     * @returns {boolean}
+     * Visibility of the vertical line of the cursor's crosshair.
      * @remarks if the cursor crosshair or its vertical line visibility is not set, the default value of `false` will be returned.
-     */
-    getCursorCrosshairVerticalLineVisibility(): boolean;
-    /**
-     * Sets the visibility of the vertical line of the cursor's crosshair.
-     * @param visibility The visibility to set for the cursor's crosshair vertical line
-     * @remarks if the cursor crosshair is not set, it will be created with the default values.
      *
      * **NOTE**: To set the cursor crosshair vertical line visibility for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
-    setCursorCrosshairVerticalLineVisibility(visibility: boolean): void;
-    /**
-     * Gets the style of the cursor's crosshair from the chart config.
-     * @param config The chart configuration
-     * @returns {boolean}
-     */
-    getCursorCrosshairStyle(): ISimpleLineSymbol | undefined;
+    get cursorCrosshairVerticalLineVisibility(): boolean;
+    set cursorCrosshairVerticalLineVisibility(visibility: boolean);
     /**
-     * Sets the style of the cursor's crosshair in the chart config.
-     * @param style The style to set for the cursor's crosshair
-     * @param config The chart configuration
+     * Style of the cursor's crosshair from the chart config.
      *
      * **NOTE**: To set the cursor crosshair style for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
-    setCursorCrosshairStyle(style: ISimpleLineSymbol): void;
-    /**
-     * Gets the cursor crosshair from the chart config.
-     * @param config The chart configuration object
-     * @returns {WebChartCursorCrosshair | undefined}
-     */
-    getCursorCrosshair(): WebChartCursorCrosshair | undefined;
+    get cursorCrosshairStyle(): ISimpleLineSymbol | undefined;
+    set cursorCrosshairStyle(style: ISimpleLineSymbol | undefined);
     /**
-     * Sets the cursor crosshair in the chart config.
-     * @param cursorCrosshair The cursor crosshair to set
-     * @param config The chart configuration object
+     * Cursor crosshair from the chart config.
      *
      * **NOTE**: To set the cursor crosshair for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
-    setCursorCrosshair(cursorCrosshair: WebChartCursorCrosshair): void;
+    get cursorCrosshair(): WebChartCursorCrosshair | undefined;
+    set cursorCrosshair(cursorCrosshair: WebChartCursorCrosshair | undefined);
     /**
      * Generate the proper y-axis title from the current config.
      *

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

@@ -1,13 +1,8 @@
 import { ChartModel } from '../chart-model/chart-model';
 export declare abstract class ModelWithRotation extends ChartModel {
     /**
-     * Gets whether the chart is rotated.
-     * @returns {boolean}
+     * Whether the chart is rotated.
      */
-    getRotatedState(): boolean;
-    /**
-     * Sets whether the chart is rotated.
-     * @param {boolean} rotated
-     */
-    setRotatedState(rotated: boolean): void;
+    get rotatedState(): boolean;
+    set rotatedState(rotated: boolean);
 }

package/dist/model/mixins/model-with-temporal-binning.d.ts

@@ -2,69 +2,36 @@ import { WebChartNullPolicyTypes, WebChartTemporalBinningUnits, WebChartTimeAggr
 import { ChartModel } from '../chart-model/chart-model';
 export declare abstract class ModelWithTemporalBinning extends ChartModel {
     /**
-     * Sets the time interval size for a temporal bar/line chart.
-     * @returns {number | undefined}
+     * Time interval size for a temporal bar/line chart.
      */
-    getTemporalBinningSize(): number | undefined;
+    get temporalBinningSize(): number | undefined;
+    set temporalBinningSize(newSize: number | undefined);
     /**
-     * Sets the time interval size for a temporal bar/line chart.
-     * @param {number | undefined} newSize The new time interval size.
+     * Time interval units for a temporal bar/line chart.
      */
-    setTemporalBinningSize(newSize: number | undefined): void;
+    get temporalBinningUnit(): WebChartTemporalBinningUnits | undefined;
+    set temporalBinningUnit(newUnit: WebChartTemporalBinningUnits | undefined);
     /**
-     * Gets the time interval units for a temporal bar/line chart.
-     * @returns {WebChartTemporalBinningUnits | undefined}
+     * Time aggregation type for a temporal bar/line chart.
      */
-    getTemporalBinningUnit(): WebChartTemporalBinningUnits | undefined;
+    get timeAggregationType(): WebChartTimeAggregationTypes | undefined;
+    set timeAggregationType(newTimeAggregationType: WebChartTimeAggregationTypes | undefined);
     /**
-     * Sets the time interval units for a temporal bar/line chart.
-     * @param {WebChartTemporalBinningUnits | undefined} newUnit The new time interval units.
+     * Whether to trim incomplete time intervals for a temporal bar/line chart.
      */
-    setTemporalBinningUnit(newUnit: WebChartTemporalBinningUnits | undefined): void;
+    get trimIncompleteTimeInterval(): boolean | undefined;
+    set trimIncompleteTimeInterval(newTrimIncompleteTimeInterval: boolean | undefined);
     /**
-     * Gets the time aggregation type for a temporal bar/line chart.
-     * @returns {WebChartTimeAggregationTypes | undefined}
-     */
-    getTimeAggregationType(): WebChartTimeAggregationTypes | undefined;
-    /**
-     * Sets the time aggregation type for a temporal bar/line chart.
-     * @param {WebChartTimeAggregationTypes | undefined} newTimeAggregationType The new time aggregation type.
-     */
-    setTimeAggregationType(newTimeAggregationType: WebChartTimeAggregationTypes | undefined): void;
-    /**
-     * Gets whether to trim incomplete time intervals for a temporal bar/line chart.
-     * @returns {boolean | undefined}
-     */
-    getTrimIncompleteTimeInterval(): boolean | undefined;
-    /**
-     * Sets whether to trim incomplete time intervals for a temporal bar/line chart.
-     * @param {boolean | undefined} newTrimIncompleteTimeInterval The new state.
-     */
-    setTrimIncompleteTimeInterval(newTrimIncompleteTimeInterval: boolean | undefined): void;
-    /**
-     * Gets the policy which tells the chart how to handle null values.
-     *
-     * `null`: Break the bar where null values are present.
-     *
-     * `zero`: Treats null values as zero.
-     *
-     * `interpolate`: Bar series: same effect as `null` - Line series: connects the lines across null values.
-     *
-     * @return {WebChartNullPolicyTypes | undefined}
-     */
-    getNullPolicy(): WebChartNullPolicyTypes | undefined;
-    /**
-     * Sets the policy which tells the chart how to handle null values.
+     * Policy which tells the chart how to handle null values.
      *
      * `null`: Break the bar where null values are present.
      *
      * `zero`: Treats null values as zero.
      *
      * `interpolate`: Bar series: same effect as `null` - Line series: connects the lines across null values.
-     *
-     * @param {WebChartNullPolicyTypes | undefined} newNullPolicy The new null policy.
      */
-    setNullPolicy(newNullPolicy: WebChartNullPolicyTypes | undefined): void;
+    get nullPolicy(): WebChartNullPolicyTypes | undefined;
+    set nullPolicy(newNullPolicy: WebChartNullPolicyTypes | undefined);
     /**
      * Resets the time interval to default for a temporal line chart.
      */