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

package/dist/model/gauge-model/utils/gauge-series.d.ts

@@ -1,50 +0,0 @@
-import { ChartConfig, CommonStrings } from '../../../utils';
-import { ValueConversion, GaugeChartSubTypes } from '../../../spec';
-import { LayerInfo, ModelTypes } from '../../interfaces/common';
-/**
- * Gets the conversion to apply to the gauge value.
- *
- * @param config - The gauge chart configuration object
- */
-export declare const getValueConversion: (config: ChartConfig<typeof ModelTypes.Gauge>) => ValueConversion | undefined;
-/**
- * Sets the conversion to apply to the gauge value.
- *
- * @param valueConversion - The conversion to apply
- * @param config - The gauge chart configuration object
- */
-export declare const setValueConversion: (valueConversion: ValueConversion | undefined, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
-/**
- * Gets the index of the feature to be rendered.
- *
- * This property will be ignored for a statistic gauge (indicated via `WebGaugeChart.subType` property).
- * For feature-based gauge, if this property is not present, the first feature will be used (`featureIndex = 0`)
- *
- * @param config - The gauge chart configuration object
- * @returns The index of the feature to be rendered
- */
-export declare const getFeatureIndex: (config: ChartConfig<typeof ModelTypes.Gauge>) => number | undefined;
-/**
- * Sets the index of the feature to be rendered.
- *
- * This property will be ignored for a statistic gauge (indicated via `WebGaugeChart.subType` property).
- *
- * @param props.featureIndex - The index of the feature to be rendered
- * @param props.config - The gauge chart configuration object
- * @param props.layerInfo - The layer information
- * @param props.commonStrings - The common strings
- */
-export declare const setFeatureIndex: (props: {
-    featureIndex: number | null | undefined;
-    config: ChartConfig<typeof ModelTypes.Gauge>;
-    layerInfo: LayerInfo;
-    commonStrings: CommonStrings;
-}) => void;
-/**
- * Gets the type of Gauge chart, like `FeatureGauge` and `StatisticGauge`.
- *
- * When this property is not specified, it will be defaulted to `GaugeChartSubTypes.StatisticGauge`.
- *
- * @param config - The chart configuration
- */
-export declare const getGaugeSubType: (config: ChartConfig<typeof ModelTypes.Gauge>) => GaugeChartSubTypes;

package/dist/model/heat-chart-model/utils/heat-chart-data.d.ts

@@ -1,186 +0,0 @@
-import { ISimpleFillSymbol, WebChartCalendarDatePartsBinning, WebChartHeatChartGradient, WebChartHeatChartHeatRulesTypes, WebChartNullPolicyTypes, WebHeatChart, WebChartLegendPositions, WebChartStatisticType } from '../../../spec';
-import { ChartConfig } from '../../../utils';
-import { LayerInfo, ModelTypes } from '../../interfaces/common';
-type HeatChartConfig = ChartConfig<typeof ModelTypes.HeatChart, WebHeatChart>;
-/**
- * Sets the x field
- * @param xField The numeric field
- * @param config The heat chart config
- * @param layerInfo The layer info
- */
-export declare const setXField: (props: {
-    xField: string;
-    config: HeatChartConfig;
-    layerInfo: LayerInfo;
-}) => void;
-/**
- * Gets the x field
- * @param config the heat chart config
- */
-export declare const getXField: (config: HeatChartConfig) => string;
-/**
- * Gets the hide empty rows and columns setting
- * @param config The heat chart config
- */
-export declare const getHideEmptyRowsAndColumns: (config: HeatChartConfig) => boolean | undefined;
-/**
- * Sets the hide empty rows and columns setting
- * @param config The heat chart config
- * @param hideEmptyRowsAndColumns The hide empty rows and columns setting
- */
-export declare const setHideEmptyRowsAndColumns: (config: HeatChartConfig, hideEmptyRowsAndColumns: boolean | undefined) => void;
-/**
- * Sets the heat rule type
- * @param config the chart config
- * @param heatRulesType the heat rules type
- */
-export declare const setHeatRulesType: (config: HeatChartConfig, heatRulesType?: WebChartHeatChartHeatRulesTypes) => void;
-/**
- * Gets the heat rule type
- * @param config the chart config
- */
-export declare const getHeatRulesType: (config: HeatChartConfig) => WebChartHeatChartHeatRulesTypes | undefined;
-/**
- * Sets the gradient rules
- * @param config the chart config
- * @param gradientRules the gradient rules
- */
-export declare const setGradientRules: (config: HeatChartConfig, gradientRules?: WebChartHeatChartGradient) => void;
-/**
- * Gets the gradient rules
- * @param config the chart config
- */
-export declare const getGradientRules: (config: HeatChartConfig) => WebChartHeatChartGradient | undefined;
-/**
- * Sets the y field
- * @param yField The numeric field
- * @param config The heat chart config
- * @param layerInfo The layer info
- */
-export declare const setYField: (props: {
-    yField: string;
-    config: HeatChartConfig;
-    layerInfo: LayerInfo;
-}) => void;
-/**
- * Gets the y field
- * @param config the heat chart config
- */
-export declare const getYField: (config: HeatChartConfig) => string;
-/**
- * Sets x binning
- * @param binning the x binning
- * @param config The heat chart config
- */
-export declare const setXTemporalBinning: (binning: WebChartCalendarDatePartsBinning | undefined, config: HeatChartConfig) => void;
-/**
- * Gets the x binning
- * @param config the heat chart config
- */
-export declare const getXTemporalBinning: (config: HeatChartConfig) => WebChartCalendarDatePartsBinning | undefined;
-/**
- * Sets y binning
- * @param binning the y binning
- * @param config The heat chart config
- */
-export declare const setYTemporalBinning: (binning: WebChartCalendarDatePartsBinning | undefined, config: HeatChartConfig) => void;
-/**
- * Gets the y binning
- * @param config the heat chart config
- */
-export declare const getYTemporalBinning: (config: HeatChartConfig) => WebChartCalendarDatePartsBinning | undefined;
-/**
- * Set the order by list in the config. The order by list is only used when the sort order kind is custom sort.
- * @param values The order by values
- * @param config The heat chart config
- */
-export declare const setHeatChartOrderByList: (values: string[], config: HeatChartConfig) => void;
-/**
- * Sets the grid line width
- * @param width the grid line width
- * @param config The heat chart config
- */
-export declare const setGridLineWidth: (width: number | undefined, config: HeatChartConfig) => void;
-/**
- * Gets the grid line width
- * @param config the heat chart config
- */
-export declare const getGridLineWidth: (config: HeatChartConfig) => number | undefined;
-/**
- * Sets the grid line color
- * @param color the grid line color
- * @param config The heat chart config
- */
-export declare const setGridLineColor: (newColor: number[] | undefined, config: HeatChartConfig) => void;
-/**
- * Gets the grid line width
- * @param config the heat chart config
- */
-export declare const getGridLineColor: (config: HeatChartConfig) => import('../../..').Color | undefined;
-/**
- * Sets the legend position
- * @param position the legend position
- * @param config The heat chart config
- */
-export declare const setLegendPosition: (position: WebChartLegendPositions, config: HeatChartConfig) => void;
-/**
- * Gets the legend position
- * @param config the heat chart config
- */
-export declare const getLegendPosition: (config: HeatChartConfig) => WebChartLegendPositions;
-/**
- * Gets the numericField from the query
- * @param config The heat chart config
- */
-export declare const getNumericField: (config: HeatChartConfig) => string | undefined;
-/**
- * Sets the numericField for the query
- * @param field the field
- * @param config The heat chart config
- */
-export declare const setNumericField: (field: string, config: HeatChartConfig) => void;
-/**
- * Gets the aggregationType from the query
- * @param config the heat chart config
- */
-export declare const getAggregationType: (config: HeatChartConfig) => "count" | "sum" | "min" | "max" | "avg" | "stddev" | "var" | "percentile-continuous" | "percentile-discrete" | "envelope-aggregate" | "centroid-aggregate" | "convex-hull-aggregate";
-/**
- * Sets the aggregationType for the query
- * @param aggregationType the aggregation type
- * @param config The heat chart config
- */
-export declare const setAggregationType: (aggregationType: WebChartStatisticType, config: HeatChartConfig) => void;
-/**
- * Gets the null policy
- * @param config the heat chart config
- */
-export declare const getNullPolicy: (config: HeatChartConfig) => WebChartNullPolicyTypes | undefined;
-/**
- * Sets the null policy for the query
- * @param nullPolicy the null policy
- * @param config The heat chart config
- */
-export declare const setNullPolicy: (nullPolicy: WebChartNullPolicyTypes | undefined, config: HeatChartConfig) => void;
-/**
- * Gets the empty cell text
- * @param config the heat chart config
- */
-export declare const getEmptyCellText: (config: HeatChartConfig) => string | undefined;
-/**
- * Sets the empty cell text
- * @param text the text
- * @param config The heat chart config
- */
-export declare const setEmptyCellText: (text: string | undefined, config: HeatChartConfig) => void;
-/**
- * Gets the empty cell symbol
- * @param config the heat chart config
- */
-export declare const getEmptyCellSymbol: (config: HeatChartConfig) => ISimpleFillSymbol | undefined;
-/**
- * Sets the empty cell symbol
- * @param symbol the symbol
- * @param config The heat chart config
- */
-export declare const setEmptyCellSymbol: (symbol: ISimpleFillSymbol | undefined, config: HeatChartConfig) => void;
-export {};

package/dist/model/histogram-model/utils/histogram-data.d.ts

@@ -1,158 +0,0 @@
-import { HistogramOverlays, ISimpleFillSymbol, ISimpleLineSymbol, WebChartDataTransformations } from '../../../spec';
-import { CommonStrings, HistogramConfig } from '../../../utils';
-import { LayerInfo } from '../../interfaces/common';
-/**
- * Generate the proper chart title given the current config.
- */
-export declare function getChartTitle(config: HistogramConfig, layerInfo: LayerInfo, commonStrings: CommonStrings): string;
-/**
- * Gets the numeric field from the config
- * @param config The histogram config
- */
-export declare const getNumericField: (config: HistogramConfig) => string;
-/**
- * Sets the numeric field in the config
- * @param numericField The numeric field
- * @param config The histogram config
- * @param layerInfo The layer info
- * @param commonStrings The common strings
- */
-export declare const setNumericField: (props: {
-    numericField: string;
-    config: HistogramConfig;
-    layerInfo: LayerInfo;
-    commonStrings: CommonStrings;
-}) => void;
-/**
- * Gets the data transformation type from the config
- * @param config The histogram config
- */
-export declare const getDataTransformationType: (config: HistogramConfig) => WebChartDataTransformations;
-/**
- * Sets the data transformation type in the config
- * @param dataTransformationType The data transformation type
- * @param config The histogram config
- */
-export declare const setDataTransformationType: (dataTransformationType: WebChartDataTransformations, config: HistogramConfig) => void;
-/**
- * Gets the bin count from the config
- * @param config the histogram config
- * @returns the bin count
- */
-export declare const getBinCount: (config: HistogramConfig) => number;
-/**
- * Sets the bin count in the config
- * @param binCount The bin count
- * @param config The histogram config
- */
-export declare const setBinCount: (binCount: number, config: HistogramConfig) => void;
-/**
- * Gets the bin symbol from the config
- * @param config The histogram config
- */
-export declare const getBinSymbol: (config: HistogramConfig) => ISimpleFillSymbol;
-/**
- * Sets the bin symbol in the config
- * @param symbol The bin symbol
- * @param config The histogram config
- */
-export declare const setBinSymbol: (symbol: ISimpleFillSymbol, config: HistogramConfig) => void;
-/**
- * Gets the normal distribution symbol from the config
- * @param config The histogram config
- */
-export declare const getNormalDistSymbol: (config: HistogramConfig) => ISimpleLineSymbol;
-/**
- * Sets the normal distribution symbol in the config
- * @param symbol The normal distribution symbol
- * @param config The histogram config
- */
-export declare const setNormalDistSymbol: (symbol: ISimpleLineSymbol, config: HistogramConfig) => void;
-/**
- * Gets the mean symbol from the config
- * @param config The histogram config
- */
-export declare const getMeanSymbol: (config: HistogramConfig) => ISimpleLineSymbol;
-/**
- * Sets the mean symbol in the config
- * @param symbol The mean symbol
- * @param config The histogram config
- */
-export declare const setMeanSymbol: (symbol: ISimpleLineSymbol, config: HistogramConfig) => void;
-/**
- * Gets the median symbol from the config
- * @param config The histogram config
- */
-export declare const getMedianSymbol: (config: HistogramConfig) => ISimpleLineSymbol;
-/**
- * Sets the median symbol in the config
- * @param symbol The median symbol
- * @param config The histogram config
- */
-export declare const setMedianSymbol: (symbol: ISimpleLineSymbol, config: HistogramConfig) => void;
-/**
- * Gets the standard deviation symbol from the config
- * @param config The histogram config
- */
-export declare const getStandardDevSymbol: (config: HistogramConfig) => ISimpleLineSymbol;
-/**
- * Sets the standard deviation symbol in the config
- * @param symbol The standard deviation symbol
- * @param config The histogram config
- */
-export declare const setStandardDevSymbol: (symbol: ISimpleLineSymbol, config: HistogramConfig) => void;
-/**
- * Gets the show normal distribution overlay setting from the config
- * @param config The histogram config
- */
-export declare const getShowNormalDistOverlay: (config: HistogramConfig) => boolean;
-/**
- * Sets the show normal distribution overlay in the config
- * @param show Whether to show the normal distribution overlay
- * @param config The histogram config
- */
-export declare const setShowNormalDistOverlay: (show: boolean, config: HistogramConfig) => void;
-/**
- * Gets the show mean overlay setting from the config
- * @param config The histogram config
- */
-export declare const getShowMeanOverlay: (config: HistogramConfig) => boolean;
-/**
- * Sets the show mean overlay in the config
- * @param show Whether to show the mean overlay
- * @param config The histogram config
- */
-export declare const setShowMeanOverlay: (show: boolean, config: HistogramConfig) => void;
-/**
- * Gets the show median overlay setting from the config
- * @param config The histogram config
- */
-export declare const getShowMedianOverlay: (config: HistogramConfig) => boolean;
-/**
- * Sets the show median overlay in the config
- * @param show Whether to show the median overlay
- * @param config The histogram config
- */
-export declare const setShowMedianOverlay: (show: boolean, config: HistogramConfig) => void;
-/**
- * Gets the show standard deviation overlay setting from the config
- * @param config The histogram config
- */
-export declare const getShowStandardDevOverlay: (config: HistogramConfig) => boolean;
-/**
- * Sets the show standard deviation overlay in the config
- * @param show Whether to show standard deviation overlay
- * @param config The histogram config
- */
-export declare const setShowStandardDevOverlay: (show: boolean, config: HistogramConfig) => void;
-/**
- * Gets the chart overlays for the series. Histogram supports 4 overlays: **mean**, **median**, **standardDeviation** and **comparisonDistribution**.
- * @param config The histogram config
- */
-export declare const getSeriesOverlays: (config: HistogramConfig) => HistogramOverlays | undefined;
-/**
- * Sets the chart overlays for the series. Histogram supports 4 overlays: **mean**, **median**, **standardDeviation** and **comparisonDistribution**.
- * @param overlays The overlays
- * @param config The histogram config
- */
-export declare const setSeriesOverlays: (overlays: HistogramOverlays | undefined, config: HistogramConfig) => void;

package/dist/model/mixins/index.d.ts

@@ -1,13 +0,0 @@
-export * from './model-with-color-match';
-export * from './model-with-legend';
-export * from './model-with-basic-x-axis';
-export * from './model-with-tooltips';
-export * from './model-with-rotation';
-export * from './model-with-data-labels';
-export * from './model-with-guides';
-export * from './model-with-x-guides';
-export * from './model-with-y-guides';
-export * from './model-with-temporal-binning';
-export * from './model-with-line-marker-styling';
-export * from './model-with-baseline-stacking';
-export * from './model-with-multi-axes';

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);
-}