@arcgis/charts-components 5.0.0-next.136 → 5.0.0-next.138

package/dist/model/bar-chart-model/utils/bar-chart-series.d.ts

@@ -1,35 +0,0 @@
-import { ChartConfig } from '../../../utils';
-import { ModelTypes } from '../../interfaces/common';
-/**
- * Gets whether to hide oversized data labels of the side-by-side series based on the series index. If the index is out of bounds, it will return `undefined`.
- *
- * @param seriesIndex - The index of the series.
- * @param config - The chart configuration.
- */
-export declare const getHideOversizedSideBySideLabels: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart>) => boolean | undefined;
-/**
- * Sets whether to hide oversized data labels of the side-by-side series based on the series index.
- *
- * **NOTE:** This method will only work if the series is a bar chart series.
- *
- * @param hide - The value for hiding oversized labels.
- * @param seriesIndex - The index of the series.
- * @param config - The chart configuration.
- */
-export declare const setHideOversizedSideBySideLabels: (hide: boolean | undefined, seriesIndex: number, config: ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart>) => void;
-/**
- * Gets whether to hide oversized data labels of the stacked series based on the series index. If the index is out of bounds, it will return `undefined`.
- *
- * @param seriesIndex - The index of the series.
- * @param config - The chart configuration.
- */
-export declare const getHideOversizedStackedLabels: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart>) => boolean | undefined;
-/**
- * Sets whether to hide oversized data labels of the stacked series based on the series index.
- * @param hide - The value for hiding oversized stacked labels.
- * @param seriesIndex - The index of the series.
- * @param config - The chart configuration.
- *
- * **NOTE:** This method will only work if the series is a bar chart series.
- */
-export declare const setHideOversizedStackedLabels: (hide: boolean | undefined, seriesIndex: number, config: ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart>) => void;

package/dist/model/box-plot-model/utils/box-plot-data.d.ts

@@ -1,139 +0,0 @@
-import { BoxPlotConfig, ChartConfig, CommonStrings } from '../../../utils';
-import { Color, WebChartBoxPlotSeries, WebChartLineChartSeries } from '../../../spec';
-import { LayerInfo, ModelTypes, BoxPlotDataSortingKinds } from '../../interfaces/common';
-/**
- * Gets the category field.
- */
-export declare const getCategory: (config: BoxPlotConfig) => string;
-/**
- * Gets the split-by field.
- */
-export declare const getSplitByField: (config: BoxPlotConfig) => string;
-/**
- * Gets the numeric fields from the config object.
- *
- * @param config - box plot config object
- */
-export declare const getNumericFields: (config: BoxPlotConfig) => string[];
-/**
- * Builds a new series array based on the provided props.
- */
-export declare const buildNewSeries: (props: {
-    splitByField: string;
-    numericFields: string[];
-    category: string;
-    config: BoxPlotConfig;
-    layerInfo: LayerInfo;
-    commonStrings: CommonStrings;
-}) => Promise<void>;
-/**
- * Gets whether the values are standardized.
- */
-export declare const getStandardizeValues: (config: BoxPlotConfig) => boolean;
-/**
- * Gets the proper Y-axis title label based on the chart configuration.
- *
- * @param config - The box plot config
- * @param layerInfo - The layer info
- * @param commonStrings - The common strings
- */
-export declare function getYAxisTitleLabel(config: BoxPlotConfig, layerInfo: LayerInfo, commonStrings: CommonStrings): string;
-/**
- * Generates the proper chart title given the current config.
- *
- * @param config - The box plot config
- * @param layerInfo - The layer info
- * @param commonStrings - The common strings
- */
-export declare function getChartTitle(config: BoxPlotConfig, layerInfo: LayerInfo, commonStrings: CommonStrings): string;
-/**
- * Gets the default series name.
- *
- * @param props.series - The series to get the name for
- * @param props.splitByField - The split-by field
- * @param props.layerInfo - The layer info
- * @param props.commonStrings - The common strings
- */
-export declare const getDefaultSeriesName: (props: {
-    series: WebChartBoxPlotSeries | WebChartLineChartSeries;
-    splitByField: string;
-    layerInfo: LayerInfo;
-    commonStrings: CommonStrings;
-}) => string;
-/**
- * Gets whether the outliers are shown.
- */
-export declare const getShowOutliers: (config: BoxPlotConfig) => boolean;
-/**
- * Sets whether the outliers are shown.
- */
-export declare const setShowOutliers: (props: {
-    newShowOutliers: boolean;
-    config: BoxPlotConfig;
-    layerInfo: LayerInfo;
-    commonStrings: CommonStrings;
-}) => void;
-/**
- * Sets whether the values are standardized.
- */
-export declare const setStandardizeValues: (props: {
-    newStandardizeValues: boolean;
-    config: BoxPlotConfig;
-    layerInfo: LayerInfo;
-    commonStrings: CommonStrings;
-}) => void;
-/**
- * Gets the sort order.
- */
-export declare const getSortOrderKind: (config: BoxPlotConfig) => BoxPlotDataSortingKinds;
-/**
- * Sets the sort order.
- */
-export declare const setSortOrderKind: (newSortOrderKind: BoxPlotDataSortingKinds, config: ChartConfig<typeof ModelTypes.BoxPlot>, orderByList?: string[]) => void;
-/**
- * Gets whether the mean lines are shown.
- * @param config
- */
-export declare const getShowMeanLines: (config: BoxPlotConfig) => boolean;
-/**
- * Sets whether the mean lines are shown. Rebuilds the series array.
- * @param props.newShowMeanLines Whether to show the mean lines
- * @param props.config The config to update
- * @param props.commonStrings The common strings to use
- * @param props.previousMeanLinesBoxColor The previous color of the boxes when mean lines were enabled
- */
-export declare const setShowMeanLines: (props: {
-    newShowMeanLines?: boolean;
-    config: BoxPlotConfig;
-    commonStrings: CommonStrings;
-    previousMeanLinesBoxColor?: Color;
-}) => {
-    previousMeanLinesBoxColor: Color | undefined;
-};
-/**
- * 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.BoxPlot>} config - The chart config.
- *
- * @returns string[] - The order by list.
- */
-export declare const getOrderByList: (config: ChartConfig<typeof ModelTypes.BoxPlot>) => 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[]} values - The order by list.
- * @param  {ChartConfig<typeof ModelTypes.BoxPlot>} config - The chart config.
- */
-export declare const setOrderByList: (values: string[], config: ChartConfig<typeof ModelTypes.BoxPlot>) => void;
-/**
- * Get the custom sort values from the config.
- * @param  {ChartConfig<typeof ModelTypes.BoxPlot>} config - The chart config.
- * @param  {LayerInfo} layerInfo - The layer info.
- *
- * @returns string[] - The custom sort values.
- */
-export declare const getCustomSortValues: (config: ChartConfig<typeof ModelTypes.BoxPlot>, layerInfo: LayerInfo) => Promise<string[]>;
-export declare const categoryIsEmpty: (category: string) => boolean;
-export declare const shouldClearSplitByField: (category: string, numericFields: string[]) => boolean;
-/**
- * Determines whether to use the split-by field based on the current category and numeric fields.
- */
-export declare const shouldUseSplitBy: (category: string, numericFields: string[], splitByField: string) => boolean;

package/dist/model/box-plot-model/utils/box-plot-series.d.ts

@@ -1,66 +0,0 @@
-import { Color } from '../../../spec';
-import { BoxPlotConfig } from '../../../utils';
-/**
- * get series name of the given series from the in config object using series index
- * @param seriesIndex - index of series in series array
- * @param config - config object
- */
-export declare const getName: (seriesIndex: number, config: BoxPlotConfig) => string | undefined;
-/**
- * set series name of the given series in the series array in config object using series index
- * @param newName - new name to be set
- * @param seriesIndex - index of series in series array
- * @param config - config object
- */
-export declare const setName: (newName: string, seriesIndex: number, config: BoxPlotConfig) => void;
-/**
- * get series color of the given series from the series array in config object using series index
- * @param seriesIndex - index of series in series array
- * @param config - config object
- */
-export declare const getColor: (seriesIndex: number, config: BoxPlotConfig) => Color | undefined;
-/**
- * get color of the box plot series from config object used when show mean is true
- * @param config
- */
-export declare const getMeanLinesBoxColor: (config: BoxPlotConfig) => Color | undefined;
-/**
- * set color of the box plot series in config object used when show mean is true
- * @param newColor - new color to be set
- * @param config - config object
- */
-export declare const setMeanLinesBoxColor: (newColor: Color | undefined, config: BoxPlotConfig) => void;
-/**
- * set series color of the given series in the series array in config object using series index
- * @param newColor - new color to be set
- * @param seriesIndex - index of series in series array
- * @param config - config object
- */
-export declare const setColor: (newColor: Color | undefined, seriesIndex: number, config: BoxPlotConfig) => void;
-/**
- * get the order of series from the series array in config object
- * @param config - config object
- */
-export declare const getSeriesOrder: (config: BoxPlotConfig) => string[];
-/**
- * set the order of series in the series array in config object using new order of series
- * @param newSeriesOrder - new order of series to be set
- * @param config - config object
- * @returns void
- */
-export declare const setSeriesOrder: (newSeriesOrder: string[], config: BoxPlotConfig) => void;
-/**
- * Move a series in-place from one index to another in the series array in box plot config
- * @param fromIndex - index of the series to be moved
- * @param toIndex - index where the series should be moved
- * @param config - box plot config
- * @returns void
- */
-export declare const moveSeries: (fromIndex: number, toIndex: number, config: BoxPlotConfig) => void;
-/**
- * Get the index of the box plot series in the series array in config object when show mean is true.
- *
- * **NOTE**: There is only one box plot series when show mean is true. The function returns '-1' if show mean is false.
- * @param config - config object
- */
-export declare const getBoxPlotSeriesIndexWhenMeanLinesShown: (config: BoxPlotConfig) => number;

package/dist/model/decorators/model-setter.d.ts

@@ -1,7 +0,0 @@
-import { ChartModelBase } from '../chart-model/chart-model-base';
-/**
- * Decorator for property setter in a chart model that will:
- * - guard against async overwrite issues
- * - emit a config update event
- */
-export declare function modelSetter(_target: ChartModelBase, propertyKey: string, descriptor: PropertyDescriptor): PropertyDescriptor;

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

@@ -1,168 +0,0 @@
-import { ChartConfig } from '../../../utils';
-import { ISimpleFillSymbol, WebChartTextSymbol } from '../../../spec';
-import { ModelTypes } from '../../interfaces/common';
-/**
- * Gets the visibility of the needle.
- *
- * **Note**: If the needle or its visibility is not set, the default value of `true` will be returned.
- *
- * @param config - The chart configuration object
- */
-export declare const getNeedleVisibility: (config: ChartConfig<typeof ModelTypes.Gauge>) => boolean;
-/**
- * Sets the visibility of the needle.
- *
- * **Note**: If the needle is not set, it will be created with the default values.
- *
- * @param visible - The visibility to set for the needle
- * @param config - The chart configuration object
- */
-export declare const setNeedleVisibility: (visible: boolean, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
-/**
- * Gets the symbol of the needle.
- *
- * @param config - The chart configuration object
- */
-export declare const getNeedleSymbol: (config: ChartConfig<typeof ModelTypes.Gauge>) => ISimpleFillSymbol | undefined;
-/**
- * Sets the symbol of the needle.
- *
- * **Note**: If the needle is not set, it will be created with the default values.
- *
- * @param symbol - The symbol to set for the needle
- * @param config - The chart configuration object
- */
-export declare const setNeedleSymbol: (symbol: ISimpleFillSymbol | undefined, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
-/**
- * Gets the start width of the needle.
- *
- * @param config - The chart configuration object
- */
-export declare const getNeedleStartWidth: (config: ChartConfig<typeof ModelTypes.Gauge>) => number | null | undefined;
-/**
- * Sets the start width of the needle.
- *
- * **Note**: If the needle is not set, it will be created with the default values.
- *
- * @param startWidth - The start width to set for the needle
- * @param config - The chart configuration object
- */
-export declare const setNeedleStartWidth: (width: number | null | undefined, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
-/**
- * Gets the end width of the needle.
- *
- * @param config - The chart configuration object
- */
-export declare const getNeedleEndWidth: (config: ChartConfig<typeof ModelTypes.Gauge>) => number | null | undefined;
-/**
- * Sets the end width of the needle.
- *
- * **Note**: If the needle is not set, it will be created with the default values.
- *
- * @param width - The end width to set for the needle
- * @param config - The chart configuration object
- */
-export declare const setNeedleEndWidth: (width: number | null | undefined, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
-/**
- * Gets the inner radius of the needle.
- *
- * @param config - The chart configuration object
- */
-export declare const getNeedleInnerRadius: (config: ChartConfig<typeof ModelTypes.Gauge>) => number | null | undefined;
-/**
- * Sets the inner radius of the needle.
- *
- * **Note**: If the needle is not set, it will be created with the default values.
- *
- * @param innerRadius - The inner radius to set for the needle
- * @param config - The chart configuration object
- */
-export declare const setNeedleInnerRadius: (innerRadius: number | null | undefined, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
-/**
- * Gets whether to display the pin for the needle.
- *
- * @param config - The chart configuration object
- */
-export declare const getNeedleDisplayPin: (config: ChartConfig<typeof ModelTypes.Gauge>) => boolean;
-/**
- * Sets whether to display the pin for the needle.
- *
- * ***Note**: If the needle is not set, it will be created with the default values.
- *
- * @param displayPin - The visibility to set for the needle pin
- * @param config - The chart configuration object
- */
-export declare const setNeedleDisplayPin: (displayPin: boolean, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
-/**
- * Gets whether the gauge inner label is visible.
- *
- * @param config - The chart configuration object
- */
-export declare const getInnerLabelVisible: (config: ChartConfig<typeof ModelTypes.Gauge>) => boolean;
-/**
- * Sets whether the gauge inner label is visible.
- *
- * **Note**: If the inner label is not set, it will be created with the default values.
- *
- * @param visible - The visibility to set for the gauge inner label
- * @param config - The chart configuration object
- */
-export declare const setInnerLabelVisibility: (visible: boolean, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
-/**
- * Gets the content of the gauge inner label.
- *
- * @param config - The chart configuration object
- */
-export declare const getInnerLabelContent: (config: ChartConfig<typeof ModelTypes.Gauge>) => WebChartTextSymbol | undefined;
-/**
- * Sets the content of the gauge inner label.
- *
- * **Note**: If the inner label is not set, it will be created with the default values.
- *
- * @param content - The content to set for the gauge inner label
- * @param config - The chart configuration object
- */
-export declare const setInnerLabelContent: (content: WebChartTextSymbol | undefined, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
-/**
- * Gets the visibility of the gauge axis ticks.
- *
- * @param config - The chart configuration object
- */
-export declare const getAxisTickVisibility: (config: ChartConfig<typeof ModelTypes.Gauge>) => boolean;
-/**
- * Sets the visibility of the gauge axis ticks.
- *
- * **Note**: If the ticks are not set, it will be created with the default values.
- *
- * @param visible - The visibility to set for the gauge axis ticks
- * @param config - The chart configuration object
- */
-export declare const setAxisTickVisibility: (visible: boolean, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
-/**
- * Gets the increment between axis labels.
- *
- * @param config - The chart configuration object
- */
-export declare const getLabelsIncrement: (config: ChartConfig<typeof ModelTypes.Gauge>) => number | undefined;
-/**
- * Sets the increment between axis labels.
- *
- * @param increment - The increment to set for the axis labels
- * @param config - The chart configuration object
- */
-export declare const setLabelsIncrement: (increment: number | undefined, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
-/**
- * Gets whether to only show the first and last axis labels.
- *
- * **Note**: If the `onlyShowFirstAndLastLabels` is not set, the default value of `false` will be returned.
- *
- * @param config - The chart configuration object
- */
-export declare const getShowOnlyMinMaxLabels: (config: ChartConfig<typeof ModelTypes.Gauge>) => boolean;
-/**
- * Sets whether to only show the first and last axis labels.
- *
- * @param showOnlyFirstAndLastLabels - Indicator of whether to only show the first and last axis labels
- * @param config - The chart configuration object
- */
-export declare const setShowOnlyMinMaxLabels: (showOnlyFirstAndLastLabels: boolean, config: ChartConfig<typeof ModelTypes.Gauge>) => void;

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

@@ -1,96 +0,0 @@
-import { ChartConfig, CommonStrings } from '../../../utils';
-import { WebChartStatisticType } from '../../../spec';
-import { LayerInfo, ModelTypes } from '../../interfaces/common';
-export declare const updateSeries: (props: {
-    config: ChartConfig<typeof ModelTypes.Gauge>;
-    layerInfo: LayerInfo;
-    commonStrings: CommonStrings;
-    field: string;
-    aggregationType: WebChartStatisticType;
-}) => void;
-/**
- * Gets the aggregation type from the config.
- *
- * @param config - the guage chart config
- */
-export declare const getAggregationType: (config: ChartConfig<typeof ModelTypes.Gauge>) => WebChartStatisticType;
-/**
- * Sets the aggregation type to the config.
- */
-export declare const setAggregationType: (props: {
-    aggregationType: WebChartStatisticType;
-    config: ChartConfig<typeof ModelTypes.Gauge>;
-    layerInfo: LayerInfo;
-    commonStrings: CommonStrings;
-}) => void;
-/**
- * Checks if the feature index is valid.
- *
- * **Note**: It should be a number and greater than or equal to 0.
- *
- * @param featureIndex - the feature index
- */
-export declare const isValidFeatureIndex: (featureIndex?: number) => boolean;
-/**
- * Gets the field from the config.
- *
- * @param config - the guage chart config
- */
-export declare const getField: (config: ChartConfig<typeof ModelTypes.Gauge>) => string;
-/**
- * Sets the field to the config.
- *
- * @param props.field - The field to set
- * @param props.config - The guage chart config
- * @param props.layerInfo - The layer info
- * @param props.commonStrings - The common strings
- */
-export declare const setField: (props: {
-    field: string;
-    config: ChartConfig<typeof ModelTypes.Gauge>;
-    layerInfo: LayerInfo;
-    commonStrings: CommonStrings;
-}) => void;
-/**
- * Gets the inner radius from the config.
- *
- * @param config - the guage chart config
- */
-export declare const getInnerRadius: (config: ChartConfig<typeof ModelTypes.Gauge>) => number;
-/**
- * Sets the inner radius to the config.
- *
- * @param innerRadius - The inner radius to set
- * @param config - The guage chart config
- */
-export declare const setInnerRadius: (innerRadius: number, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
-/**
- * Gets the start angle from the config.
- *
- * @param config - The guage chart config
- */
-export declare const getStartAngle: (config: ChartConfig<typeof ModelTypes.Gauge>) => number;
-/**
- * Sets the start angle to the config.
- *
- * @param startAngle - The start angle to set
- * @param config - The guage chart config
- */
-export declare const setStartAngle: (startAngle: number, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
-/**
- * Gets the end angle from the config.
- *
- * @param config - The guage chart config
- */
-export declare const getEndAngle: (config: ChartConfig<typeof ModelTypes.Gauge>) => number;
-/**
- * Sets the end angle to the config.
- *
- * @param endAngle - The end angle to set
- * @param config - The guage chart config
- */
-export declare const setEndAngle: (endAngle: number, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
-/**
- * Gets the proper chart title given the current config.
- */
-export declare function getChartTitle(commonStrings: CommonStrings): string;

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;