@arcgis/charts-components 5.0.0-next.17 → 5.0.0-next.171

package/dist/utils/chart-config/converter/interfaces.d.ts

@@ -1,136 +0,0 @@
-import { IFeatureLayer, WebChart, WebChartCalendarBinningOffsetUnits, WebChartDataTypes, WebChartNullPolicyTypes, WebChartSeries, WebChartSeriesQuery, WebChartSortOrderKinds, WebChartTemporalSeries, WebChartText, WebChartTimeAggregationTypes } from '../../../spec';
-export type FormerWebChartSubtitle = WebChart & {
-    subTitle?: WebChartText;
-};
-export type FormerWebChartSeriesQuery = WebChartSeriesQuery & {
-    orderByFields?: string[];
-};
-export declare enum FormerWebChartLabelBehavior {
-    NONE = "none",
-    ROTATE = "rotate",
-    STAGGER = "stagger",
-    WRAP = "wrap"
-}
-export type FormerWebChartBoxPlotDataSortTypes = "category" | "mean" | "median";
-export type FormerWebChartDataValueTypes = "label" | "originalValue";
-export type FormerWebChartWithSortLabelsBy = WebChart & {
-    sortLabelsBy?: FormerWebChartDataValueTypes;
-};
-export type FormerWebChartWithSortSeriesBy = WebChart & {
-    sortOptions?: {
-        sortSeriesBy?: {
-            sortType?: FormerWebChartDataValueTypes;
-            sortOrder?: WebChartSortOrderKinds;
-        };
-    };
-};
-export type FormerWebChartWithSortDataBy = WebChart & {
-    sortOptions?: {
-        sortDataBy?: {
-            sortType: FormerWebChartBoxPlotDataSortTypes;
-            sortOrder?: WebChartSortOrderKinds;
-        };
-    };
-};
-export type FormerWebChartWithDataPreferDataLabel = WebChart & {
-    orderOptions?: {
-        data?: {
-            preferDataLabel?: boolean;
-        };
-    };
-};
-export type FormerWebChartWithDataPreferLabel = WebChart & {
-    orderOptions?: {
-        data?: {
-            preferLabel?: boolean;
-        };
-    };
-};
-/**
- * JSON representation of the inline data source
- */
-export interface FormerWebChartInlineDataSource {
-    /**
-     * Represents a unique string identifier for the type of chart data source. It is **inline** for inline data (arrays of POJOs).
-     */
-    type: "inline";
-    /**
-     * Indicates whether the data is already processed and be used right away. If it is `false`, then the data needs to go through some transformation before being assigned to chart/series.
-     */
-    processed: boolean;
-    /**
-     * Structure containing all the data for the chart.
-     */
-    data: WebChartDataTypes;
-}
-/**
- * JSON representation of the feature layer data source
- */
-export interface FormerWebChartLayerDataSource {
-    /**
-     * Represents a unique string identifier for the type of chart data source.
-     */
-    type: "layer";
-    /**
-     * Carries the properties necessary to build a JSAPI Feature Layer in order to fetch the chart data.
-     */
-    layer: IFeatureLayer;
-}
-export interface FormerInlineData<T extends FormerWebChartInlineDataSource["data"]> {
-    /**
-     * Structure containing all the data for the chart. It can be pre-processed (see `WebChartDataTypes`) or not (WebChartDataItem[])
-     */
-    inputData: T;
-    /**
-     * Indicates whether the data is already processed and be used right away. If it is `false`, then the data needs to go through some transformation before being assigned to chart/series.
-     */
-    processed: FormerWebChartInlineDataSource["processed"];
-}
-export type FormerWebChartTemporalSeries = WebChartSeries & WebChartTemporalSeries & {
-    timeIntervalUnits?: "esriTimeUnitsDays" | "esriTimeUnitsHours" | "esriTimeUnitsMinutes" | "esriTimeUnitsMonths" | "esriTimeUnitsSeconds" | "esriTimeUnitsWeeks" | "esriTimeUnitsYears";
-    timeIntervalSize?: number;
-    timeAggregationType?: WebChartTimeAggregationTypes;
-    trimIncompleteTimeInterval?: boolean;
-    nullPolicy?: WebChartNullPolicyTypes;
-};
-export type FormerWebChartTemporalSeries2 = WebChartSeries & {
-    binTemporalData?: boolean;
-    temporalBinning?: {
-        type: "calendarBased";
-        unit?: {
-            Second: "seconds";
-            Minute: "minutes";
-            Hour: "hours";
-            Day: "days";
-            Week: "weeks";
-            Month: "months";
-            Quarter: "quarters";
-            Year: "years";
-        };
-        start?: number;
-        end?: number;
-        offset?: {
-            unit: WebChartCalendarBinningOffsetUnits;
-            size: number;
-        };
-        outTimeZone?: string;
-        trimIncompleteTimeInterval?: boolean;
-        timeAggregationType?: WebChartTimeAggregationTypes;
-        nullPolicy?: WebChartNullPolicyTypes;
-    } | {
-        type: "fixedDateBased";
-        size?: number;
-        trimIncompleteTimeInterval?: boolean;
-        timeAggregationType?: WebChartTimeAggregationTypes;
-        nullPolicy?: WebChartNullPolicyTypes;
-        unit?: {
-            Second: "seconds";
-            Minute: "minutes";
-            Hour: "hours";
-            Day: "days";
-            Week: "weeks";
-            Month: "months";
-            Year: "years";
-        };
-    };
-};

package/dist/utils/components/action-bar-utils.d.ts

@@ -1,33 +0,0 @@
-import { WebChart } from '../../spec';
-import { ArcgisChart } from '../../components/arcgis-chart/customElement.js';
-import { ArcgisChartsActionBar } from '../../components/arcgis-charts-action-bar/customElement.js';
-import { ChartTypes, DefaultChartActions } from '../../utils';
-/**
- * Returns the default actions for a given chart type
- *
- * @param {ChartTypes} chartType The chart type for which to get the default actions
- * @returns {DefaultChartActions[]} The default actions for the given chart type
- */
-export declare function getDefaultChartActions(chartType: ChartTypes | undefined): DefaultChartActions[];
-/**
- * Event handler for action bar slot change.
- *
- * @param e
- * @param layer
- */
-export declare const onActionBarSlotChange: (e: Event, chartComponent: HTMLArcgisChartElement, config?: WebChart) => HTMLArcgisChartsActionBarElement | undefined;
-/**
- * Updates the action bar states based on the properties of the chart component and the config object.
- *
- * @param {HTMLArcgisChartsActionBarElement} props.actionBar - The action bar element to update.
- * @param {HTMLArcgisChartElement} props.chartComponent - The chart component element.
- * @param {WebChart} [props.config] - The configuration object for the chart.
- * @param {boolean} [props.isWarningDisplayed] - Optional flag to indicate if a warning is displayed.
- *
- */
-export declare function updateActionBarStates(props: {
-    actionBar: HTMLArcgisChartsActionBarElement;
-    chartComponent: HTMLArcgisChartElement;
-    config?: WebChart;
-    isWarningDisplayed?: boolean;
-}): void;

package/dist/utils/components/app-utils.d.ts

@@ -1,11 +0,0 @@
-/** Default timers for debouncing. */
-export declare const DebounceTimers: {
-    ModelConfigChange: 5;
-};
-/**
- * Takes a map from event names to handler functions, then adds listeners for each event
- *
- * @param listeningTarget Target on which the event listeners will be added
- * @param events Map of events
- */
-export declare function addEventListenersFromMap(listeningTarget: EventTarget, events: Map<string, (e: CustomEvent) => void>): void;

package/dist/utils/components/chart-ui-utils.d.ts

@@ -1,120 +0,0 @@
-import { RESTSimpleLineSymbolStyle } from '../../spec';
-import { NumericFieldsChangeProps } from '../../interfaces';
-import { FormatKeys } from '../../model';
-export interface RGB {
-    r: number;
-    g: number;
-    b: number;
-}
-export declare const UIDefaults: {
-    readonly DebounceTimer: 400;
-    readonly SliderTimer: 100;
-    readonly PopoverTimer: 60;
-    readonly customSortLimit: 100;
-};
-export declare const DefaultStatNumberFormat: {
-    readonly style: "decimal";
-    readonly minimumFractionDigits: 0;
-    readonly maximumFractionDigits: 3;
-};
-export declare const aggregationList: ("count" | "sum" | "min" | "max" | "avg" | "percentile-continuous" | "no_aggregation")[];
-export declare const pieAggregationList: ("count" | "sum")[];
-export declare function getFormatIcon(formatKey: FormatKeys | undefined): string | undefined;
-/**
- * Validates a value entered in a numeric calcite-input.
- * Controls that the value is not undefined, not empty (invalid) and in between the [min, max] range if provided
- *
- * @param value
- * @param min
- * @param max
- */
-export declare function isCalciteInputValidNumber(value: number | string, min?: number | string, max?: number | string): boolean;
-/**
- * Secures a provided number by returning either the same number, or a default value, or undefined.
- * The actual value is typed as "string" because the calcite-input inputs returns a string value
- * no matter the type of input used (text, number, textarea...).
- *   - If the value is valid (not NaN, finite), the value is returned
- *   - If not and if a valid default value is provided, the default value is returned
- *   - If not, an empty string is returned
- *
- * @param value
- * @param defaultValue
- */
-export declare function sanitizeNumber(value?: number | string | null, defaultValue?: number): string | undefined;
-/**
- * Modifies a calcite-input status
- *
- * @param props
- */
-export declare function modifyCalciteInputStatus(props: {
-    inputElement: HTMLCalciteInputElement;
-    status: string;
-}): void;
-export declare const UIInputStatus: Record<string, "idle" | "invalid" | "valid">;
-/**
- * Formats a number according to the locale and optionally rounds it
- *
- * @param value
- * @param precision
- */
-export declare function formatNumberToLocale(value?: number, formatOptions?: Intl.NumberFormatOptions): string;
-/**
- * Indicates whether the item matches the provided string,
- * or one of the strings in the array of strings.
- *
- * @param item
- * @param selectedContent
- */
-export declare function itemMatchesSelectedContent(item: string, selectedContent?: string[] | string): boolean;
-/**
- * Returns the offset distance based on the provided placement option of a popover;
- * For now, the popover will display either on top of the target element using the 'trailing' placement option,
- * or to the left of the target element using the 'leading' placement option.
- *
- * @param placement
- */
-export declare function getPopoverOffsetDistance(placement: HTMLCalcitePopoverElement["placement"] | undefined): number;
-/**
- * Helper function to sanitize a color with NaNs
- *  - Returns null if color is undefined or contains NaN values
- *  - Returns the color otherwise
- *
- * @param color RGB | undefined
- */
-export declare function sanitizeColor(color: RGB | undefined): RGB | null;
-/**
- * Handler for "keydown" event on numberic input element. Prevents input of "e" character.
- *
- * @param e Input element "keydown" event
- */
-export declare const blockNumericE: (e: KeyboardEvent) => void;
-/**
- * emit numeric field change event
- *
- * @param props.pickListElement
- * @param props.eventEmitter
- * @param props.contentKind
- * @category Public
- */
-export declare const emitNumericFieldsChange: (props: NumericFieldsChangeProps) => void;
-/**
- * Returns the line style type based on the provided line style.
- *
- * @param lineStyle
- */
-export declare function getLineStyleType(lineStyle: RESTSimpleLineSymbolStyle | undefined): string;
-/**
- * Downloads an object as a file using a data URL.
- *
- * @param {string} objectURL - The data URL of the object to download.
- * @param {string} downloadString - The name of the file to download.
- * @category Public
- */
-export declare function downloadFile(objectURL: string, downloadString: string): void;
-/**
- * Destroys tooltip by removing it from the DOM
- *
- * @param tooltip The tooltip to be destroyed
- * @returns Null return for caller to easily reset tooltip object to null
- */
-export declare function destroyTooltip(tooltip: HTMLCalciteTooltipElement | null | undefined): null;

package/dist/utils/components/config-update.d.ts

@@ -1,54 +0,0 @@
-import { default as FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView';
-import { ChartOptions } from '../../chart-rendering/common/interfaces';
-import { ArcgisChart } from '../../components/arcgis-chart/customElement.js';
-import { SupportedLayer, WebChart, WebChartLegendPositions } from '../../spec';
-import { QueryObject } from '../../utils';
-/**
- * Updates the legend position for a given WebChart config.
- * Returns the updated config.
- *
- * @param newLegendPosition
- * @param config
- */
-export declare function updateLegendPosition(newLegendPosition: WebChartLegendPositions, config?: WebChart): WebChart | undefined;
-/**
- * Updates the legend visibility for a given WebChart config.
- * Returns the updated config.
- *
- * @param visible
- * @param config
- */
-export declare function updateLegendVisibility(visible: boolean, config?: WebChart): WebChart | undefined;
-/**
- * Resets the axes bounds.
- * Returns the updated config.
- *
- * @param config
- */
-export declare function resetAxesBounds(config?: WebChart): WebChart | undefined;
-/**
- * Checks whether the provided data source is valid. The conditions are:
- * - iLayer is defined
- * - OR Layer / FeatureLayerView instance is provided
- *
- * @param config The component's config
- * @param layer The component's layer
- */
-export declare function isValidDataSource(config?: WebChart, layer?: FeatureLayerView | SupportedLayer): boolean;
-/**
- * Will add missing series to the chart config if:
- * - the config uses a split-by field
- * - adding missing series was requested (through the `updateSplitBySeries` property)
- * - unique values for the given split-by field don't have a series associated
- *
- * @param props.component The chart component
- * @param props.options The runtime options
- * @param props.config The chart config
- * @param props.queryObject The query object (layer or feature layer view)
- */
-export declare function addMissingSplitBySeries(props: {
-    component: ArcgisChart;
-    config: WebChart | undefined;
-    options: ChartOptions;
-    queryObject: QueryObject;
-}): Promise<void>;

package/dist/utils/components/message-utils.d.ts

@@ -1,9 +0,0 @@
-import { WebChartTypes } from '../../spec';
-import { ErrorStrings } from '../localization/interfaces';
-/**
- * Pulls the proper placeholder according to the chart type
- *
- * @param chartType The chart type to get the placeholder for
- * @category Private
- */
-export declare function getChartPlaceholder(chartType?: WebChartTypes, errorStrings?: ErrorStrings): string | undefined;

package/dist/utils/components/type-guards.d.ts

@@ -1,2 +0,0 @@
-import { ArcgisChart } from '../../components/arcgis-chart/customElement.js';
-export declare function isChartElement(element: HTMLElement | null | undefined): element is HTMLArcgisChartElement;

package/dist/utils/components/watch-handlers.d.ts

@@ -1,37 +0,0 @@
-import { ArcgisChart } from '../../components/arcgis-chart/customElement.js';
-/**
- * Adds a listener on the feature layer, so every time the definition expression (filter) is modified we update
- * the chart.
- *
- * @param component The chart component
- */
-export declare function addLayerFilterListener(component: ArcgisChart): Promise<IHandle | undefined>;
-/**
- * Adds a listener on the feature layer, so every time the renderer is modified we update the chart.
- *
- * @param component The chart component
- */
-export declare function addLayerRendererListener(component: ArcgisChart): Promise<IHandle | undefined>;
-/**
- * Adds a listener on the feature layer view, so every time the view's extent is modified we update
- * the chart.
- *
- * @param props.component The chart component
- */
-export declare function addExtentChangeListener(component: ArcgisChart): Promise<IHandle[] | undefined>;
-/**
- * Adds a listener on the view's time extent, so every time extent is modified we update the chart.
- * @param component The chart component
- */
-export declare function addViewTimeExtentListener(component: ArcgisChart): Promise<IHandle | undefined>;
-/**
- * Adds a listener on the feature layer, so every time the fields are modified we update the chart.
- *
- * @param component The chart component
- */
-export declare function addLayerFieldsListener(component: ArcgisChart): Promise<IHandle | undefined>;
-/**
- * Adds a listener on the layer's view; so every time the selection data is modified, we update the chart.
- * @param component The chart component
- */
-export declare function addSelectionsChangeInViewListener(component: ArcgisChart): Promise<IHandle | undefined>;

package/dist/utils/components/web-component-utils.d.ts

@@ -1,99 +0,0 @@
-import { CSVOptions } from '../../interfaces';
-import { ModelTypes } from '../../model';
-import { IField, SupportedLayer } from '../../spec';
-import { ChartConfig } from '../types';
-import { default as FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView.js';
-import { SupportedLocalesForFormats } from '../localization/interfaces';
-/**
- * A utility function to compare if a value has changed deeply.
- * @param value
- * @param oldValue
- */
-export declare function hasChangedDeep<T>(value: T, oldValue?: T): boolean;
-/**
- * A utility function to compare if a value has changed deeply or shallowly.
- * @param value
- * @param oldValue
- */
-export declare function hasChangedDeepOrShallow<T>(value: T, oldValue?: T): boolean;
-/**
- * Formats a cell value for CSV output.
- * This function handles quoting and escaping of special characters.
- * @param {unknown} value - The value to format.
- * @param {boolean} [quoteAll] - Whether to quote all values.
- *                               If `true`, all values will be quoted.
- *                               If `false` or `undefined`, only values that contain special characters will be quoted.
- */
-export declare const formatCell: (props: {
-    value: unknown;
-    quoteAll?: boolean;
-    locale?: SupportedLocalesForFormats;
-}) => string;
-/**
- * Converts an array of objects to a CSV string.
- * @param data - The data to convert.
- * @param options - Options for CSV conversion.
- * @returns The CSV string.
- */
-export declare function arrayToCSV<T extends Record<string, unknown>>(data: T[], options?: CSVOptions): string;
-/**
- * Transform the raw data to a format that is suitable for exporting to CSV.
- * This function is used to transform the data before it is passed to the CSV export function.
- * @param props.config - [Optional] The chart configuration that defines the chart type and data transformation.
- * @param props.rawData - The raw data to be transformed, which is an array of objects.
- * @param props.layer - [Optional] The layer associated with the chart, used for additional data context.
- * @param props.fieldList - [Optional] The list of fields in the layer, used to determine field types and names.
- */
-export declare function transformChartData<T extends Record<string, unknown>>(props: {
-    config?: ChartConfig;
-    rawData: T[];
-    layer?: FeatureLayerView | SupportedLayer;
-    fieldList?: IField[];
-}): T[];
-/**
- * Transform the histogram data to a format that is suitable for exporting to CSV.
- * @param config - The histogram model or config
- * @param rows - The raw data to be transformed.
- */
-export declare function transformHistogramData<T extends Record<string, unknown>>(config: ChartConfig<typeof ModelTypes.Histogram>, rows: T[]): T[];
-/**
- * Processes the chart data for bar and line charts.
- * @param props.config - The chart model.
- * @param props.rows - The raw data to be transformed.
- * @param props.layer - The layer associated with the chart.
- */
-export declare function transformBarLineChartData<T extends Record<string, unknown>>(props: {
-    config: ChartConfig<typeof ModelTypes.BarChart | typeof ModelTypes.ComboBarLineChart | typeof ModelTypes.LineChart>;
-    rows: T[];
-    layer?: FeatureLayerView | SupportedLayer;
-    fieldList?: IField[];
-}): T[];
-/**
- * Transform the pie chart data to a format that is suitable for exporting to CSV.
- * @param props.model - The pie chart model.
- * @param props.rows - The raw data to be transformed.
- * @param props.layer - The layer associated with the chart.
- */
-export declare function transformPieChartData<T extends Record<string, unknown>>(props: {
-    config: ChartConfig<typeof ModelTypes.PieChart>;
-    rows: T[];
-    layer?: FeatureLayerView | SupportedLayer;
-    fieldList?: IField[];
-}): T[];
-/**
- * Transform the box plot data to a format that is suitable for exporting to CSV.
- * @param model - The box plot model.
- * @param rows - The raw data to be transformed.
- * @returns The transformed data.
- */
-export declare function transformBoxPlotData<T extends Record<string, unknown>>(props: {
-    config: ChartConfig<typeof ModelTypes.BoxPlot>;
-    rows: T[];
-    layer?: FeatureLayerView | SupportedLayer;
-    fieldList?: IField[];
-}): T[];
-/**
- * Check if the provided date is valid.
- * @param {unknown} date - The date to check, should be a string or a number.
- */
-export declare const isValidDate: (date: unknown) => date is Date | number | string;