@arcgis/charts-components 4.34.0-next.15 → 4.34.0-next.150

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 {

package/dist/model/mixins/model-with-multi-axes.d.ts

@@ -0,0 +1,289 @@
+import { XYChartTypes } from '../../utils';
+import { CategoryFormatOptions, DateTimeFormatOptions, NumberFormatOptions, WebChartAxisScrollBar, WebChartTextSymbol, ISimpleLineSymbol, WebChartLabelBehavior, WebChartCursorCrosshair } from '../../spec';
+import { ModelWithBasicXAxis } from './model-with-basic-x-axis';
+export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
+    protected _chartType: XYChartTypes;
+    /**
+     * Gets the title text of the specified axis.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     * @returns {string}
+     */
+    getAxisTitleText(axisIndex: number): string;
+    /**
+     * Sets the title text for the specified axis.
+     * **Note:** The title text 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.
+     * @param {string} titleText The title text for the axis.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     */
+    setAxisTitleText(titleText: string, axisIndex: number): void;
+    /**
+     * Gets the visibility of the specified axis title.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     * @returns {boolean}
+     */
+    getAxisTitleVisibility(axisIndex: number): boolean;
+    /**
+     * Sets the visibility of the specified axis title.
+     * **Note:** The title visibility 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.
+     * @param {boolean} isVisible The visibility state for the axis title.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     */
+    setAxisTitleVisibility(isVisible: boolean, axisIndex: number): void;
+    /**
+     * Gets the maximum bound 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).
+     *@returns {number}
+     */
+    getMaxBound(axisIndex: number): number;
+    /**
+     * Sets the maximum bound for the specified axis.
+     * **Note:** The maximum bound 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.
+     * @param {number | null} newMaxBound The value to set as the maximum bound.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     */
+    setMaxBound(newMaxBound: number | null, axisIndex: number): void;
+    /**
+     * Gets the minimum bound 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).
+     * @returns {number}
+     */
+    getMinBound(axisIndex: number): number;
+    /**
+     * Sets the minimum bound for the specified axis.
+     * **Note:** The minimum bound 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.
+     * @param {number | null} newMinBound The value to set as the minimum bound.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     */
+    setMinBound(newMinBound: number | null, axisIndex: number): void;
+    /**
+     * Gets the value format 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).
+     * @returns {CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions | undefined}
+     */
+    getAxisValueFormat(axisIndex: number): CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions | undefined;
+    /**
+     * Sets the value format for the specified axis.
+     * **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.
+     * @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.
+     */
+    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).
+     *
+     * `true`: Logarithmic scale is enabled for the specified axis.
+     *
+     * `false`: Logarithmic scale is disabled for the specified axis.
+     *
+     * @returns {boolean}
+     */
+    getLogarithmic(axisIndex: number): boolean;
+    /**
+     * Sets whether logarithmic scale is enabled for the specified axis.
+     * `true`: Enable logarithmic scale for the specified axis.
+     * `false`: Disable logarithmic scale for the specified axis.
+     * **Note:** The logarithmic scale 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.
+     * @param {boolean} isLogarithmic Whether to enable logarithmic scale 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).
+     */
+    setLogarithmic(isLogarithmic: boolean, axisIndex: number): void;
+    /**
+     * Gets the scrollbar configuration 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).
+     * @returns {WebChartAxisScrollBar | undefined}
+     */
+    getAxisScrollbar(axisIndex: number): WebChartAxisScrollBar | undefined;
+    /**
+     * Sets the scrollbar configuration for the specified axis.
+     * **Note:** The scrollbar configuration 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.
+     * @param {WebChartAxisScrollBar} scrollbar The scrollbar configuration to set.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     */
+    setAxisScrollbar(scrollbar: WebChartAxisScrollBar, axisIndex: number): void;
+    /**
+     * Gets the specified title text symbol. Contains styling information such as font, color, and symbol style.
+     * @returns {WebChartTextSymbol | undefined}
+     */
+    getAxisTitleSymbol(axisIndex: number): WebChartTextSymbol | undefined;
+    /**
+     * Sets the title text symbol for the specified axis. Contains styling information such as font, color, and symbol style.
+     * **Note:** The title text symbol 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.
+     * @param {WebChartTextSymbol | undefined} titleSymbol The title text symbol to set.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     */
+    setAxisTitleSymbol(titleSymbol: WebChartTextSymbol | undefined, axisIndex: number): void;
+    /**
+     * Gets the horizontal axis labels behavior for the chart.
+     * @returns {WebChartLabelBehavior}
+     */
+    getHorizontalAxisLabelsBehavior(): WebChartLabelBehavior;
+    /**
+     * Sets the horizontal axis labels behavior for the chart.
+     * **Note:** The horizontal axis labels behavior 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.
+     * @param horizontalBehavior The behavior for the horizontal axis labels.
+     */
+    setHorizontalAxisLabelsBehavior(horizontalBehavior: WebChartLabelBehavior): void;
+    /**
+     * Gets the vertical axis labels behavior for the chart.
+     * @returns {WebChartLabelBehavior}
+     */
+    getVerticalAxisLabelsBehavior(): WebChartLabelBehavior;
+    /**
+     * Sets the vertical axis labels behavior for the chart.
+     * **Note:** The vertical axis labels behavior 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.
+     * @param verticalBehavior The behavior for the vertical axis labels.
+     */
+    setVerticalAxisLabelsBehavior(verticalBehavior: WebChartLabelBehavior): void;
+    /**
+     * Gets the grid lines symbol. Contains styling information such as line width, line style, and line color.
+     * @returns {ISimpleLineSymbol | undefined}
+     */
+    getGridLinesSymbol(): ISimpleLineSymbol | undefined;
+    /**
+     * Sets the grid lines symbol. Contains styling information such as line width, line style, and line color.
+     * **Note:** To set the grid lines symbol 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.
+     * @param {ISimpleLineSymbol | undefined} linesSymbol The grid lines symbol.
+     * @param {number[]} axisIndices The indices of the axes to set the grid lines symbol for.
+     */
+    setGridLinesSymbol(linesSymbol: ISimpleLineSymbol | undefined, axisIndices?: number[]): void;
+    /**
+     * Get the default x-axis title text.
+     * @returns {Promise<string>}
+     */
+    getDefaultXAxisTitleText(): Promise<string>;
+    /**
+     * Gets the display zero line setting for the specified axis.
+     * @param axisIndex The index of the axis to get the display zero line for.
+     * @returns {boolean}
+     * @remarks
+     * a. This setting is only applicable to the axis of type ValueAxis.
+     * b. To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     * c. If the displayZeroLine is not set on the axis, the default value of `false` will be returned.
+     */
+    getDisplayZeroLine(axisIndex: number): boolean;
+    /**
+     * Sets the display zero line setting for the specified axis.
+     * @param displayZeroLine The display zero line setting for the axis.
+     * @param axisIndex The index of the axis to set the display zero line for.
+     * @remarks
+     * a. This setting is only applicable to the axis of type ValueAxis.
+     * b. To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     *
+     * **Note:** To set the display zero line 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.
+     */
+    setDisplayZeroLine(displayZeroLine: boolean, axisIndex: number): void;
+    /**
+     * Gets the display cursor tooltip setting for the specified axis.
+     * @param axisIndex The index of the axis to get the display cursor tooltip for.
+     * @returns {boolean}
+     * @remarks
+     * a. To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     * b. If the displayCursorTooltip is not set on the axis, the default value of `false` will be returned.
+     */
+    getDisplayCursorTooltip(axisIndex: number): boolean;
+    /**
+     * Sets the display cursor tooltip setting for the specified axis.
+     * @param displayCursorTooltip The display cursor tooltip setting for the axis.
+     * @param axisIndex The index of the axis to set the display cursor tooltip for.
+     * @remarks
+     * a. To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     *
+     * **Note:** To set the display cursor tooltip 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.
+     */
+    setDisplayCursorTooltip(displayCursorTooltip: boolean, axisIndex: number): void;
+    /**
+     * Gets the buffer setting for the specified axis.
+     * @param axisIndex The index of the axis
+     * @returns {boolean}
+     * @remarks
+     * a. This setting is only applicable to the axis of type ValueAxis.
+     * b. To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     * c. If the `buffer` is not set on the axis, the default value of `false` will be returned.
+     */
+    getBuffer(axisIndex: number): boolean;
+    /**
+     * Sets the buffer for the specified axis.
+     * @param buffer The setting for the buffer
+     * @param axisIndex The index of the axis
+     * @remarks
+     * a. This setting is only applicable to the axis of type ValueAxis.
+     * b. To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     *
+     * **Note:** To set the buffer 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.
+     */
+    setBuffer(buffer: boolean, axisIndex: number): void;
+    /**
+     * Gets the tick spacing setting for the specified axis.
+     * @param axisIndex The index of the axis
+     * @returns {number}
+     * @remarks
+     * a. To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     */
+    getTickSpacing(axisIndex: number): number | undefined;
+    /**
+     * Sets the tick spacing for the specified axis.
+     * @param tickSpacing The value to set for the tick spacing
+     * @param axisIndex The index of the axis
+     * @remarks
+     * a. To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     *
+     * **Note:** To set the tick spacing 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.
+     */
+    setTickSpacing(tickSpacing: number, axisIndex: number): void;
+    /**
+     * Gets the integer only values setting for the specified axis.
+     * @param axisIndex The index of the axis
+     * @returns {boolean}
+     * @remarks
+     * a. This setting is only applicable to the axis of type ValueAxis.
+     * b. To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     * c. If the `integerOnlyValues` is not set on the axis, the default value of `false` will be returned.
+     */
+    getIntegerOnlyValues(axisIndex: number): boolean;
+    /**
+     * Sets the integer only values setting for the specified axis.
+     * @param integerOnlyValues The boolean value to set for the integer only values setting
+     * @param axisIndex The index of the axis
+     * @remarks
+     * a. This setting is only applicable to the axis of type ValueAxis.
+     * b. To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     *
+     * **Note:** To set the integer only values 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.
+     */
+    setIntegerOnlyValues(integerOnlyValues: boolean, axisIndex: number): void;
+    /**
+     * 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.
+     *
+     * **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.
+     */
+    get cursorCrosshairHorizontalLineVisibility(): boolean;
+    set cursorCrosshairHorizontalLineVisibility(visibility: 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.
+     *
+     * **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.
+     */
+    get cursorCrosshairVerticalLineVisibility(): boolean;
+    set cursorCrosshairVerticalLineVisibility(visibility: boolean);
+    /**
+     * 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.
+     */
+    get cursorCrosshairStyle(): ISimpleLineSymbol | undefined;
+    set cursorCrosshairStyle(style: ISimpleLineSymbol | undefined);
+    /**
+     * 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.
+     */
+    get cursorCrosshair(): WebChartCursorCrosshair | undefined;
+    set cursorCrosshair(cursorCrosshair: WebChartCursorCrosshair | undefined);
+    /**
+     * Generate the proper y-axis title from the current config.
+     *
+     * @returns {string}
+     */
+    abstract generateYAxisTitle(): Promise<string> | string;
+}

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

@@ -1,70 +1,37 @@
-import { WebChartTimeAggregationTypes, WebChartFixedDateBinningUnits, WebChartNullPolicyTypes, WebChartCalendarBinningUnits } from '@arcgis/charts-spec';
+import { WebChartNullPolicyTypes, WebChartTemporalBinningUnits, WebChartTimeAggregationTypes } from '../../spec';
 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 {WebChartFixedDateBinningUnits | undefined}
+     * Time aggregation type for a temporal bar/line chart.
      */
-    getTemporalBinningUnit(): WebChartCalendarBinningUnits | WebChartFixedDateBinningUnits | undefined;
+    get timeAggregationType(): WebChartTimeAggregationTypes | undefined;
+    set timeAggregationType(newTimeAggregationType: WebChartTimeAggregationTypes | undefined);
     /**
-     * Sets the time interval units for a temporal bar/line chart.
-     * @param {WebChartFixedDateBinningUnits | undefined} newUnit The new time interval units.
+     * Whether to trim incomplete time intervals for a temporal bar/line chart.
      */
-    setTemporalBinningUnit(newUnit: WebChartFixedDateBinningUnits | 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.
      */