@arcgis/charts-components 5.0.0-next.1 → 5.0.0-next.100

package/dist/model/properties/fetch-null-values.d.ts

@@ -0,0 +1,20 @@
+import { ChartModelBase } from '../chart-model/chart-model-base';
+import { ChartConfig } from '../../utils';
+/**
+ * Sets whether to fetch `null` values for them to be counted or displayed as categories on the chart.
+ */
+export declare const setFetchNULLValues: (fetchNULLValues: boolean, config: ChartConfig) => void;
+/**
+ * Gets whether to fetch `null` values for them to be counted or displayed as categories on the chart.
+ */
+export declare const getFetchNULLValues: (config: ChartConfig) => boolean;
+/**
+ * Adds support for working with the fetch NULL values flag.
+ */
+export declare abstract class WithFetchNULLValues extends ChartModelBase {
+    /**
+     * Whether to fetch `null` values for them to be counted or displayed as categories on the chart.
+     */
+    get fetchNULLValues(): boolean;
+    set fetchNULLValues(fetchNULLValues: boolean);
+}

package/dist/model/properties/layer.d.ts

@@ -0,0 +1,11 @@
+import { SupportedLayer } from '../../interfaces';
+import { ChartModelBase } from '../chart-model/chart-model-base';
+/**
+ * Adds getter support for the associated layer reference.
+ */
+export declare abstract class WithLayer extends ChartModelBase {
+    /**
+     * The chart model's layer.
+     */
+    get layer(): SupportedLayer | undefined;
+}

package/dist/model/properties/series/series-id.d.ts

@@ -0,0 +1,19 @@
+import { ChartConfig } from '../../../utils';
+import { ChartModelBase } from '../../chart-model/chart-model-base';
+/**
+ * Gets the series ID for a given series index.
+ * If the series index is out of bounds, this function will return `undefined`.
+ */
+export declare const getSeriesId: (seriesIndex: number, config: ChartConfig) => string | undefined;
+/**
+ * Adds support for retrieving a series ID.
+ */
+export declare abstract class WithSeriesId extends ChartModelBase {
+    /**
+     * Gets the series ID for a given series index.
+     * If the series index is out of bounds, this function will return `undefined`.
+     *
+     * @param seriesIndex - The index of the series.
+     */
+    getSeriesId(seriesIndex: number): string | undefined;
+}

package/dist/model/properties/series/series-index.d.ts

@@ -0,0 +1,19 @@
+import { ChartConfig } from '../../../utils';
+import { ChartModelBase } from '../../chart-model/chart-model-base';
+/**
+ * Gets the series index for a given series ID.
+ * If the series ID is not found, this function will return `undefined`.
+ */
+export declare const getSeriesIndex: (seriesId: string, config: ChartConfig) => number | undefined;
+/**
+ * Adds support for retrieving a series index.
+ */
+export declare abstract class WithSeriesIndex extends ChartModelBase {
+    /**
+     * Gets the series index for a given series ID.
+     * If the series ID is not found, this function will return `undefined`.
+     *
+     * @param seriesId - The ID of the series.
+     */
+    getSeriesIndex(seriesId: string): number | undefined;
+}

package/dist/model/properties/series/series-length.d.ts

@@ -0,0 +1,15 @@
+import { ChartConfig } from '../../../utils';
+import { ChartModelBase } from '../../chart-model/chart-model-base';
+/**
+ * Gets the length of the series array from the chart config.
+ */
+export declare const getSeriesLength: (config: ChartConfig) => number;
+/**
+ * Adds support for reading the series length.
+ */
+export declare abstract class WithSeriesLength extends ChartModelBase {
+    /**
+     * The length of the series array.
+     */
+    get seriesLength(): number;
+}

package/dist/model/properties/series/series-visibility.d.ts

@@ -0,0 +1,28 @@
+import { LegendItemVisibility } from '../../../spec';
+import { ChartConfig } from '../../../utils';
+import { ChartModelBase } from '../../chart-model/chart-model-base';
+/**
+ * Gets the visibility of a series from the chart config.
+ */
+export declare const getSeriesVisibility: (seriesIndex: number, config: ChartConfig) => boolean;
+/**
+ * Sets the visibility of a series in the chart config.
+ */
+export declare const setSeriesVisibility: (props: LegendItemVisibility, config: ChartConfig) => void;
+/**
+ * Adds support for working with series visibility.
+ */
+export declare abstract class WithSeriesVisibility extends ChartModelBase {
+    /**
+     * Gets the visibility of a series.
+     *
+     * @param seriesIndex The series index
+     */
+    getSeriesVisibility(seriesIndex: number): boolean;
+    /**
+     * Sets the visibility of a series.
+     *
+     * @param props - Visibility options for the series.
+     */
+    setSeriesVisibility(props: LegendItemVisibility): void;
+}

package/dist/model/properties/split-by-values.d.ts

@@ -0,0 +1,15 @@
+import { ChartModelBase } from '../chart-model/chart-model-base';
+import { ChartConfig } from '../../utils';
+/**
+ * Gets the split by values from the chart config.
+ */
+export declare const getSplitByValues: (config: ChartConfig) => string[];
+/**
+ * Adds support for retrieving split-by values.
+ */
+export declare abstract class WithSplitByValues extends ChartModelBase {
+    /**
+     * The split-by values for the chart.
+     */
+    get splitByValues(): string[];
+}

package/dist/model/properties/subtitle/subtitle-symbol.d.ts

@@ -0,0 +1,21 @@
+import { WebChartTextSymbol } from '../../../spec';
+import { ChartConfig } from '../../../utils';
+import { ChartModelBase } from '../../chart-model/chart-model-base';
+/**
+ * Gets the subtitle text symbol from the chart config.
+ */
+export declare const getSubtitleSymbol: (config: ChartConfig) => WebChartTextSymbol | undefined;
+/**
+ * Sets the subtitle text symbol in the chart config.
+ */
+export declare const setSubtitleSymbol: (textSymbol: WebChartTextSymbol | undefined, config: ChartConfig) => void;
+/**
+ * Adds support for working with chart subtitle symbols.
+ */
+export declare abstract class WithSubtitleSymbol extends ChartModelBase {
+    /**
+     * The subtitle text symbol. Contains styling information such as font, color, and symbol style.
+     */
+    get subtitleSymbol(): WebChartTextSymbol | undefined;
+    set subtitleSymbol(subtitleSymbol: WebChartTextSymbol | undefined);
+}

package/dist/model/properties/subtitle/subtitle-text.d.ts

@@ -0,0 +1,20 @@
+import { ChartConfig } from '../../../utils';
+import { ChartModelBase } from '../../chart-model/chart-model-base';
+/**
+ * Gets the subtitle text of the chart from the config.
+ */
+export declare const getSubtitleText: (config: ChartConfig) => string;
+/**
+ * Sets the subtitle text of the chart.
+ */
+export declare const setSubtitleText: (subtitleText: string, config: ChartConfig) => void;
+/**
+ * Adds support for working with chart subtitle text.
+ */
+export declare abstract class WithSubtitleText extends ChartModelBase {
+    /**
+     * The chart subtitle text.
+     */
+    get subtitleText(): string;
+    set subtitleText(subtitle: string);
+}

package/dist/model/properties/subtitle/subtitle-visibility.d.ts

@@ -0,0 +1,26 @@
+import { ChartConfig } from '../../../utils/types';
+import { ChartModelBase } from '../../chart-model/chart-model-base';
+/**
+ * Gets whether the chart subtitle is visible.
+ */
+export declare const getChartSubtitleVisibility: (config: ChartConfig) => boolean;
+/**
+ * Sets whether the chart subtitle is visible.
+ */
+export declare const setChartSubtitleVisibility: (visibility: boolean, config: ChartConfig) => void;
+/**
+ * Adds support for working with chart subtitle visibility.
+ */
+export declare abstract class WithChartSubtitleVisibility extends ChartModelBase {
+    /**
+     * Whether or not the chart subtitle is visible.
+     *
+     * `true`: Chart subtitle is visible.
+     *
+     * `false`: Chart subtitle is hidden.
+     *
+     * **Note:** Even if the subtitle is visible, it may not be displayed if the subtitle text is empty.
+     */
+    get chartSubtitleVisibility(): boolean;
+    set chartSubtitleVisibility(visibility: boolean);
+}

package/dist/model/properties/title/title-symbol.d.ts

@@ -0,0 +1,21 @@
+import { WebChartTextSymbol } from '../../../spec';
+import { ChartConfig } from '../../../utils';
+import { ChartModelBase } from '../../chart-model/chart-model-base';
+/**
+ * Gets the title text symbol from the chart config.
+ */
+export declare const getTitleSymbol: (config: ChartConfig) => WebChartTextSymbol | undefined;
+/**
+ * Sets the title text symbol in the chart config.
+ */
+export declare const setTitleSymbol: (textSymbol: WebChartTextSymbol | undefined, config: ChartConfig) => void;
+/**
+ * Adds support for working with chart title symbols.
+ */
+export declare abstract class WithTitleSymbol extends ChartModelBase {
+    /**
+     * The title text symbol. Contains styling information such as font, color, and symbol style.
+     */
+    get titleSymbol(): WebChartTextSymbol | undefined;
+    set titleSymbol(titleSymbol: WebChartTextSymbol | undefined);
+}

package/dist/model/properties/title/title-text.d.ts

@@ -0,0 +1,20 @@
+import { ChartModelBase } from '../../chart-model/chart-model-base';
+import { ChartConfig } from '../../../utils';
+/**
+ * Gets the title text of the chart from the config.
+ */
+export declare const getTitleText: (config: ChartConfig) => string;
+/**
+ * Sets the title text of the chart.
+ */
+export declare const setTitleText: (titleText: string, config: ChartConfig) => void;
+/**
+ * Adds support for working with chart title text.
+ */
+export declare abstract class WithTitleText extends ChartModelBase {
+    /**
+     * The chart title text.
+     */
+    get titleText(): string;
+    set titleText(title: string);
+}

package/dist/model/properties/title/title-visibility.d.ts

@@ -0,0 +1,26 @@
+import { ChartConfig } from '../../../utils';
+import { ChartModelBase } from '../../chart-model/chart-model-base';
+/**
+ * Gets whether the chart title is visible.
+ */
+export declare const getChartTitleVisibility: (config: ChartConfig) => boolean;
+/**
+ * Sets whether the chart title is visible.
+ */
+export declare const setChartTitleVisibility: (visibility: boolean, config: ChartConfig) => void;
+/**
+ * Adds support for working with chart title visibility.
+ */
+export declare abstract class WithChartTitleVisibility extends ChartModelBase {
+    /**
+     * Whether or not the chart title is visible.
+     *
+     * `true`: Chart title is visible.
+     *
+     * `false`: Chart title is hidden.
+     *
+     * **Note:** Even if the title is visible, it may not be displayed if the title text is empty.
+     */
+    get chartTitleVisibility(): boolean;
+    set chartTitleVisibility(visibility: boolean);
+}

package/dist/model/properties/version.d.ts

@@ -0,0 +1,15 @@
+import { ChartConfig } from '../../utils/types';
+import { ChartModelBase } from '../chart-model/chart-model-base';
+/**
+ * Gets the version of the chart configuration.
+ */
+export declare const getVersion: (config: ChartConfig) => string | undefined;
+/**
+ * Adds getter support for the chart version.
+ */
+export declare abstract class WithVersion extends ChartModelBase {
+    /**
+     * The version of the chart configuration.
+     */
+    get version(): string | undefined;
+}

package/dist/model/radar-chart-model/radar-chart-model.d.ts

@@ -11,7 +11,6 @@ export declare class RadarChartModel extends SerialChartModel {
     protected _config: ChartConfig<typeof ModelTypes.RadarChart, WebChart>;
     /**
      * Default series for the radar chart. Used in resetting the series styling.
-     * @category Protected
      */
     protected defaultSeries: WebChartRadarChartSeries | undefined;
     protected _chartType: "radarSeries";
@@ -20,7 +19,6 @@ export declare class RadarChartModel extends SerialChartModel {
     protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
     /**
      * Initializes the default series for the radar chart. Used in resetting the series styling.
-     * @category Private
      */
     protected initDefaultSeries(): void;
     /**
@@ -29,7 +27,6 @@ export declare class RadarChartModel extends SerialChartModel {
     resetSeriesStyling(): void;
     /**
      * Returns whether the series styling is able to be reset.
-     * @returns {boolean}
      */
     resetAvailable(): boolean;
 }

package/dist/model/scatterplot-model/scatterplot-model.d.ts

@@ -56,20 +56,14 @@ export declare class ScatterplotModel extends ChartModel {
     set additionalTooltipField(fields: string[] | string | undefined);
     /**
      * Generate the proper chart title given the current config.
-     *
-     * @returns {string}
      */
     generateChartTitle(): string;
     /**
      * Generate the proper x-axis title given the current config.
-     *
-     * @returns {string}
      */
     generateXAxisTitle(): string;
     /**
      * Generate the proper y-axis title given the current config.
-     *
-     * @returns {string}
      */
     generateYAxisTitle(): string;
     protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;

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

@@ -93,24 +93,28 @@ export declare const getSizePolicy: (config: ScatterplotConfig) => SizePolicy |
 export declare const setSizePolicy: (sizePolicy: SizePolicy | undefined, config: ScatterplotConfig) => void;
 /**
  * Gets the chart overlays. The scatterplot implements only 1 overlay, **trendLine**.
- * @param {ScatterplotConfig} config The scatterplot config
+ *
+ * @param config - The scatterplot config
  */
 export declare const getSeriesOverlays: (config: ScatterplotConfig) => ScatterplotOverlays | undefined;
 /**
  * Sets the chart overlays. The scatterplot implements only 1 overlay, **trendLine**.
- * @param {ScatterplotOverlays} overlays The overlays
- * @param {ScatterplotConfig} config The scatterplot config
+ *
+ * @param overlays - The overlays
+ * @param config - The scatterplot config
  */
 export declare const setSeriesOverlays: (overlays: ScatterplotOverlays, config: ScatterplotConfig) => void;
 /**
  * Gets the additional tooltip display fields from the config.
- * @param {ScatterplotConfig} config The scatterplot config
+ *
+ * @param config - The scatterplot config
  */
 export declare const getAdditionalTooltipField: (config: ScatterplotConfig) => string[];
 /**
  * Sets the additional tooltip display fields in the config.
- * @param {string | string[]} fields The tooltip display fields
- * @param {ScatterplotConfig} config The scatterplot config
+ *
+ * @param fields - The tooltip display fields
+ * @param config - The scatterplot config
  *
  */
 export declare const setAdditionalTooltipField: (fields: string[] | string | undefined, config: ScatterplotConfig) => void;

package/dist/model/serial-chart-model/serial-chart-model.d.ts

@@ -2,12 +2,11 @@ import { SerialChartTypes } from '../../utils';
 import { ChartModel } from '../chart-model/chart-model';
 import { Color, WebChartDataFilters, WebChartNullCategory, WebChartStackedKinds, WebChartStatisticType } from '../../spec';
 import { SerialChartConfig } from '../interfaces/chart-interfaces';
-import { SerialChartDataSortingKinds } from '../interfaces/common';
+import { HeatChartDataSortingKinds, SerialChartDataSortingKinds } from '../interfaces/common';
 import { ModelWithColorMatch, ModelWithDataLabels, ModelWithLegend, ModelWithTooltips, ModelWithRotation, ModelWithTemporalBinning, ModelWithXGuides, ModelWithYGuides, ModelWithMultiAxes } from '../mixins';
 export declare abstract class SerialChartModel extends ChartModel {
     /**
      * Current chart type.
-     * @category Protected
      */
     protected _chartType: SerialChartTypes;
     /**
@@ -16,22 +15,18 @@ export declare abstract class SerialChartModel extends ChartModel {
     protected _config: SerialChartConfig;
     /**
      * Internal storage of the x-axis field for the chart.
-     * @category Protected
      */
     protected _xAxisField: string;
     /**
      * Internal storage of the aggregation type for the chart.
-     * @category Protected
      */
     protected _aggregationType: WebChartStatisticType;
     /**
      * Internal storage of the split-by field for the chart.
-     * @category Protected
      */
     protected _splitByField: string;
     /**
      * Internal storage of the numeric fields for the chart.
-     * @category Protected
      */
     protected _numericFields: string[];
     /**
@@ -56,35 +51,36 @@ export declare abstract class SerialChartModel extends ChartModel {
     set numericFields(newNumericFields: string[] | string);
     /**
      * Gets whether the series should be assigned to the second value axis.
+     *
      * @param seriesIndex - The index of the series.
-     * @returns {boolean}
      */
     getAssignToSecondValueAxis(seriesIndex: number): boolean;
     /**
      * Sets whether the series should be assigned to the second value axis.
+     *
      * @param assign - The value for the setting.
      * @param seriesIndex - The index of the series.
      */
     setAssignToSecondValueAxis(assign: boolean, seriesIndex: number): void;
     /**
      * Gets the sort order for the bar chart.
-     * @returns {"xAxisAsc" | "xAxisDesc" | "yAxisAsc" | "yAxisDesc" | "customSort"}
      */
-    getSortOrder(): SerialChartDataSortingKinds;
+    getSortOrder(): HeatChartDataSortingKinds | SerialChartDataSortingKinds;
     /**
      * Sets the sort order for the bar chart.
-     * @param {"xAxisAsc" | "xAxisDesc" | "yAxisAsc" | "yAxisDesc"}  newSortOrder The new sort order.
-     * @param {string[]} orderByList The list of category's values to order by.
+     *
+     * @param newSortOrder - The new sort order.
+     * @param orderByList - The list of category's values to order by.
      */
-    setSortOrder(newSortOrder: SerialChartDataSortingKinds, orderByList?: string[]): void;
+    setSortOrder(newSortOrder: HeatChartDataSortingKinds | SerialChartDataSortingKinds, orderByList?: string[]): void;
     /**
      * Gets the list of the category values for the chart.
-     * @returns {string[]}
      */
     getCustomSortValues(): Promise<string[]>;
     /**
      * Sets the data filter for the bar chart.
-     * @param {WebChartDataFilters | undefined} newDataFilter The new data filter.
+     *
+     * @param newDataFilter - The new data filter.
      */
     setDataFilters(newDataFilter: WebChartDataFilters | undefined): Promise<void>;
     /**
@@ -99,86 +95,86 @@ export declare abstract class SerialChartModel extends ChartModel {
     updateSeriesFromLayerFilter(): Promise<void>;
     /**
      * Whether temporal binning is enabled for all series in the config.
-     *
-     * **NOTE** Setting this prop removes any existing temporal binning settings if `value` is set to `false`.
+     * **Note:** Setting this prop removes any existing temporal binning settings if `value` is set to `false`.
      */
     get binTemporalData(): boolean;
     set binTemporalData(value: boolean);
     /**
      * Gets the name of the series based on the series index.
      * If the index is out of bounds, it will return `undefined`.
-     * @param {number} seriesIndex The index of the series.
-     * @returns {string | undefined}
+     *
+     * @param seriesIndex - The index of the series.
      */
     getSeriesName(seriesIndex: number): string | undefined;
     /**
      * Sets name of the series based on the series index.
-     * @param {string} name The name for the series.
-     * @param {number} seriesIndex The index of the series.
+     *
+     * @param name - The name for the series.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesName(name: string, seriesIndex: number): void;
     /**
      * Gets the color of the series based on the series index. If the index is out of bounds, it will return `undefined`.
-     * @param {number} seriesIndex The index of the series.
-     * @returns {Color | undefined}
+     *
+     * @param seriesIndex - The index of the series.
      */
     getSeriesColor(seriesIndex: number): Color | undefined;
     /**
      * Sets the color of the series based on the series index.
-     * @param {Color | undefined} newColor The new color for the series.
-     * @param {number} seriesIndex The index of the series.
+     *
+     * @param newColor - The new color for the series.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesColor(newColor: Color | undefined, seriesIndex: number): void;
     /**
      * Gets the order of the series array by returning an array of series ids.
-     * @returns {string[]}
      */
     getOrderOfSeries(): string[];
     /**
      * Sets the order of the series array by providing an array of series ids.
-     * @param {string[]} newOrder The new order of the series array.
+     *
+     * @param newOrder - The new order of the series array.
      */
     setOrderOfSeries(newOrder: string[]): void;
     /**
      * How the bars/lines should be placed when multiple series are rendered in the same chart, say when "split by" operation is executed on any field or
      * when multiple attributes/fields corresponding to the same set of classes are to be visualized.
      *
-     * Currently this property is only used for bar and line series.
-     *
-     * @default sideBySide
-     *
-     * @returns {WebChartStackedKinds | undefined}
+     * **Note**: Currently this property is only used for bar and line series.
      */
     get stackedType(): WebChartStackedKinds | undefined;
     set stackedType(newStackedType: WebChartStackedKinds | undefined);
     /**
      * Moves a series from one index in the series array to another.
-     * @param {number} fromIndex Index to move the series from.
-     * @param {number} toIndex Index to move the series to.
+     *
+     * @param fromIndex - Index to move the series from.
+     * @param toIndex - Index to move the series to.
      */
     moveSeries(fromIndex: number, toIndex: number): void;
     /**
      * Moves the custom sort values in-place for the order by list in the config.
+     * **Note:** This method should be only used when the sort order is set to `SerialChartDataSortingKinds.customSort`.
      *
-     * NOTE: This method should be only used when the sort order is set to `SerialChartDataSortingKinds.customSort`.
-     * @param {number} fromIndex The index to move the custom sort value from.
-     * @param {number} toIndex The index to move the custom sort value to.
+     * @param fromIndex - The index to move the custom sort value from.
+     * @param toIndex - The index to move the custom sort value to.
      */
     moveCustomSortValuesInOrderByList(fromIndex: number, toIndex: number): void;
     /**
      * The null category configuration of the bar chart.
+     *
+     * @requires the following to be set on the model for the null category to be applied:
+     * - `fetchNULLValues` to be set to `true` on the model.
+     * - `colorMatch` to be set to `false` on the model
      */
     get nullCategory(): WebChartNullCategory | undefined;
     set nullCategory(nullCategory: WebChartNullCategory | undefined);
     protected abstract generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
     /**
      * Sets up the local props based on the current config.
-     * @category Protected
      */
     protected setupLocalProps(): void;
     /**
-     * Resets the config to the default config
-     * @category Protected
+     * Resets the config to the default config.
      */
     protected resetConfig(): void;
     /**
@@ -186,13 +182,11 @@ export declare abstract class SerialChartModel extends ChartModel {
      * We can call the build new series function synchronously when either is true:
      * - there is no split-by field
      * - there are multiple numeric fields
-     * @category Protected
      */
     protected canUseSynchronousSeriesRebuild(): boolean;
     /**
      * Processes the series rebuild.
      * If multiple async setters are called in succession, this function will only rebuild the series once after all setters have been called.
-     * @category Protected
      * @async
      */
     protected processSeriesRebuild(): Promise<void>;