@arcgis/charts-components 5.0.0-next.98 → 5.1.0-next.0

package/dist/interfaces.d.ts

@@ -1,52 +1,20 @@
-import { default as FeatureLayer } from '@arcgis/core/layers/FeatureLayer.js';
-import { default as SubtypeSublayer } from '@arcgis/core/layers/support/SubtypeSublayer.js';
-import { EventEmitter } from '@arcgis/lumina';
-import { SupportedLocale } from '@arcgis/toolkit/intl';
-import { Color, WebChartTemporalBinningUnits } from './spec';
-/**
- * Supported layer type for ArcGIS charts.
- */
+import type FeatureLayer from "@arcgis/core/layers/FeatureLayer.js";
+import type SubtypeSublayer from "@arcgis/core/layers/support/SubtypeSublayer.js";
+import type { EventEmitter } from "@arcgis/lumina";
+import type { SupportedLocale } from "@arcgis/toolkit/intl";
+import type { WebChartTemporalBinningUnits } from "./spec/chart-object-literals.js";
+import type { List as List } from "@esri/calcite-components/components/calcite-list";
+
+/** Supported layer type for ArcGIS charts. */
 export type SupportedLayer = FeatureLayer | SubtypeSublayer;
-export declare const Slot: {
-    readonly actionBar: "action-bar";
-    readonly customActionTop: "custom-action-top";
-    readonly customActionBelow: "custom-action-below";
-    readonly expandTooltip: "expand-tooltip";
-};
-export interface ColorListItemProps {
-    textLabel?: string;
-    textDescription?: number;
-    color?: Color;
-    key: string;
-    value: string;
-    selected?: boolean;
-    ref?: (e?: HTMLCalciteListItemElement) => void;
-    colorAction: (e: Event) => void;
-}
+
 export interface IntervalPopoverProps {
-    size: number;
-    unit: WebChartTemporalBinningUnits;
+  size: number;
+  unit: WebChartTemporalBinningUnits;
 }
-export declare const HistogramOverlays: {
-    readonly Mean: "mean";
-    readonly Median: "median";
-    readonly StandardDev: "standardDev";
-    readonly NormalDist: "normalDist";
-};
-export type HistogramOverlays = (typeof HistogramOverlays)[keyof typeof HistogramOverlays];
-export declare const HistogramStatistics: {
-    readonly Mean: "mean";
-    readonly Median: "median";
-    readonly StandardDev: "standardDev";
-    readonly Count: "count";
-    readonly CountExcludingNulls: "countExcludingNulls";
-    readonly Min: "min";
-    readonly Max: "max";
-    readonly Sum: "sum";
-    readonly Nulls: "nulls";
-};
-export type HistogramStatistics = (typeof HistogramStatistics)[keyof typeof HistogramStatistics];
-export declare const ChartAuthoringPages: {
+
+/** @internal */
+export const ChartAuthoringPages: {
     readonly Data: "data";
     readonly Series: "series";
     readonly Slices: "slices";
@@ -55,15 +23,23 @@ export declare const ChartAuthoringPages: {
     readonly Format: "format";
     readonly General: "general";
 };
+
+/** @internal */
 export type ChartAuthoringPages = (typeof ChartAuthoringPages)[keyof typeof ChartAuthoringPages];
-export declare const FormatIcons: {
+
+/** @internal */
+export const FormatIcons: {
     readonly Title: "title";
     readonly Text: "text";
     readonly Label: "label";
     readonly Palette: "palette";
 };
+
+/** @internal */
 export type FormatIcons = (typeof FormatIcons)[keyof typeof FormatIcons];
-export declare const LineChartDataPopoverKinds: {
+
+/** @internal */
+export const LineChartDataPopoverKinds: {
     readonly xAxisField: "xAxisField";
     readonly aggregation: "aggregation";
     readonly numericFields: "numericField";
@@ -71,8 +47,12 @@ export declare const LineChartDataPopoverKinds: {
     readonly interval: "interval";
     readonly intervalAlignment: "intervalAlignment";
 };
+
+/** @internal */
 export type LineChartDataPopoverKinds = (typeof LineChartDataPopoverKinds)[keyof typeof LineChartDataPopoverKinds];
-export declare const BarChartDataPopoverKinds: {
+
+/** @internal */
+export const BarChartDataPopoverKinds: {
     readonly category: "category";
     readonly aggregation: "aggregation";
     readonly numericFields: "numericField";
@@ -81,22 +61,34 @@ export declare const BarChartDataPopoverKinds: {
     readonly interval: "interval";
     readonly intervalAlignment: "intervalAlignment";
 };
+
+/** @internal */
 export type BarChartDataPopoverKinds = (typeof BarChartDataPopoverKinds)[keyof typeof BarChartDataPopoverKinds];
-export declare const PieChartDataPopoverKinds: {
+
+/** @internal */
+export const PieChartDataPopoverKinds: {
     readonly category: "category";
     readonly aggregation: "aggregation";
     readonly numericFields: "numericFields";
     readonly sortOrder: "sortOrder";
 };
+
+/** @internal */
 export type PieChartDataPopoverKinds = (typeof PieChartDataPopoverKinds)[keyof typeof PieChartDataPopoverKinds];
-export declare const HistogramDataPopoverKinds: {
+
+/** @internal */
+export const HistogramDataPopoverKinds: {
     readonly numericFields: "numericField";
     readonly transformation: "transformation";
     readonly fillSymbol: "fillSymbol";
     readonly lineSymbol: "lineSymbol";
 };
+
+/** @internal */
 export type HistogramDataPopoverKinds = (typeof HistogramDataPopoverKinds)[keyof typeof HistogramDataPopoverKinds];
-export declare const ScatterplotDataPopoverKinds: {
+
+/** @internal */
+export const ScatterplotDataPopoverKinds: {
     readonly xAxisField: "xAxis";
     readonly yAxisField: "yAxis";
     readonly sizeVariable: "sizeVariable";
@@ -105,56 +97,93 @@ export declare const ScatterplotDataPopoverKinds: {
     readonly additionalTooltipFields: "additionalTooltipFields";
     readonly none: "none";
 };
+
+/** @internal */
 export type ScatterplotDataPopoverKinds = (typeof ScatterplotDataPopoverKinds)[keyof typeof ScatterplotDataPopoverKinds];
+
+/** @internal */
 export interface NumericFieldsChangeProps {
-    pickListElement: HTMLCalciteListElement | undefined;
-    eventEmitter: EventEmitter<unknown>;
-    contentKind: BarChartDataPopoverKinds | LineChartDataPopoverKinds | PieChartDataPopoverKinds;
+  pickListElement?: List;
+  eventEmitter: EventEmitter<unknown>;
+  contentKind: BarChartDataPopoverKinds | LineChartDataPopoverKinds | PieChartDataPopoverKinds;
 }
-export declare const BoxPlotDataPopoverKinds: {
+
+/** @internal */
+export const BoxPlotDataPopoverKinds: {
     readonly category: "category";
     readonly numericFields: "numericField";
     readonly splitByField: "splitByField";
     readonly sortOrder: "sortOrder";
 };
+
+/** @internal */
 export type BoxPlotDataPopoverKinds = (typeof BoxPlotDataPopoverKinds)[keyof typeof BoxPlotDataPopoverKinds];
-export declare const ScatterplotSymbolSizeTypes: {
+
+/** @internal */
+export const HeatChartDataPopoverKinds: {
+    readonly xAxisField: "xAxisField";
+    readonly aggregation: "aggregation";
+    readonly numericFields: "numericField";
+    readonly calendarType: "calendarType";
+    readonly calendarViewType: "calendarViewType";
+    readonly classBreakMethod: "classBreakMethod";
+    readonly colorScheme: "colorScheme";
+    readonly null: "null";
+};
+
+/** @internal */
+export type HeatChartDataPopoverKinds = (typeof HeatChartDataPopoverKinds)[keyof typeof HeatChartDataPopoverKinds];
+
+/**
+ * Represents the different types of calendar-based temporal binning that can be applied to a chart.
+ *
+ * @internal
+ */
+export const WebChartCalendarTypes: {
+    readonly WeekByDayOfWeekAndHourOfDay: "weekByDayOfWeekAndHourOfDay";
+    readonly YearByMonthAndDayOfMonth: "yearByMonthAndDayOfMonth";
+};
+
+/** @internal */
+export const ScatterplotSymbolSizeTypes: {
     readonly Fixed: "fixed";
     readonly Proportional: "proportional";
 };
+
+/** @internal */
 export type ScatterplotSymbolSizeTypes = (typeof ScatterplotSymbolSizeTypes)[keyof typeof ScatterplotSymbolSizeTypes];
-export declare const ButtonDirections: {
+
+/** @internal */
+export const ButtonDirections: {
     readonly Up: "up";
     readonly Down: "down";
 };
+
+/** @internal */
 export type ButtonDirections = (typeof ButtonDirections)[keyof typeof ButtonDirections];
+
 /**
  * Options for CSV export.
+ *
  * @template T - The type of the data being exported.
  */
 export interface CSVOptions {
-    /**
-     * Explicit list of columns to export.
-     * If not provided, all columns will be exported.
-     */
-    columns?: string[];
-    /**
-     * Field delimiter.
-     */
-    delimiter?: string;
-    /**
-     * Whether to include the header row in the CSV.
-     */
-    includeHeader?: boolean;
-    /**
-     * Whether to quote all fields.
-     */
-    quoteAll?: boolean;
-    /**
-     * Locale used for formatting numbers in the CSV.
-     * This affects how numbers are formatted, such as decimal and thousands separators.
-     * If not provided, the default locale will be used.
-     * "ar", "ar-u-nu-latn", "bs", "bg", "ca", "cs", "da", "de", "el", "en", "en-US", "es", "et", "fi", "fr", "he", "hr", "hu", "id", "it", "ja", "ko", "lt", "lv", "no", "nl", "pl", "pt-BR", "pt-PT", "ro", "ru", "sr", "sl", "sk", "sv", "th", "tr", "uk", "vi", "zh-CN", "zh-HK", "zh-TW"
-     */
-    locale?: SupportedLocale;
-}
+  /**
+   * Explicit list of columns to export.
+   * If not provided, all columns will be exported.
+   */
+  columns?: string[];
+  /** Field delimiter. */
+  delimiter?: string;
+  /** Whether to include the header row in the CSV. */
+  includeHeader?: boolean;
+  /** Whether to quote all fields. */
+  quoteAll?: boolean;
+  /**
+   * Locale used for formatting numbers in the CSV.
+   * This affects how numbers are formatted, such as decimal and thousands separators.
+   * If not provided, the default locale will be used.
+   * "ar", "ar-u-nu-latn", "bs", "bg", "ca", "cs", "da", "de", "el", "en", "en-US", "es", "et", "fi", "fr", "he", "hr", "hu", "id", "it", "ja", "ko", "lt", "lv", "no", "nl", "pl", "pt-BR", "pt-PT", "ro", "ru", "sr", "sl", "sk", "sv", "th", "tr", "uk", "vi", "zh-CN", "zh-HK", "zh-TW"
+   */
+  locale?: SupportedLocale;
+}