@arcgis/charts-components 5.0.0-next.14 → 5.0.0-next.141

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

@@ -1,91 +0,0 @@
-import { WebChartTextSymbol, WebChartLegendPositions } from '../../../spec';
-import { ChartConfig } from '../../../utils';
-/**
- * Gets the legend visibility from the chart config.
- * @param config The chart configuration
- */
-export declare const getLegendVisibility: (config: ChartConfig) => boolean;
-/**
- * Sets the legend visibility in the chart config.
- * @param legendVisibility The legend visibility to set
- * @param config The chart configuration
- */
-export declare const setLegendVisibility: (legendVisibility: boolean, config: ChartConfig) => void;
-/**
- * Gets the legend title symbol from the chart config.
- * @param config The chart configuration
- */
-export declare const getLegendTitleSymbol: (config: ChartConfig) => WebChartTextSymbol | undefined;
-/**
- * Sets the legend title symbol in the chart config.
- * @param config The chart configuration
- * @param legendTitleSymbol The legend title symbol to set
- */
-export declare const setLegendTitleSymbol: (legendTitleSymbol: WebChartTextSymbol | undefined, config: ChartConfig) => void;
-/**
- * Gets the legend text symbol from the chart config.
- * @param config The chart configuration
- */
-export declare const getLegendTextSymbol: (config: ChartConfig) => WebChartTextSymbol | undefined;
-/**
- * Sets the legend text symbol in the chart config.
- * @param config The chart configuration
- * @param legendTextSymbol The legend text symbol to set
- */
-export declare const setLegendTextSymbol: (legendTextSymbol: WebChartTextSymbol | undefined, config: ChartConfig) => void;
-/**
- * Gets the legend title text
- * @param config The config object
- */
-export declare const getLegendTitleText: (config: ChartConfig) => string;
-/**
- * Sets the legend title text
- * @param legendTitle The legend title
- * @param config The config object
- */
-export declare const setLegendTitleText: (legendTitle: string, config: ChartConfig) => void;
-/**
- * Determines whether to show the legend title or not
- * @param config The config object
- */
-export declare const getLegendTitleVisibility: (config: ChartConfig) => boolean;
-/**
- * Sets the visibility of the legend title
- * @param visibility Whether to show the legend title or not
- * @param config The config object
- */
-export declare const setLegendTitleVisibility: (visibility: boolean, config: ChartConfig) => void;
-/**
- * Gets the legend position
- * @param config The config object
- */
-export declare const getLegendPosition: (config: ChartConfig) => WebChartLegendPositions;
-/**
- * Sets the legend position
- * @param legendPosition The legend position to set
- * @param config The config object
- */
-export declare const setLegendPosition: (legendPosition: WebChartLegendPositions, config: ChartConfig) => void;
-/**
- * Gets the round marker setting for the legend from the chart config.
- * @param config - the config configuration object
- */
-export declare const getLegendRoundMarker: (config: ChartConfig) => boolean;
-/**
- * Sets the round marker setting for the legend in the chart config.
- * @param roundMarker The round marker setting
- * @param config The config configuration object
- */
-export declare const setLegendRoundMarker: (roundMarker: boolean, config: ChartConfig) => void;
-/**
- * Gets the max height of the legend from the chart config.
- * @param config  The config configuration object
- * @returns
- */
-export declare const getLegendMaxHeight: (config: ChartConfig) => number | undefined;
-/**
- * Sets the max height of the legend in the chart config.
- * @param maxHeight The max height to set.
- * @param config The config configuration object
- */
-export declare const setLegendMaxHeight: (maxHeight: number, config: ChartConfig) => void;

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

@@ -1,112 +0,0 @@
-import { ChartConfig } from '../../../utils';
-import { Color, RESTSimpleLineSymbolStyle, RESTSimpleMarkerSymbolStyle } from '../../../spec';
-import { ModelTypes } from '../../interfaces/common';
-export declare const getLineStyle: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => RESTSimpleLineSymbolStyle | undefined;
-export declare const setLineStyle: (newStyle: RESTSimpleLineSymbolStyle | undefined, seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => void;
-export declare const getLineWidth: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => number | undefined;
-export declare const setLineWidth: (newWidth: number | undefined, seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => void;
-export declare const getMarkerColor: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => Color | undefined;
-export declare const setMarkerColor: (newColor: Color | undefined, seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => void;
-export declare const getMarkerStyle: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => RESTSimpleMarkerSymbolStyle | undefined;
-export declare const setMarkerStyle: (newStyle: RESTSimpleMarkerSymbolStyle | undefined, seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => void;
-export declare const getMarkerSize: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => number | undefined;
-export declare const setMarkerSize: (newSize: number | undefined, seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => void;
-/**
- * Specify whether line segments of the series should be smoothed.
- * @param {number} seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
- *
- * @default false
- * @returns {boolean}
- */
-export declare const isLineSmoothed: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => boolean;
-/**
- * Specify whether line segments of the series should be smoothed.
- * @param {boolean} smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
- * @param {number} seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
- */
-export declare const setLineSmoothed: (props: {
-    smoothed: boolean;
-    seriesIndex: number;
-    config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>;
-}) => void;
-/**
- * Specify whether the line series should show area.
- * @param {number} seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
- *
- * @default false
- * @returns {boolean}
- */
-export declare const isAreaVisible: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => boolean;
-/**
- * Specify whether the line series should show area.
- * @param {boolean} visible - `true` if the line series should show area, `false` otherwise.
- * @param {number} seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
- */
-export declare const setAreaVisible: (props: {
-    visible: boolean;
-    seriesIndex: number;
-    config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>;
-}) => void;
-/**
- * Indicate whether to show or hide the markers/bullets of the line series.
- * @param {number} seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
- *
- * @default true
- * @returns {boolean}
- */
-export declare const isMarkerVisible: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => boolean;
-/**
- * Indicate whether to show or hide the markers/bullets of the line series.
- * @param {boolean} visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
- * @param {number} seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
- */
-export declare const setMarkerVisible: (props: {
-    visible: boolean;
-    seriesIndex: number;
-    config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>;
-}) => void;
-/**
- * Specify the color of the filled area for line chart.
- * **Note:** areaColor will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
- * @param {number} seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
- * @returns {Color | undefined}
- */
-export declare const getAreaColor: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => Color | undefined;
-/**
- * Specify the color of the filled area for line chart.
- * **Note:** areaColor will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
- * @param {Color | undefined} color - The color of the filled area for line chart.
- * @param {number} seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
- */
-export declare const setAreaColor: (props: {
-    color: Color | undefined;
-    seriesIndex: number;
-    config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>;
-}) => void;
-/**
- * Specify whether to connect the lines when there's a gap in the data.
- * @param {number} seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
- * @returns {boolean | undefined}
- */
-export declare const getConnectLines: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => boolean | undefined;
-/**
- * Specify whether to connect the lines when there's a gap in the data.
- * **Note:** Can be overridden by the temporal data setting `nullPolicy`.
- * @param {boolean | undefined} connect - Whether to connect the gap in the data
- * @param {number} seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
- */
-export declare const setConnectLines: (props: {
-    connect: boolean | undefined;
-    seriesIndex: number;
-    config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>;
-}) => void;

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

@@ -1,62 +0,0 @@
-import { WebChartNullPolicyTypes, WebChartTemporalBinningUnits, WebChartTimeAggregationTypes } from '../../../spec';
-import { ChartConfig } from '../../../utils';
-/**
- * Gets the time interval size.
- * @param config The chart configuration.
- */
-export declare const getTemporalBinningSize: (config: ChartConfig) => number | undefined;
-/**
- * Gets the time interval units.
- * @param config The chart configuration.
- */
-export declare const getTemporalBinningUnit: (config: ChartConfig) => WebChartTemporalBinningUnits | undefined;
-/**
- * Gets the time aggregation type.
- * @param config The chart configuration.
- */
-export declare const getTimeAggregationType: (config: ChartConfig) => WebChartTimeAggregationTypes | undefined;
-/**
- * Gets whether to trim incomplete time interval.
- * @param config The chart configuration.
- */
-export declare const getTrimIncompleteTimeInterval: (config: ChartConfig) => boolean | undefined;
-/**
- * Gets the null policy.
- * @param config The chart configuration.
- */
-export declare const getNullPolicy: (config: ChartConfig) => WebChartNullPolicyTypes | undefined;
-/**
- * Sets the time interval size by updating the config accordingly.
- * @param newBinCount The new value for the interval size.
- * @param config The chart configuration.
- */
-export declare const setTemporalBinningSize: (newBinCount: number | undefined, config: ChartConfig) => void;
-/**
- * Sets the null policy by updating the config accordingly.
- * @param newNullPolicy The new value for the null policy.
- * @param config The chart configuration.
- */
-export declare const setNullPolicy: (newNullPolicy: WebChartNullPolicyTypes | undefined, config: ChartConfig) => void;
-/**
- * Sets the time interval units by updating the config accordingly.
- * @param newUnit The new value for the interval units.
- * @param config The chart configuration.
- */
-export declare const setTemporalBinningUnit: (newUnit: WebChartTemporalBinningUnits | undefined, config: ChartConfig) => void;
-/**
- * Sets the time aggregation type by updating the config accordingly.
- * @param newTimeAggregationType The new value for the aggregation type.
- * @param config The chart configuration.
- */
-export declare const setTimeAggregationType: (newTimeAggregationType: WebChartTimeAggregationTypes | undefined, config: ChartConfig) => void;
-/**
- * Sets whether to trim incomplete time interval by updating the config accordingly.
- * @param newTrimIncompleteTimeInterval The new value for the trim incomplete time interval property.
- * @param config The chart configuration.
- */
-export declare const setTrimIncompleteTimeInterval: (newTrimIncompleteTimeInterval: boolean | undefined, config: ChartConfig) => void;
-/**
- * Resets the time interval by setting its size to 0.
- * @param config The chart configuration.
- */
-export declare const resetTimeInterval: (config: ChartConfig) => void;

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

@@ -1,37 +0,0 @@
-import { ChartConfig } from '../../../utils';
-/**
- * Gets the visibility of the data tooltips.
- * @param config The chart configuration object
- * @param seriesIndex The index of the series.
- * @returns {boolean}
- * @remarks
- * a. If the seriesIndex is provided, the visibility for that series will be returned. Otherwise, the visibility of the first series will be returned.
- * b. If the visibility is not set on the series, the default value of `true` will be returned.
- */
-export declare const getDataTooltipVisibility: (config: ChartConfig, seriesIndex?: number) => boolean;
-/**
- * Sets the visibility of the data tooltips.
- * @param config The chart configuration object
- * @param visibility The visibility of the data tooltips.
- * @param seriesIndex The index of the series.
- * @remarks If the seriesIndex is provided, the visibility will be set for that series only. Otherwise, the visibility will be set for all series.
- */
-export declare const setDataTooltipVisibility: (config: ChartConfig, visibility: boolean, seriesIndex?: number) => void;
-/**
- * Gets the setting of the `dataTooltipReverseColor` property.
- * @param config The chart configuration object
- * @param seriesIndex The index of the series.
- * @returns {boolean}
- * @remarks
- * a. If the seriesIndex is provided, the dataTooltipReverseColor for that series will be returned. Otherwise, the same property of the first series will be returned.
- * b. If the dataTooltipReverseColor is not set on the series, the default value of `false` will be returned.
- */
-export declare const getDataTooltipReverseColor: (config: ChartConfig, seriesIndex?: number) => boolean;
-/**
- *
- * @param config The chart configuration object
- * @param reverseColor Indicator of whether to reverse the color.
- * @param seriesIndex The index of the series to set the reverse color.
- * @remarks If the seriesIndex is provided, the reverse color will be set for that series only. Otherwise, the reverse color will be set for all series.
- */
-export declare const setDataTooltipReverseColor: (config: ChartConfig, reverseColor: boolean, seriesIndex?: number) => void;

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

@@ -1,89 +0,0 @@
-import { ChartConfig, CommonStrings } from '../../../utils';
-import { WebChartStatisticType } from '../../../spec';
-import { LayerInfo, ModelTypes, PieChartDataModes, PieChartDataSortingKinds } from '../../interfaces/common';
-/**
- * Gets the category field.
- */
-export declare const getCategory: (config: ChartConfig<typeof ModelTypes.PieChart>) => string;
-/**
- * Gets the sort order kind.
- */
-export declare const getSortOrderKind: (config: ChartConfig<typeof ModelTypes.PieChart>, mode: PieChartDataModes) => PieChartDataSortingKinds;
-/**
- * Gets the numeric fields.
- */
-export declare const getNumericFields: (config: ChartConfig<typeof ModelTypes.PieChart>) => string[];
-/**
- * Gets the aggregation type.
- */
-export declare const getAggregationType: (config: ChartConfig<typeof ModelTypes.PieChart>, mode: PieChartDataModes) => WebChartStatisticType;
-/**
- * Gets the proper chart title given the current config.
- * @param {ChartConfig<typeof ModelTypes.PieChart>} props.config - The chart config.
- * @param {LayerInfo} props.layerInfo - The layer info.
- * @param {CommonStrings} props.commonStrings - The common strings.
- * @param {PieChartDataModes} props.mode - The pie chart data mode.
- */
-export declare function getChartTitle(props: {
-    config: ChartConfig<typeof ModelTypes.PieChart>;
-    layerInfo: LayerInfo;
-    commonStrings: CommonStrings;
-    mode: PieChartDataModes;
-}): string;
-/**
- * Sets the sort order by updating the config accordingly.
- */
-export declare const setSortOrderKind: (props: {
-    newSortOrderKind: PieChartDataSortingKinds;
-    config: ChartConfig<typeof ModelTypes.PieChart>;
-    orderByList?: string[];
-}) => void;
-/**
- * Sets the category field by updating the config accordingly.
- */
-export declare const setCategory: (props: {
-    newCategory: string;
-    config: ChartConfig<typeof ModelTypes.PieChart>;
-    layerInfo: LayerInfo | undefined;
-    commonStrings: CommonStrings;
-    mode: PieChartDataModes;
-}) => void;
-/**
- * Sets the aggregation type by updating the config accordingly.
- */
-export declare const setAggregationType: (props: {
-    newAggregationType: WebChartStatisticType;
-    config: ChartConfig<typeof ModelTypes.PieChart>;
-    layerInfo: LayerInfo;
-    commonStrings: CommonStrings;
-    mode: PieChartDataModes;
-}) => void;
-/**
- * Sets the numeric fields by updating the config accordingly.
- */
-export declare const setNumericFields: (props: {
-    newNumericFields: string[] | string;
-    config: ChartConfig<typeof ModelTypes.PieChart>;
-    layerInfo: LayerInfo | undefined;
-    commonStrings: CommonStrings;
-    mode: PieChartDataModes;
-}) => void;
-/**
- * Get the order by list from the config. The order by list is only used when the sort order kind is custom sort.
- * @param  {ChartConfig<typeof ModelTypes.PieChart>} config - The chart config.
- * @param  {PieChartDataModes} mode - The chart mode.
- *
- * @returns string[] - The order by list.
- */
-export declare const getOrderByList: (config: ChartConfig<typeof ModelTypes.PieChart>, mode: PieChartDataModes) => string[];
-/**
- * Set the order by list in the config. The order by list is only used when the sort order kind is custom sort.
- * @param  {string[]} props.values - The order by list.
- * @param  {ChartConfig<typeof ModelTypes.PieChart>} props.config - The chart config.
- * @param  {PieChartDataModes} props.mode - The chart mode.
- */
-export declare const setOrderByList: (props: {
-    values: string[];
-    config: ChartConfig<typeof ModelTypes.PieChart>;
-    mode: PieChartDataModes;
-}) => void;

package/dist/model/pie-chart-model/utils/pie-chart-legend.d.ts

@@ -1,65 +0,0 @@
-import { ChartConfig } from '../../../utils';
-/**
- * Gets the display of numerical value setting for the legend items from the chart config.
- * @param config The chart configuration object
- * @returns {boolean}
- * @remarks
- * This setting is only applicable to pie charts.
- */
-export declare const getDisplayNumericValue: (config: ChartConfig) => boolean;
-/**
- * Sets the display of numerical value setting for the legend items in the chart config.
- * @param displayNumericValue The setting for the display of numerical value in the legend
- * @param config The chart configuration object
- * @remarks
- * This setting is only applicable to pie charts.
- */
-export declare const setDisplayNumericValue: (displayNumericValue: boolean, config: ChartConfig) => void;
-/**
- * Gets the display of category setting for the legend items from the chart config.
- * @param config The chart configuration object
- * @returns {boolean}
- * @remarks
- * This setting is only applicable to pie charts.
- */
-export declare const getDisplayCategory: (config: ChartConfig) => boolean;
-/**
- * Sets the display of category setting for the legend items in the chart config.
- * @param displayCategory The setting for the display of category in the legend
- * @param config The chart configuration object
- * @remarks
- * This setting is only applicable to pie charts.
- */
-export declare const setDisplayCategory: (displayCategory: boolean, config: ChartConfig) => void;
-/**
- * Gets the display of percentage setting for the legend items from the chart config.
- * @param config The chart configuration object
- * @returns {boolean}
- * @remarks
- * This setting is only applicable to pie charts.
- */
-export declare const getDisplayPercentage: (config: ChartConfig) => boolean;
-/**
- * Sets the display of percentage setting for the legend items in the chart config.
- * @param displayPercentage The setting for the display of percentage in the legend
- * @param config The chart configuration object
- * @remarks
- * This setting is only applicable to pie charts.
- */
-export declare const setDisplayPercentage: (displayPercentage: boolean, config: ChartConfig) => void;
-/**
- * Gets the maximum width in pixel for the legend item labels from the chart config.
- * @param config The chart configuration object
- * @returns {number}
- * @remarks
- * This setting is only applicable to pie charts.
- */
-export declare const getLabelMaxWidth: (config: ChartConfig) => number;
-/**
- * Sets the maximum width in pixel for the legend item labels in the chart config.
- * @param displayPercentage The maximum width in pixel for the legend item labels
- * @param config The chart configuration object
- * @remarks
- * This setting is only applicable to pie charts.
- */
-export declare const setLabelMaxWidth: (labelMaxWidth: number, config: ChartConfig) => void;