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

package/dist/spec/chart-object-literals.d.ts

@@ -1,4 +1,4 @@
-export declare const WebChartTypes: {
+export const WebChartTypes: {
     readonly Chart: "chart";
     readonly Text: "chartText";
     readonly Overlay: "chartOverlay";
@@ -27,8 +27,10 @@ export declare const WebChartTypes: {
     readonly SizePolicy: "sizeScale";
     readonly CalendarDateParts: "calendarDateParts";
 };
+
 export type WebChartTypes = (typeof WebChartTypes)[keyof typeof WebChartTypes];
-export declare const WebChartStatisticType: {
+
+export const WebChartStatisticType: {
     readonly Count: "count";
     readonly Sum: "sum";
     readonly Minimum: "min";
@@ -43,58 +45,71 @@ export declare const WebChartStatisticType: {
     readonly ConvexHullAggregate: "convex-hull-aggregate";
     readonly NoAggregation: "no_aggregation";
 };
+
 export type WebChartStatisticType = (typeof WebChartStatisticType)[keyof typeof WebChartStatisticType];
-export declare const WebChartDataTransformations: {
+
+export const WebChartDataTransformations: {
     readonly None: "none";
     readonly Log: "logarithmic";
     readonly Sqrt: "squareRoot";
 };
+
 export type WebChartDataTransformations = (typeof WebChartDataTransformations)[keyof typeof WebChartDataTransformations];
-export declare const WebChartColoringPatterns: {
+
+export const WebChartColoringPatterns: {
     readonly Single: "singleColor";
     readonly Match: "colorMatch";
 };
+
 export type WebChartColoringPatterns = (typeof WebChartColoringPatterns)[keyof typeof WebChartColoringPatterns];
-export declare const WebChartLegendPositions: {
+
+export const WebChartLegendPositions: {
     readonly Left: "left";
     readonly Right: "right";
     readonly Top: "top";
     readonly Bottom: "bottom";
 };
+
 export type WebChartLegendPositions = (typeof WebChartLegendPositions)[keyof typeof WebChartLegendPositions];
-export declare const WebChartStackedKinds: {
+
+export const WebChartStackedKinds: {
     readonly Side: "sideBySide";
     readonly Stacked: "stacked";
     readonly Stacked100: "stacked100";
 };
+
 export type WebChartStackedKinds = (typeof WebChartStackedKinds)[keyof typeof WebChartStackedKinds];
-export declare const WebChartBoxPlotMultipleSeriesKinds: {
+
+export const WebChartBoxPlotMultipleSeriesKinds: {
     readonly Side: "sideBySide";
     readonly MeanLines: "meanLines";
 };
+
 export type WebChartBoxPlotMultipleSeriesKinds = (typeof WebChartBoxPlotMultipleSeriesKinds)[keyof typeof WebChartBoxPlotMultipleSeriesKinds];
-export declare const WebChartSortOrderKinds: {
+
+export const WebChartSortOrderKinds: {
     readonly Ascending: "ASC";
     readonly Descending: "DESC";
 };
+
 export type WebChartSortOrderKinds = (typeof WebChartSortOrderKinds)[keyof typeof WebChartSortOrderKinds];
-export declare const StatisticsDefaults: {
+
+export const StatisticsDefaults: {
     readonly statisticType: "count";
     readonly sortingOrder: "ASC";
 };
-/**
- * Represents the different types of smoothing that can be applied to a line chart when the `lineSmoothed` property is set to `true`.
- */
-export declare const WebChartLineSmoothedKinds: {
+
+/** Represents the different types of smoothing that can be applied to a line chart when the `lineSmoothed` property is set to `true`. */
+export const WebChartLineSmoothedKinds: {
     readonly Bezier: "bezier";
     readonly MonotoneX: "monotoneX";
     readonly MonotoneY: "monotoneY";
 };
+
 export type WebChartLineSmoothedKinds = (typeof WebChartLineSmoothedKinds)[keyof typeof WebChartLineSmoothedKinds];
-/**
- * The temporal binning units
- */
-export declare const WebChartTemporalBinningUnits: {
+
+/** The temporal binning units */
+export const WebChartTemporalBinningUnits: {
     readonly Second: "seconds";
     readonly Minute: "minutes";
     readonly Hour: "hours";
@@ -104,11 +119,11 @@ export declare const WebChartTemporalBinningUnits: {
     readonly Quarter: "quarters";
     readonly Year: "years";
 };
+
 export type WebChartTemporalBinningUnits = (typeof WebChartTemporalBinningUnits)[keyof typeof WebChartTemporalBinningUnits];
-/**
- * Represents the units that can be used for calendar-based date parts binning.
- */
-export declare const WebChartCalendarDatePartsUnits: {
+
+/** Represents the units that can be used for calendar-based date parts binning. */
+export const WebChartCalendarDatePartsUnits: {
     readonly DayOfMonth: "dayOfMonth";
     readonly DayOfWeek: "dayOfWeek";
     readonly DayOfYear: "dayOfYear";
@@ -118,171 +133,205 @@ export declare const WebChartCalendarDatePartsUnits: {
     readonly WeekOfYear: "weekOfYear";
     readonly QuarterOfYear: "quarterOfYear";
 };
+
 export type WebChartCalendarDatePartsUnits = (typeof WebChartCalendarDatePartsUnits)[keyof typeof WebChartCalendarDatePartsUnits];
-/**
- * The temporal binning units for the calendar based binning offset
- */
-export declare const WebChartCalendarBinningOffsetUnits: {
+
+/** The temporal binning units for the calendar based binning offset */
+export const WebChartCalendarBinningOffsetUnits: {
     readonly Second: "seconds";
     readonly Minute: "minutes";
     readonly Hour: "hours";
     readonly Day: "days";
 };
+
 export type WebChartCalendarBinningOffsetUnits = (typeof WebChartCalendarBinningOffsetUnits)[keyof typeof WebChartCalendarBinningOffsetUnits];
-/**
- * Represents the different types of heat rule that can be applied to a heat chart.
- */
-export declare const WebChartHeatChartHeatRulesTypes: {
+
+/** Represents the different types of heat rule that can be applied to a heat chart. */
+export const WebChartHeatChartHeatRulesTypes: {
     readonly Gradient: "gradient";
+    readonly Renderer: "renderer";
 };
+
 export type WebChartHeatChartHeatRulesTypes = (typeof WebChartHeatChartHeatRulesTypes)[keyof typeof WebChartHeatChartHeatRulesTypes];
-/**
- * Represents the different types of null policy that can be applied to a chart using the time binning feature.
- */
-export declare const WebChartNullPolicyTypes: {
+
+/** Represents the different types of null policy that can be applied to a chart using the time binning feature. */
+export const WebChartNullPolicyTypes: {
     readonly Null: "null";
     readonly Zero: "zero";
     readonly Interpolate: "interpolate";
 };
+
 export type WebChartNullPolicyTypes = (typeof WebChartNullPolicyTypes)[keyof typeof WebChartNullPolicyTypes];
-/**
- * Represents the different types of time aggregation that can be applied to a chart using the time binning feature.
- */
-export declare const WebChartTimeAggregationTypes: {
+
+/** Represents the different types of time aggregation that can be applied to a chart using the time binning feature. */
+export const WebChartTimeAggregationTypes: {
     readonly Start: "equalIntervalsFromStartTime";
     readonly End: "equalIntervalsFromEndTime";
 };
+
 export type WebChartTimeAggregationTypes = (typeof WebChartTimeAggregationTypes)[keyof typeof WebChartTimeAggregationTypes];
-/**
- * Represents the different types of behaviors that can applied to a chart axis.
- */
-export declare const WebChartLabelBehavior: {
+
+/** Represents the different types of behaviors that can applied to a chart axis. */
+export const WebChartLabelBehavior: {
     readonly Hide: "hide";
     readonly Rotate: "rotate";
     readonly Stagger: "stagger";
     readonly Wrap: "wrap";
 };
+
 export type WebChartLabelBehavior = (typeof WebChartLabelBehavior)[keyof typeof WebChartLabelBehavior];
-export declare const WebChartVersionStatus: {
+
+export const WebChartVersionStatus: {
     readonly Same: "same";
     readonly Newer: "newer";
     readonly Older: "older";
     readonly Unrecognized: "unrecognized";
 };
+
 export type WebChartVersionStatus = (typeof WebChartVersionStatus)[keyof typeof WebChartVersionStatus];
-/**
- * Represents the different types of axes that can be used in a chart.
- */
-export declare const WebChartAxisTypes: {
+
+/** Represents the different types of axes that can be used in a chart. */
+export const WebChartAxisTypes: {
     readonly Value: "value";
     readonly Date: "date";
     readonly Category: "category";
 };
+
 export type WebChartAxisTypes = (typeof WebChartAxisTypes)[keyof typeof WebChartAxisTypes];
-/**
- * Represents the different types of gauge charts.
- */
-export declare const GaugeChartSubTypes: {
+
+/** Represents the different types of gauge charts. */
+export const GaugeChartSubTypes: {
     readonly FeatureGauge: "featureGauge";
     readonly StatisticGauge: "statisticGauge";
 };
+
 export type GaugeChartSubTypes = (typeof GaugeChartSubTypes)[keyof typeof GaugeChartSubTypes];
-/**
- * Represents the types of scales that can be applied to the size policy. Use by bubble charts (scatterplot).
- */
-export declare const SizePolicyScaleTypes: {
+
+/** Represents the types of scales that can be applied to the size policy. Use by bubble charts (scatterplot). */
+export const SizePolicyScaleTypes: {
     readonly Linear: "linear";
     readonly Logarithmic: "logarithmic";
 };
+
 export type SizePolicyScaleTypes = (typeof SizePolicyScaleTypes)[keyof typeof SizePolicyScaleTypes];
-/**
- * Labels orientation for radar chart axes.
- */
-export declare const WebChartRadarChartAxisLabelsOrientation: {
+
+/** Labels orientation for radar chart axes. */
+export const WebChartRadarChartAxisLabelsOrientation: {
     readonly Radial: "radial";
     readonly Circular: "circular";
     readonly Horizontal: "horizontal";
 };
+
 export type WebChartRadarChartAxisLabelsOrientation = (typeof WebChartRadarChartAxisLabelsOrientation)[keyof typeof WebChartRadarChartAxisLabelsOrientation];
-/**
- * The types of order assocated with chart data.
- */
-export declare const WebChartOrderDataByTypes: {
+
+/** The types of order assocated with chart data. */
+export const WebChartOrderDataByTypes: {
     readonly YValue: "arcgis-charts-y-value";
     readonly Mean: "arcgis-charts-mean";
     readonly Median: "arcgis-charts-median";
     readonly Category: "arcgis-charts-category";
+    readonly MultiAxes: "arcgis-charts-multi-axes";
 };
+
 export type WebChartOrderDataByTypes = (typeof WebChartOrderDataByTypes)[keyof typeof WebChartOrderDataByTypes];
+
 /**
- * A data order option that the items are to be ordered either ascending or descending.
- * It can be used for any type of order, like by category, by mean, by median, etc.
+ * A data order option that allows the items to be ordered on both the x- and y-axes;
+ *
+ * For each axis, the order can be either a direction (ascending or descending) for all axis types;
+ * or a predefined list of labels when the axis is categorical.
+ *
+ * @remarks This order option is currently only used in heat charts.
  */
-export interface WebChartDirectionalDataOrder {
-    /**
-     * The type of order, eg by category, by mean, by median, or by y value.
-     */
-    orderType: WebChartOrderDataByTypes;
-    /**
-     * The direction of the order, either ascending or descending.
-     */
-    orderBy: WebChartSortOrderKinds;
-    /**
-     * Indicates whether to order data by the label or the value.
-     *
-     * For example, when a field has domain coded values or supbtypes, setting this property to `false` will order the data by the field value.
-     * Otherwise the domain description, subtypes description, or the alias of the field will be used to sort the data.
-     *
-     * @default true
-     */
-    preferLabel?: boolean;
+export interface WebChartMultiAxesDataOrder {
+  /** The type of order, which is two dimensional. */
+  orderType: "arcgis-charts-multi-axes";
+  /** The direction of the order for the x axis. If the axis is categorical, this can also be a predefined list of labels. */
+  orderByX?: string[] | WebChartSortOrderKinds;
+  /** The direction of the order for the y axis. If the axis is categorical, this can also be a predefined list of labels. */
+  orderByY?: string[] | WebChartSortOrderKinds;
 }
+
 /**
- * A data order option for the items to be ordered by `category` based on a predefined list of labels.
+ * A data order option that allows the items to be ordered either ascending or descending.
+ * This option can be used for the following types of order: by category, by mean, by median, and by y value.
+ *
+ * @remarks This order option is currently not available for Heat charts.
  */
+export interface WebChartDirectionalDataOrder {
+  /** The type of order, eg by category, by mean, by median, or by y value. */
+  orderType: "arcgis-charts-category" | "arcgis-charts-mean" | "arcgis-charts-median" | "arcgis-charts-y-value";
+  /** The direction of the order, either ascending or descending. */
+  orderBy: WebChartSortOrderKinds;
+  /**
+   * Indicates whether to order data by the label or the value.
+   *
+   * For example, when a field has domain coded values or supbtypes, setting this property to `false` will order the data by the field value.
+   * Otherwise the domain description, subtypes description, or the alias of the field will be used to sort the data.
+   *
+   * @default true
+   */
+  preferLabel?: boolean;
+}
+
+/** A data order option that allows the items to be ordered by `category` based on a predefined list of labels. */
 export interface WebChartPredefinedLabelsDataOrder {
-    /**
-     * The type of order, which is by category.
-     */
-    orderType: "arcgis-charts-category";
-    /**
-     * The predefined list of labels to order the data by.
-     *
-     * When the value of the `preferLabel` property is set to `false`, the `orderBy` list should be a list of
-     * coded domain values or field names; otherwise, it should be a list of domain descriptions, subtypes descriptions, or field aliases.
-     *
-     */
-    orderBy: string[];
-    /**
-     * Indicates whether to order data by the label or the value.
-     *
-     * For example, when a field has domain coded values or supbtypes, setting this property to `false` will order the data by the field value.
-     * Otherwise the domain description, subtypes description, or the alias of the field will be used to sort the data.
-     *
-     * When the value is set to `true` or undefined, the `orderBy` property should contain a list of labels like domain descriptions, subtypes descriptions, or field aliases.
-     * When the value is set to `false`, the `orderBy` property should contain a list of coded domain values or field names, in order for the data to be sorted correctly.
-     *
-     *
-     * @default true
-     */
-    preferLabel?: boolean;
+  /** The type of order, which is by category. */
+  orderType: "arcgis-charts-category";
+  /**
+   * The predefined list of labels to order the data by.
+   *
+   * When the value of the `preferLabel` property is set to `false`, the `orderBy` list should be a list of
+   * coded domain values or field names; otherwise, it should be a list of domain descriptions, subtypes descriptions, or field aliases.
+   */
+  orderBy: string[];
+  /**
+   * Indicates whether to order data by the label or the value.
+   *
+   * For example, when a field has domain coded values or supbtypes, setting this property to `false` will order the data by the field value.
+   * Otherwise the domain description, subtypes description, or the alias of the field will be used to sort the data.
+   *
+   * When the value is set to `true` or undefined, the `orderBy` property should contain a list of labels like domain descriptions, subtypes descriptions, or field aliases.
+   * When the value is set to `false`, the `orderBy` property should contain a list of coded domain values or field names, in order for the data to be sorted correctly.
+   *
+   * @default true
+   */
+  preferLabel?: boolean;
 }
-/**
- * Order options for split-by series.
- */
+
+/** Order options for split-by series. */
 export interface WebChartOrderSeriesBy {
-    /**
-     * When the value is set to true, we want to order the split-by series based on the series' names (alias, custom label, or description).
-     *
-     * When the value is set to false, we want to order the split-by series based on the series' split-by values.
-     *
-     * @default true
-     */
-    preferLabel?: boolean;
-    /**
-     * The direction of the order.
-     *
-     * @default WebChartSortOrderKinds.Ascending
-     */
-    orderBy?: WebChartSortOrderKinds;
+  /**
+   * When the value is set to true, we want to order the split-by series based on the series' names (alias, custom label, or description).
+   *
+   * When the value is set to false, we want to order the split-by series based on the series' split-by values.
+   *
+   * @default true
+   */
+  preferLabel?: boolean;
+  /**
+   * The direction of the order.
+   *
+   * @default WebChartSortOrderKinds.Ascending
+   */
+  orderBy?: WebChartSortOrderKinds;
 }
+
+/** Represents the different types of views that can be applied to a heat chart. */
+export const WebChartHeatChartViewTypes: {
+    readonly singleCalendarView: "SingleCalendarView";
+    readonly sequentialCalendarViews: "SequentialCalendarViews";
+};
+
+export type WebChartHeatChartViewTypes = (typeof WebChartHeatChartViewTypes)[keyof typeof WebChartHeatChartViewTypes];
+
+/** Class break types for data classification in charts. */
+export const WebChartClassBreakTypes: {
+    readonly equalInterval: "equal-interval";
+    readonly quantile: "quantile";
+    readonly naturalBreaks: "natural-breaks";
+    readonly manual: "manual";
+};
+
+/** Class break types for data classification in charts. */
+export type WebChartClassBreakTypes = (typeof WebChartClassBreakTypes)[keyof typeof WebChartClassBreakTypes];

package/dist/spec/config-defaults.d.ts

@@ -1,4 +1,7 @@
-export declare const defaultPieFromFieldsName = "arcgis_charts_pie_from_fields_name";
-export declare const defaultPieFromFieldsValue = "arcgis_charts_pie_from_fields_value";
-export declare const defaultBarLineFromFieldsName = "arcgis_charts_bar_line_from_fields_name";
-export declare const defaultBarLineFromFieldsValue = "arcgis_charts_bar_line_from_fields_value";
+export const defaultPieFromFieldsName: "arcgis_charts_pie_from_fields_name";
+
+export const defaultPieFromFieldsValue: "arcgis_charts_pie_from_fields_value";
+
+export const defaultBarLineFromFieldsName: "arcgis_charts_bar_line_from_fields_name";
+
+export const defaultBarLineFromFieldsValue: "arcgis_charts_bar_line_from_fields_value";

package/dist/spec/data-source.d.ts

@@ -1,122 +1,96 @@
-import { default as FeatureLayer } from '@arcgis/core/layers/FeatureLayer';
-import { default as SubtypeSublayer } from '@arcgis/core/layers/support/SubtypeSublayer';
-import { WebChartTemporalBinningUnits } from './chart-object-literals';
-import { Color, IExtent, ISimpleLineSymbol, ISymbol, SimpleFillSymbolStyle, SimpleLineSymbolStyle, SimpleMarkerSymbolStyle } from './rest-js-types';
-/**
- * Supported layer type for ArcGIS charts.
- */
-export type SupportedLayer = FeatureLayer | SubtypeSublayer;
-/**
- * JSON representation of the color object
- */
+import type { WebChartTemporalBinningUnits } from "./chart-object-literals.js";
+import type { Color, IExtent, ISimpleLineSymbol, ISymbol, SimpleFillSymbolStyle, SimpleLineSymbolStyle, SimpleMarkerSymbolStyle } from "./rest-js-types.js";
+
+/** JSON representation of the color object */
 export interface RGBObject {
-    r: number;
-    g: number;
-    b: number;
-    /**
-     * @default 1.0
-     */
-    a?: number;
+  r: number;
+  g: number;
+  b: number;
+  /** @default 1.0 */
+  a?: number;
 }
-export type IRendererSymbol = ISymbol & {
-    style?: SimpleFillSymbolStyle | SimpleLineSymbolStyle | SimpleMarkerSymbolStyle;
-    color: Color;
-    outline?: ISimpleLineSymbol;
-    label?: string;
-    uniqueValue?: string;
+
+export type IRendererSymbol = ISymbol
+  & {
+  style?: SimpleFillSymbolStyle | SimpleLineSymbolStyle | SimpleMarkerSymbolStyle;
+  color: Color;
+  outline?: ISimpleLineSymbol;
+  label?: string;
+  uniqueValue?: string;
 };
-type RGBArray = [number, number, number];
+
 export type WebChartDataItemColor = Color | RGBArray | RGBObject | string;
+
 export type WebChartDataItemValue = Date | IExtent | IRendererSymbol | number[] | string[] | WebChartDataItem[] | WebChartDataItemColor | boolean | number | string | null | undefined;
-/**
- * JSON representation of a typical data item
- */
+
+/** JSON representation of a typical data item */
 export type WebChartDataItem = Record<string, WebChartDataItemValue>;
-/**
- * JSON representation of the processed data for a Box Plot
- */
+
+/** JSON representation of the processed data for a Box Plot */
 export interface WebChartBoxPlotDataItem {
-    dataItems: WebChartDataItem[];
-    outliers?: WebChartDataItem[];
-    meanLines?: WebChartDataItem[];
+  dataItems: WebChartDataItem[];
+  outliers?: WebChartDataItem[];
+  meanLines?: WebChartDataItem[];
 }
-/**
- * JSON representation of the processed data for a Scatter plot trend line
- */
+
+/** JSON representation of the processed data for a Scatter plot trend line */
 export interface ScatterplotTrendLineData {
-    r2?: number;
-    trendLinePoints?: [WebChartDataItem, WebChartDataItem];
+  r2?: number;
+  trendLinePoints?: [WebChartDataItem, WebChartDataItem];
 }
-/**
- * JSON representation of the processed data for a Scatter plot
- */
+
+/** JSON representation of the processed data for a Scatter plot */
 export interface WebChartScatterplotDataItem extends ScatterplotTrendLineData {
-    dataItems: WebChartDataItem[];
-    aggregated?: boolean;
+  dataItems: WebChartDataItem[];
+  aggregated?: boolean;
 }
+
 export interface TimeIntervalInfo {
-    unit?: WebChartTemporalBinningUnits;
-    size?: number;
+  unit?: WebChartTemporalBinningUnits;
+  size?: number;
 }
-/**
- * JSON representation of the generic data structure for bar, line bar-line, gauge and pie chart
- */
+
+/** JSON representation of the generic data structure for bar, line bar-line, gauge and pie chart */
 export interface WebChartGenericDataItem {
-    dataItems: WebChartDataItem[];
-    /**
-     * Time interval information, only for line charts
-     */
-    timeIntervalInfo?: TimeIntervalInfo;
-    /**
-     * Indicates whether the server limit has been reached when fetching data.
-     * Currently applies only to the queries leveraging the /queryBins operation.
-     */
-    serverLimitReached?: boolean;
+  dataItems: WebChartDataItem[];
+  /** Time interval information, only for line charts */
+  timeIntervalInfo?: TimeIntervalInfo;
+  /**
+   * Indicates whether the server limit has been reached when fetching data.
+   * Currently applies only to the queries leveraging the /queryBins operation.
+   */
+  serverLimitReached?: boolean;
 }
-/**
- * JSON representation of a Histogram bin
- */
+
+/** JSON representation of a Histogram bin */
 export interface WebChartBin {
-    count: number;
-    /**
-     * Min value in the bin
-     */
-    minValue: number;
-    /**
-     * Max value in the bin
-     */
-    maxValue: number;
-    /**
-     * Symbol associated with the bin.
-     */
-    symbol?: WebChartDataItem;
-    /**
-     * Whether this is the last bin.
-     */
-    isLastBin?: boolean;
+  count: number;
+  /** Min value in the bin */
+  minValue: number;
+  /** Max value in the bin */
+  maxValue: number;
+  /** Symbol associated with the bin. */
+  symbol?: WebChartDataItem;
+  /** Whether this is the last bin. */
+  isLastBin?: boolean;
 }
-/**
- * JSON representation of the processed data for a Histogram
- */
+
+/** JSON representation of the processed data for a Histogram */
 export interface WebChartHistogramDataItem {
-    mean: number;
-    median: number;
-    stddev: number;
-    max: number;
-    min: number;
-    /**
-     * Sum of the values of all the points
-     */
-    sum?: number;
-    /**
-     * Number of all the points/features in un-binned data (including only non-null entries)
-     */
-    count?: number;
-    /**
-     * Number of null entries in the pool of points
-     */
-    nulls?: number;
-    bins: WebChartBin[];
+  mean: number;
+  median: number;
+  stddev: number;
+  max: number;
+  min: number;
+  /** Sum of the values of all the points */
+  sum?: number;
+  /** Number of all the points/features in un-binned data (including only non-null entries) */
+  count?: number;
+  /** Number of null entries in the pool of points */
+  nulls?: number;
+  bins: WebChartBin[];
 }
+
 export type WebChartDataTypes = WebChartBoxPlotDataItem | WebChartGenericDataItem | WebChartHistogramDataItem | WebChartScatterplotDataItem;
-export {};
+
+export type RGBArray = [number, number, number];