@arcgis/charts-components 5.0.0-next.11 → 5.0.0-next.13

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

@@ -5,23 +5,17 @@ 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 {number} seriesIndex - The index of the 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.
-     *
      * @default true
      * @returns {boolean}
      */
     isNegativeValuesStackedToBaseline(seriesIndex: number): boolean;
     /**
      * Specify how negative values are treated in stacked series.
-     * @param {boolean} props.stackedToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
-     * @param {number} props.seriesIndex - The index of the 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.
-     *
+     * **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 {boolean} stackNegativeValuesToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
+     * @param {number} seriesIndex - The index of the series.
      */
     setNegativeValuesStackedToBaseline(stackNegativeValuesToBaseline: boolean, seriesIndex: number): void;
 }

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

@@ -74,8 +74,8 @@ export declare abstract class ModelWithLineMarkerStyling extends ChartModel {
     isLineSmoothed(seriesIndex: number): boolean;
     /**
      * Specify whether line segments of the series should be smoothed.
-     * @param {boolean} props.smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
-     * @param {number} props.seriesIndex - The index of the series.
+     * @param {boolean} smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
+     * @param {number} seriesIndex - The index of the series.
      */
     setLineSmoothed(smoothed: boolean, seriesIndex: number): void;
     /**
@@ -86,12 +86,10 @@ export declare abstract class ModelWithLineMarkerStyling extends ChartModel {
      */
     getConnectLines(seriesIndex: number): boolean | undefined;
     /**
-     * Specify the color of the filled area for line chart.
-     * @param {boolean | undefined} props.color - The color of the filled area for line chart.
-     * @param {number} props.seriesIndex - The index of the series.
-     *
-     * NOTE: Can be overridden by the temporal data setting `nullPolicy`.
-     *
+     * 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.
      */
     setConnectLines(connect: boolean | undefined, seriesIndex: number): void;
     /**
@@ -104,8 +102,8 @@ export declare abstract class ModelWithLineMarkerStyling extends ChartModel {
     isAreaVisible(seriesIndex: number): boolean;
     /**
      * Specify whether the line series should show area.
-     * @param {boolean} props.visible - `true` if the line series should show area, `false` otherwise.
-     * @param {number} props.seriesIndex - The index of the series.
+     * @param {boolean} visible - `true` if the line series should show area, `false` otherwise.
+     * @param {number} seriesIndex - The index of the series.
      */
     setAreaVisible(visible: boolean, seriesIndex: number): void;
     /**
@@ -118,23 +116,21 @@ export declare abstract class ModelWithLineMarkerStyling extends ChartModel {
     isMarkerVisible(seriesIndex: number): boolean;
     /**
      * Indicate whether to show or hide the markers/bullets of the line series.
-     * @param {boolean} props.visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
-     * @param {number} props.seriesIndex - The index of the 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.
      */
     setMarkerVisible(visible: boolean, seriesIndex: number): 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.
-     *
-     * NOTE: areaColor will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
-     *
      * @returns {Color | undefined}
      */
     getAreaColor(seriesIndex: number): Color | undefined;
     /**
      * Specify the color of the filled area for line chart.
-     * @param {Color | undefined} props.color - The color of the filled area for line chart.
-     * @param {number} props.seriesIndex - The index of the series.
+     * @param {Color | undefined} color - The color of the filled area for line chart.
+     * @param {number} seriesIndex - The index of the series.
      */
     setAreaColor(color: Color | undefined, seriesIndex: number): void;
 }

package/dist/model/mixins/model-with-multi-axes.d.ts

@@ -103,6 +103,7 @@ export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
     setAxisScrollbar(scrollbar: WebChartAxisScrollBar, axisIndex: number): void;
     /**
      * Gets the specified title text symbol. Contains styling information such as font, color, and symbol style.
+     * @param {number} axisIndex The index of the axis to get the title symbol for
      * @returns {WebChartTextSymbol | undefined}
      */
     getAxisTitleSymbol(axisIndex: number): WebChartTextSymbol | undefined;

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

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

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

@@ -22,9 +22,9 @@ export declare const setMarkerSize: (newSize: number | undefined, seriesIndex: n
 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} props.smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
- * @param {number} props.seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} props.config - The chart configuration.
+ * @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;
@@ -42,9 +42,9 @@ export declare const setLineSmoothed: (props: {
 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} props.visible - `true` if the line series should show area, `false` otherwise.
- * @param {number} props.seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} props.config - The chart configuration.
+ * @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;
@@ -62,9 +62,9 @@ export declare const setAreaVisible: (props: {
 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} props.visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
- * @param {number} props.seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} props.config - The chart configuration.
+ * @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;
@@ -73,21 +73,18 @@ export declare const setMarkerVisible: (props: {
 }) => 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.
- *
- * NOTE: areaColor will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
- *
  * @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.
- * @param {Color | undefined} props.color - The color of the filled area for line chart.
- * @param {number} props.seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} props.config - The chart configuration.
- *
- * NOTE: areaColor will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
+ * **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;
@@ -98,17 +95,15 @@ export declare const setAreaColor: (props: {
  * 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.
- * @param {boolean | undefined} props.connect - Whether to connect the gap in the data
- * @param {number} props.seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} props.config - The chart configuration.
- *
- * NOTE: Can be overridden by the temporal data setting `nullPolicy`.
+ * **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;

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

@@ -51,15 +51,17 @@ export declare class PieChartModel extends ChartModel {
     /**
      * Sets the sort order for the pie chart.
      * @param {PieChartDataSortingKinds} sortOrder The sort order.
+     * @param {string[]} orderByList The list of category values.
      */
     setSortOrder(sortOrder: PieChartDataSortingKinds, orderByList?: string[]): void;
+    /**
+     * List of category's values for custom sort
+     */
     get orderByList(): string[];
     set orderByList(orderByList: string[]);
     /**
      * The pie chart data mode (Category or Fields).
-     *
      * `category` - The chart is using values from the category field to determine each slice.
-     *
      * `fields` - The chart is using aggregated values from the numeric fields to determine each slice.
      */
     get mode(): PieChartDataModes;
@@ -124,6 +126,7 @@ export declare class PieChartModel extends ChartModel {
     protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
     /**
      * Gets the original name of the slice based on the slice index.
+     * @param {number} sliceIndex - The index of the slice.
      * @returns {Date | number | string | null | undefined}
      */
     getOriginalSliceName(sliceIndex: number): Date | number | string | null | undefined;

package/dist/model.js

@@ -4,7 +4,7 @@ import { s as r, t as s, u as n } from "./chunks/type-guards.js";
 import { a as B, e as P, i as S, g as x, b as W, r as v, h as G, l as K, m as D, p as F, j as H, k as O, q as R, n as A, o as E, d as X, f as Y, c as $ } from "./chunks/type-guards.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/5.0/esri/copyright.txt for details.
-v5.0.0-next.11 */
+v5.0.0-next.13 */
 async function c(t) {
   const o = "config" in t ? r(t.config) : t.chartType;
   let a;

package/dist/spec/web-chart.d.ts

@@ -267,7 +267,7 @@ export interface DateTimeFormatOptions {
      */
     type: typeof WebChartTypes.DateAxisFormat;
     /**
-     * Represent the JS native [Intl.DateTimeFormatOptions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormatt), which is based on [CLDR](http://cldr.unicode.org/translation/date-time-1/date-time-patterns) specifications.
+     * Represent the JS native [Intl.DateTimeFormatOptions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat), which is based on [CLDR](http://cldr.unicode.org/translation/date-time-1/date-time-patterns) specifications.
      */
     intlOptions: Intl.DateTimeFormatOptions;
     /**

package/dist/utils/layer/query-parser/index.d.ts

@@ -74,11 +74,19 @@ export declare function mapAttributeBinsQueryForTemporalData(props: {
  * @param props.field The field used by the heat chart
  * @param props.fieldType The field type
  * @param props.unit The unit of the temporal binning
+ * @param props.addIntervalStatement Whether to add the interval statement to shift the date from the data time zone to the output time zone
+ * @param props.outTimeZone The output time zone
+ * @param props.dataTimeZone The data time zone
+ * @param props.runsOnClientQueryEngine Whether the query will be executed on the client query engine (FeatureLayerView) or on the server
  */
 export declare function getCalendarDatePartsParameters(props: {
     field: string;
     fieldType?: RESTFieldType;
     unit?: string;
+    addIntervalStatement: boolean;
+    outTimeZone?: string;
+    dataTimeZone?: string | null;
+    runsOnClientQueryEngine?: boolean;
 }): {
     expression?: string;
     start?: number;

package/dist/utils/layer/utils/index.d.ts

@@ -1,8 +1,8 @@
-import { SupportedLayer, WebChart } from '../../../spec';
 import { default as FeatureLayer } from '@arcgis/core/layers/FeatureLayer';
 import { default as SubtypeGroupLayer } from '@arcgis/core/layers/SubtypeGroupLayer';
 import { default as SubtypeSublayer } from '@arcgis/core/layers/support/SubtypeSublayer';
-import { default as FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView';
+import { default as FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView.js';
+import { SupportedLayer, WebChart } from '../../../spec';
 import { QueryObject } from '../interfaces';
 /**
  * Indicates whether the input object is a feature collection.
@@ -13,7 +13,7 @@ export declare function isFeatureCollectionLayer(queryObject: QueryObject): quer
  * Indicates whether the input object is an instance of `FeatureLayerView`.
  * @param queryObject
  */
-export declare function isFeatureLayerView(queryObject: QueryObject): queryObject is FeatureLayerView;
+export declare function isFeatureLayerView(queryObject: QueryObject | SubtypeGroupLayer): queryObject is FeatureLayerView;
 /**
  * Indicates whether the input object is an instance of `FeatureLayer`.
  * @param queryObject

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/charts-components",
-  "version": "5.0.0-next.11",
+  "version": "5.0.0-next.13",
   "description": "Reusable ArcGIS charting Web Components.",
   "type": "module",
   "main": "dist/index.js",
@@ -28,8 +28,8 @@
   "dependencies": {
     "@amcharts/amcharts4": "^4.10.31",
     "@amcharts/amcharts5": "~5.14.1",
-    "@arcgis/lumina": "5.0.0-next.11",
-    "@arcgis/toolkit": "5.0.0-next.11",
+    "@arcgis/lumina": "5.0.0-next.13",
+    "@arcgis/toolkit": "5.0.0-next.13",
     "ajv": "6.12.6",
     "d3-array": "^3.2.1",
     "d3-shape": "^3.2.0",