@arcgis/charts-components 5.0.0-next.98 → 5.0.0

package/dist/model/mixins/model-with-baseline-stacking.d.ts

@@ -1,21 +0,0 @@
-import { ChartConfig } from '../../utils';
-import { ChartModel } from '../chart-model/chart-model';
-import { ModelTypes } from '../interfaces/common';
-export declare abstract class ModelWithBaselineStacking extends ChartModel {
-    protected _config: ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>;
-    /**
-     * Specify how negative values are treated in stacked series.
-     * **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
-     *
-     * @param seriesIndex - The index of the series.
-     */
-    isNegativeValuesStackedToBaseline(seriesIndex: number): boolean;
-    /**
-     * Specify how negative values are treated in stacked series.
-     * **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
-     *
-     * @param stackNegativeValuesToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
-     * @param seriesIndex - The index of the series.
-     */
-    setNegativeValuesStackedToBaseline(stackNegativeValuesToBaseline: boolean, seriesIndex: number): void;
-}

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

@@ -1,50 +0,0 @@
-import { ISimpleLineSymbol, WebChartTextSymbol } from '../../spec';
-import { ChartModel } from '../chart-model/chart-model';
-export declare abstract class ModelWithBasicXAxis extends ChartModel {
-    /**
-     * The x-axis title text.
-     */
-    get xAxisTitleText(): string;
-    set xAxisTitleText(newXAxisTitleText: string);
-    /**
-     * Whether the x-axis labels are visible.
-     */
-    get xAxisLabelsVisibility(): boolean;
-    set xAxisLabelsVisibility(newXAxisLabelsVisibility: boolean);
-    /**
-     * Whether the x-axis title is visible.
-     * true: X-axis title is visible.
-     * false: X-axis title is hidden.
-     */
-    get xAxisTitleVisibility(): boolean;
-    set xAxisTitleVisibility(newXAxisTitleVisibility: boolean);
-    /**
-     * Maximum bound set for the x-axis. Null indicates no explicit maximum.
-     */
-    get maxXBound(): number | null;
-    set maxXBound(newMaxXBound: number | null);
-    /**
-     * Minimum bound set for the x-axis. Null indicates no explicit minimum.
-     */
-    get minXBound(): number | null;
-    set minXBound(newMinXBound: number | null);
-    /**
-     * X-axis title text symbol (font, color, style).
-     */
-    get xAxisTitleSymbol(): WebChartTextSymbol | undefined;
-    set xAxisTitleSymbol(newXAxisTitle: WebChartTextSymbol | undefined);
-    /**
-     * Axis labels text symbol (font, color, style).
-     */
-    get axisLabelsSymbol(): WebChartTextSymbol | undefined;
-    set axisLabelsSymbol(newAxisLabelsSymbol: WebChartTextSymbol | undefined);
-    /**
-     * Axis lines symbol (line width, style, color).
-     */
-    get axisLinesSymbol(): ISimpleLineSymbol | undefined;
-    set axisLinesSymbol(newAxisLinesSymbol: ISimpleLineSymbol | undefined);
-    /**
-     * Generate the proper x-axis title from the current config.
-     */
-    abstract generateXAxisTitle(): string;
-}

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

@@ -1,12 +0,0 @@
-import { ChartModel } from '../chart-model/chart-model';
-export declare abstract class ModelWithColorMatch extends ChartModel {
-    /**
-     * 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.
-     */
-    get colorMatch(): boolean;
-    set colorMatch(newColorMatch: boolean);
-}

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

@@ -1,15 +0,0 @@
-import { WebChartTextSymbol } from '../../spec';
-import { ChartModel } from '../chart-model/chart-model';
-export declare abstract class ModelWithDataLabels extends ChartModel {
-    /**
-     * Whether data labels are visible.
-     * true: visible, false: hidden.
-     */
-    get dataLabelsVisibility(): boolean;
-    set dataLabelsVisibility(newDataLabelsVisibility: boolean);
-    /**
-     * Data labels text symbol (font, color, style).
-     */
-    get dataLabelsSymbol(): WebChartTextSymbol | undefined;
-    set dataLabelsSymbol(newDataLabelsSymbol: WebChartTextSymbol | undefined);
-}

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

@@ -1,8 +0,0 @@
-import { ChartModel } from '../chart-model/chart-model';
-export declare abstract class ModelWithRotation extends ChartModel {
-    /**
-     * Whether the chart is rotated.
-     */
-    get rotatedState(): boolean;
-    set rotatedState(rotated: boolean);
-}

package/dist/model/mixins/utils/axes.d.ts

@@ -1,282 +0,0 @@
-import { ISimpleLineSymbol, WebChartAxisScrollBar, WebChartTextSymbol } from '../../../spec';
-import { ChartConfig } from '../../../utils';
-/**
- * Gets the axis title symbol for the specified axis index from the chart config.
- *
- * @param config - The chart config object
- * @param axisIndex - The index of the axis to get the title symbol for
- */
-export declare const getAxisTitleSymbol: (config: ChartConfig, axisIndex: number) => WebChartTextSymbol | undefined;
-/**
- * Sets the axis title symbol for the specified axis index in the chart config.
- *
- * @param props.config - The chart config object
- * @param props.axisIndex - The index of the axis to set the title symbol for
- * @param props.symbol - The symbol to set for the axis title
- */
-export declare const setAxisTitleSymbol: (props: {
-    config: ChartConfig;
-    axisIndex: number;
-    symbol: WebChartTextSymbol | undefined;
-}) => void;
-/**
- * Gets the axis labels text symbol from the chart config.
- *
- * @param config - The chart config object
- */
-export declare const getAxisLabelsSymbol: (config: ChartConfig) => WebChartTextSymbol | undefined;
-/**
- * Sets the axis labels text symbol in the chart config.
- *
- * @param config - The chart config object
- * @param symbol - The symbol to set for the axis labels
- */
-export declare const setAxisLabelsSymbol: (symbol: WebChartTextSymbol | undefined, config: ChartConfig) => void;
-/**
- * Gets the axis lines symbol from the chart config.
- *
- * @param config - The chart config object
- */
-export declare const getAxisLinesSymbol: (config: ChartConfig) => ISimpleLineSymbol | undefined;
-/**
- * Sets the axis lines symbol in the chart config.
- *
- * @param config - The chart config object
- * @param symbol - The symbol to set for the axis lines
- */
-export declare const setAxisLinesSymbol: (symbol: ISimpleLineSymbol | undefined, config: ChartConfig) => void;
-/**
- * Gets the grid lines symbol from the chart config.
- *
- * @param config - The chart config object
- */
-export declare const getGridLinesSymbol: (config: ChartConfig) => ISimpleLineSymbol | undefined;
-/**
- * Sets the grid lines symbol in the chart config.
- *
- * @param config - The chart config object
- * @param symbol - The symbol to set for the grid lines
- * @param axisIndices - The indices of the axes to set the grid lines symbol for.
- */
-export declare const setGridLinesSymbol: (symbol: ISimpleLineSymbol | undefined, config: ChartConfig, axisIndices: number[]) => void;
-/**
- * Gets the title text of the axis
- *
- * @param config - The chart config object
- * @param axisIndex - The index of the axis
- */
-export declare const getAxisTitleText: (axisIndex: number, config: ChartConfig) => string;
-/**
- * Sets the title text of the axis.
- *
- * @param title - The title text
- * @param axisIndex - The index of the axis
- * @param config - The chart config object
- */
-export declare const setAxisTitleText: (title: string, axisIndex: number, config: ChartConfig) => void;
-/**
- * Gets the visibility of the axis
- *
- * @param axisIndex - The index of the axis
- * @param config - The chart config object
- */
-export declare const getAxisVisibility: (axisIndex: number, config: ChartConfig) => boolean;
-/**
- * Sets the visibility of the axis
- *
- * @param visibility - Whether or not to show the axis
- * @param axisIndex - The index of the axis
- * @param config - The chart config object
- */
-export declare const setAxisVisibility: (visibility: boolean, axisIndex: number, config: ChartConfig) => void;
-/**
- * Gets the visibility of the axis labels
- * @param axisIndex - The index of the axis
- * @param config - The chart config object
- */
-export declare const getAxisLabelsVisibility: (axisIndex: number, config: ChartConfig) => boolean;
-/**
- * Sets the visibility of the axis labels
- * @param visibility - Whether or not to show the axis labels
- * @param axisIndex - The index of the axis
- * @param config - The chart config object
- */
-export declare const setAxisLabelsVisibility: (visibility: boolean, axisIndex: number, config: ChartConfig) => void;
-/**
- * Gets the visibility of the axis title.
- *
- * @param axisIndex - The index of the axis
- * @param config - The chart config object
- */
-export declare const getAxisTitleVisibility: (axisIndex: number, config: ChartConfig) => boolean;
-/**
- * Sets the visibility of the axis title.
- *
- * @param visibility - Whether or not to show the axis title
- * @param axisIndex - The index of the axis
- * @param config - The chart config object
- */
-export declare const setAxisTitleVisibility: (visibility: boolean, axisIndex: number, config: ChartConfig) => void;
-/**
- * Gets whether the X logarithmic scale is enabled.
- *
- * @param config - The chart config object
- */
-export declare const getXLogarithmic: (config: ChartConfig) => boolean;
-/**
- * Sets whether the X logarithmic scale is enabled.
- *
- * @param config - The chart config object
- * @param enableXLogarithmic - The value to set
- */
-export declare const setXLogarithmic: (config: ChartConfig, enableXLogarithmic: boolean) => void;
-/**
- * Gets whether the Y logarithmic scale is enabled.
- *
- * @param config - The chart config object
- */
-export declare const getYLogarithmic: (config: ChartConfig) => boolean;
-/**
- * Sets whether the Y logarithmic scale is enabled.
- *
- * @param config - The config object
- * @param enableYLogarithmic - The value to set
- */
-export declare const setYLogarithmic: (config: ChartConfig, enableYLogarithmic: boolean) => void;
-/**
- * Gets the x-axis scrollbar configuration.
- *
- * @param config - The chart config object
- */
-export declare const getXAxisScrollbar: (config: ChartConfig) => WebChartAxisScrollBar | undefined;
-/**
- * Sets the x-axis scrollbar configuration.
- *
- * @param config - The chart config object
- * @param scrollbar - The scrollbar configuration to set for the x-axis
- */
-export declare const setXAxisScrollbar: (config: ChartConfig, scrollbar: WebChartAxisScrollBar | undefined) => void;
-/**
- * Gets the y-axis scrollbar configuration.
- *
- * @param config - The chart config object
- */
-export declare const getYAxisScrollbar: (config: ChartConfig) => WebChartAxisScrollBar | undefined;
-/**
- * Sets the y-axis scrollbar configuration.
- *
- * @param config - The chart config object
- * @param scrollbar - The scrollbar configuration to set for the y-axis
- */
-export declare const setYAxisScrollbar: (config: ChartConfig, scrollbar: WebChartAxisScrollBar | undefined) => void;
-/**
- * Gets the display of zero line setting for the axis from the chart config.
- * - This setting is only applicable to the axis of type ValueAxis.
- * - To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
- * - If the displayZeroLine is not set on the axis, the default value of `false` will be returned.
- *
- * @param config - The chart configuration object
- * @param axisIndex - The index of the axis
- */
-export declare const getDisplayZeroLine: (config: ChartConfig, axisIndex: number) => boolean;
-/**
- * Sets the display of zero line for the axis in the chart config.'
- * - This setting is only applicable to the axis of type ValueAxis.
- * - To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
- *
- * @param config - The chart configuration object
- * @param displayZeroLine - The setting for the display of zero line in the axis
- * @param axisIndex - The index of the axis
- */
-export declare const setDisplayZeroLine: (config: ChartConfig, displayZeroLine: boolean, axisIndex: number) => void;
-/**
- * Gets the display cursor tooltips setting for the specified axis.
- * - To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
- * - If the displayCursorTooltip is not set on the axis, the default value of `false` will be returned.
- *
- * @param config - The chart configuration.
- * @param axisIndex - The index of the axis to get the setting for.
- */
-export declare const getDisplayCursorTooltip: (config: ChartConfig, axisIndex: number) => boolean;
-/**
- * Sets the display cursor tooltips for the specified axis.
- * To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
- *
- * @param props.config - The chart configuration.
- * @param props.displayCursorTooltip - Indicator whether to display cursor tooltip.
- * @param props.axisIndex - The index of the axis to set the setting for.
- */
-export declare const setDisplayCursorTooltip: (props: {
-    config: ChartConfig;
-    displayCursorTooltip: boolean;
-    axisIndex: number;
-}) => void;
-/**
- * Gets the buffer setting for the specified axis.
- * - This setting is only applicable to the axis of type ValueAxis.
- * - To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
- * - If the `buffer` is not set on the axis, the default value of `false` will be returned.
- *
- * @param config - The chart configuration object
- * @param axisIndex - The index of the axis
- */
-export declare const getBuffer: (config: ChartConfig, axisIndex: number) => boolean;
-/**
- * Sets the buffer for the specified axis.
- * - This setting is only applicable to the axis of type ValueAxis.
- * - To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
- *
- * @param props.config - The chart configuration.
- * @param props.buffer - The setting for the buffer
- * @param props.axisIndex - The index of the axis
- */
-export declare const setBuffer: (props: {
-    config: ChartConfig;
-    buffer: boolean;
-    axisIndex: number;
-}) => void;
-/**
- * Gets the tick spacing setting for the specified axis.
- * - To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
- *
- * @param config - The chart configuration object
- * @param axisIndex - The index of the axis
- */
-export declare const getTickSpacing: (config: ChartConfig, axisIndex: number) => number | undefined;
-/**
- * Sets the tick spacing for the specified axis.
- * - To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
- *
- * @param props.config - The chart configuration object
- * @param props.tickSpacing - The value to set for the tick spacing
- * @param props.axisIndex - The index of the axis
- */
-export declare const setTickSpacing: (props: {
-    config: ChartConfig;
-    tickSpacing: number;
-    axisIndex: number;
-}) => void;
-/**
- * Gets the integer only values setting for the specified axis.
- * - This setting is only applicable to the axis of type ValueAxis.
- * - To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
- * - If the `integerOnlyValues` is not set on the axis, the default value of `false` will be returned.
- *
- * @param config - The chart configuration object
- * @param axisIndex - The index of the axis
- */
-export declare const getIntegerOnlyValues: (config: ChartConfig, axisIndex: number) => boolean;
-/**
- * Sets the integer only values setting for the specified axis.
- * - This setting is only applicable to the axis of type ValueAxis.
- * - To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
- *
- * @param props.config - The chart configuration object
- * @param props.integerOnlyValues - The boolean value to set for the integer only values setting
- * @param props.axisIndex - The index of the axis
- */
-export declare const setIntegerOnlyValues: (props: {
-    config: ChartConfig;
-    integerOnlyValues: boolean;
-    axisIndex: number;
-}) => void;

package/dist/model/mixins/utils/axis-label-behaviors.d.ts

@@ -1,26 +0,0 @@
-import { ChartConfig } from '../../../utils';
-import { WebChartLabelBehavior } from '../../../spec';
-/**
- * Gets the horizontal axis labels behavior.
- *
- * @param config - The chart configuration.
- */
-export declare const getHorizontalAxisLabelsBehavior: (config: ChartConfig) => WebChartLabelBehavior;
-/**
- * Sets the horizontal axis labels behavior.
- *
- * @param behavior - The behavior for the horizontal axis labels.
- * @param config - The chart configuration.
- */
-export declare const setHorizontalAxisLabelsBehavior: (behavior: WebChartLabelBehavior, config: ChartConfig) => void;
-/**
- * Gets the vertical axis labels behavior.
- * @param config   - The chart configuration.
- */
-export declare const getVerticalAxisLabelsBehavior: (config: ChartConfig) => WebChartLabelBehavior;
-/**
- * Sets the horizontal axis labels behavior.
- * @param behavior - The behavior for the horizontal axis labels.
- * @param config - The chart configuration.
- */
-export declare const setVerticalAxisLabelsBehavior: (behavior: WebChartLabelBehavior, config: ChartConfig) => void;

package/dist/model/mixins/utils/baseline-stacking.d.ts

@@ -1,23 +0,0 @@
-import { ChartConfig } from '../../../utils';
-import { ModelTypes } from '../../interfaces/common';
-/**
- * Specify how negative values are treated in stacked series.
- *  **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
- *
- * @param seriesIndex - The index of the series.
- * @param config - The chart configuration.
- */
-export declare const isNegativeValuesStackedToBaseline: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => boolean;
-/**
- * Specify how negative values are treated in stacked series.
- * **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
- *
- * @param stackNegativeValuesToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
- * @param seriesIndex - The index of the series.
- * @param config - The chart configuration.
- */
-export declare const setNegativeValuesStackedToBaseline: (props: {
-    stackNegativeValuesToBaseline: boolean;
-    seriesIndex: number;
-    config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>;
-}) => void;

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

@@ -1,14 +0,0 @@
-import { ChartConfig } from '../../../utils';
-/**
- * Gets the color match.
- *
- * @param config the chart configuration
- */
-export declare const getColorMatch: (config: ChartConfig) => boolean;
-/**
- * Sets the color match by updating the config accordingly.
- *
- * @param newColorMatch the new color match value
- * @param config the chart configuration
- */
-export declare const setColorMatch: (newColorMatch: boolean, config: ChartConfig) => void;

package/dist/model/mixins/utils/cursor-crosshair.d.ts

@@ -1,56 +0,0 @@
-import { ChartConfig } from '../../../utils';
-import { ISimpleLineSymbol, WebChartCursorCrosshair } from '../../../spec';
-/**
- * Gets the visibility of the horizontal line of the cursor's crosshair from the chart config.
- * **Note**: If the cursor crosshair or its horizontal line visibility is not set, the default value of `false` will be returned.
- *
- * @param config - The chart configuration
- */
-export declare const getCursorCrosshairHorizontalLineVisibility: (config: ChartConfig) => boolean;
-/**
- * Sets the visibility of the horizontal line of the cursor's crosshair in the chart config.
- *
- * @param visibility - The visibility to set for the cursor's crosshair horizontal line
- * @param config - The chart configuration
- */
-export declare const setCursorCrosshairHorizontalLineVisibility: (visibility: boolean, config: ChartConfig) => void;
-/**
- * Gets the visibility of the vertical line of the cursor's crosshair from the chart config.
- * **Note**: If the cursor crosshair or its vertical line visibility is not set, the default value of `false` will be returned.
- *
- * @param config - The chart configuration
- */
-export declare const getCursorCrosshairVerticalLineVisibility: (config: ChartConfig) => boolean;
-/**
- * Sets the visibility of the vertical line of the cursor's crosshair in the chart config.
- *
- * @param visibility - The visibility to set for the cursor's crosshair vertical line
- * @param config - The chart configuration
- */
-export declare const setCursorCrosshairVerticalLineVisibility: (visibility: boolean, config: ChartConfig) => void;
-/**
- * Gets the style of the cursor's crosshair from the chart config.
- *
- * @param config - The chart configuration
- */
-export declare const getCursorCrosshairStyle: (config: ChartConfig) => ISimpleLineSymbol | undefined;
-/**
- * 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
- */
-export declare const setCursorCrosshairStyle: (style: ISimpleLineSymbol, config: ChartConfig) => void;
-/**
- * Gets the cursor crosshair from the chart config.
- *
- * @param config - The chart configuration object
- */
-export declare const getCursorCrosshair: (config: ChartConfig) => WebChartCursorCrosshair | undefined;
-/**
- * Sets the cursor crosshair in the chart config.
- *
- * @param cursorCrosshair - The cursor crosshair to set
- * @param config - The chart configuration object
- */
-export declare const setCursorCrosshair: (cursorCrosshair: WebChartCursorCrosshair, config: ChartConfig) => void;

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

@@ -1,24 +0,0 @@
-import { ChartConfig } from '../../../utils';
-import { WebChartTextSymbol } from '../../../spec';
-/**
- * Gets the data labels visibility from the chart config.
- * @param config
- */
-export declare const getDataLabelsVisibility: (config: ChartConfig) => boolean;
-/**
- * Sets the data labels visibility in the chart config.
- * @param config
- * @param newDataLabelsVisibility
- */
-export declare const setDataLabelsVisibility: (newDataLabelsVisibility: boolean, config: ChartConfig) => void;
-/**
- * Gets the data labels text symbol from the chart config.
- * @param config
- */
-export declare const getDataLabelsSymbol: (config: ChartConfig) => WebChartTextSymbol | undefined;
-/**
- * Sets the data labels text symbol in the chart config.
- * @param config
- * @param newDataLabelsSymbol
- */
-export declare const setDataLabelsSymbol: (newDataLabelsSymbol: WebChartTextSymbol | undefined, config: ChartConfig) => void;