@arcgis/charts-components 5.0.0-next.99 → 5.0.0

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 props.chartType - The chart type for which to get the default actions
- * @returns 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 props.actionBar - The action bar element to update.
- * @param props.chartComponent - The chart component element.
- * @param props.config - The configuration object for the chart.
- * @param 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,112 +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): HTMLCalciteIconElement["icon"] | 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.
- */
-export declare const emitNumericFieldsChange: (props: NumericFieldsChangeProps) => void;
-/**
- * Returns the line style type based on the provided line style.
- */
-export declare function getLineStyleType(lineStyle: RESTSimpleLineSymbolStyle | undefined): string;
-/**
- * Downloads an object as a file using a data URL.
- *
- * @param objectURL - The data URL of the object to download.
- * @param downloadString - The name of the file to download.
- */
-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,67 +0,0 @@
-import { default as Graphic } from '@arcgis/core/Graphic';
-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 { WebBoxPlot, WebChart, WebChartLegendPositions } from '../../spec';
-import { QueryObject } from '../../utils';
-import { SupportedLayer } from '../../interfaces';
-/**
- * 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;
-/**
- * Updates the chart rotation for a given WebChart config.
- * Returns the updated config.
- * @param newRotation new rotation
- * @param config the chart config
- */
-export declare function updateRotation<T extends WebBoxPlot | WebChart>(newRotation: boolean, config?: T): T | 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;
-/**
- * Alters the providing config to prepare it for rendering:
- * - add the iLayer if missing
- * - convert it to the latest version
- * @param props.configToAlter The config to alter
- * @param props.layer The component's layer
- */
-export declare function prepareConfigForRendering(props: {
-    creation: boolean;
-    configToAlter: WebChart | undefined;
-    chartContainer?: HTMLElement;
-    queryObject: QueryObject;
-    options: ChartOptions;
-    previousConfig?: WebChart | undefined;
-    updateSplitBySeries: ArcgisChart["updateSplitBySeries"];
-    addMissingSeries: boolean;
-    layer: ArcgisChart["layer"];
-}): Promise<{
-    alteredConfig: ArcgisChart["config"];
-    preFetchedQueryResponse?: Graphic[];
-}>;

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

@@ -1,36 +0,0 @@
-import { ChartOptions } from '../../chart-rendering/common/interfaces';
-import { ArcgisChart } from '../../components/arcgis-chart/customElement.js';
-import { IField, WebChart } from '../../spec';
-import { DataUpdateDetails } from '../data/interfaces';
-import { SelectionData } from '../misc/interfaces';
-/**
- * Indicates whether a data update is needed based on the changed properties.
- * Checks for:
- * - specific properties that require a data update when changed,
- * - change of layer type (FeatureLayer to FeatureLayerView or vice-versa),
- * - changes in the config that require a data update.
- * @param props.config The current chart config
- * @param props.previousConfig The previous chart config
- * @param props.dataUpdateNeededProps The list of properties that require a data update when changed
- * @param props.updatedProps A map of the properties that have been updated with their old and new values
- * @param props.filterBySelection The current filterBySelection value
- * @param props.previousSelectionOIDs The previous selection OIDs
- * @param props.chartData The current chart data
- * @param props.options The current chart options
- * @param props.fieldList The list of fields in the layer or feature layer view
- * @returns
- */
-export declare function isDataUpdateNeeded(props: {
-    config: WebChart | undefined;
-    previousConfig: WebChart | undefined;
-    dataUpdateNeededProps: ArcgisChart["dataUpdateNeededProps"];
-    updatedProps: ArcgisChart["updatedProps"];
-    filterBySelection: ArcgisChart["filterBySelection"];
-    previousSelectionOIDs: SelectionData["selectionOIDs"];
-    chartData: ArcgisChart["chartData"];
-    options: ChartOptions;
-    fieldList: IField[];
-}): {
-    dataUpdateNeeded: boolean;
-    dataUpdateDetails: DataUpdateDetails | undefined;
-};

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

@@ -1,8 +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
- */
-export declare function getChartPlaceholder(chartType?: WebChartTypes, errorStrings?: ErrorStrings): string | undefined;

package/dist/utils/components/themes.d.ts

@@ -1,133 +0,0 @@
-import { ChartOptions } from '../../chart-rendering/common/interfaces';
-import { EsriColor } from '../../chart-rendering/common/types';
-import { ArcgisChart } from '../../components/arcgis-chart/customElement.js';
-import { Color, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartHistogramSeries, WebChartLineChartSeries, WebChartOverlay, WebChartPieChartSlice, WebChartRadarChartSeries, WebChartScatterplotSeries } from '../../spec';
-/**
- * Interface representing the list of colors a theme can provide.
- */
-export interface ChartThemeColors {
-    backgroundColor?: EsriColor;
-    textColor?: EsriColor;
-    lineColor?: EsriColor;
-    secondLineColor?: EsriColor;
-}
-/**
- * Indicates whether the Calcite dark mode is enabled on the DOM.
- * @param chartElement The chart element
- */
-export declare function isCalciteDarkModeEnabled(chartElement: HTMLElement): boolean;
-/**
- * Retrieves the Calcite dark theme colors from the css variables.
- * @param chartElement The chart element
- */
-declare function getCalciteDarkThemeColors(chartElement: Element): ChartThemeColors;
-/**
- * Applies the theme colors to the axes.
- * @param config The config to alter
- * @param themeColors The theme colors to apply
- */
-declare function applyThemeColorsToAxes(config: ArcgisChart["config"], themeColors: ChartThemeColors): void;
-/**
- * Applies the theme colors to the background.
- * @param config The config to alter
- * @param themeColors The theme colors to apply
- */
-declare function applyThemeColorsToBackground(config: ArcgisChart["config"], themeColors: ChartThemeColors): void;
-/**
- * Applies the theme colors to the title, footer and subtitle.
- * @param config The config to alter
- * @param themeColors The theme colors to apply
- */
-declare function applyThemeColorsToTitleFooterSubtitle(config: ArcgisChart["config"], themeColors: ChartThemeColors): void;
-/**
- * Updates the overlay symbol color (if the overlay is created and visible).
- * @param overlayColor The color to set
- * @param overlay The overlay to update
- */
-declare function updateOverlaySymbolColor(overlayColor: Color, overlay?: WebChartOverlay): void;
-/**
- * Updates the marker symbol color.
- * @param props.configElementWithFillSymbol The config element with marker symbol to update
- * @param props.markerColor The marker color to set
- * @param props.lineColor The line color to set (optional)
- */
-declare function updateMarkerSymbolColor(props: {
-    configElementWithFillSymbol: WebChartLineChartSeries | WebChartRadarChartSeries | WebChartScatterplotSeries;
-    markerColor: Color;
-    lineColor?: Color;
-}): void;
-/**
- * Updates the fill symbol color.
- * @param props.configElementWithFillSymbol The config element with fill symbol to update
- * @param props.fillColor The fill color to set
- * @param props.lineColor The line color to set (optional)
- */
-declare function updateFillSymbolColor(props: {
-    configElementWithFillSymbol: WebChartBarChartSeries | WebChartBoxPlotSeries | WebChartHistogramSeries | WebChartPieChartSlice;
-    fillColor: Color;
-    lineColor?: Color;
-}): void;
-/**
- * Applies the theme colors to the series.
- * @param config The config to alter
- * @param themeColors The theme colors to apply
- */
-declare function applyThemeColorsToSeries(config: ArcgisChart["config"], themeColors: ChartThemeColors): void;
-/**
- * Applies the theme colors to pie chart specific properties.
- * @param config The config to alter
- * @param themeColors The theme colors to apply
- */
-declare function applyThemeColorsToPieChartSeries(config: ArcgisChart["config"], themeColors: ChartThemeColors): void;
-/**
- * Applies the theme colors to the legend.
- * @param config The config to alter
- * @param themeColors The theme colors to apply
- */
-declare function applyThemeColorsToLegend(config: ArcgisChart["config"], themeColors: ChartThemeColors): void;
-/**
- * Applies the theme colors to gauge specific properties.
- * @param config The config to alter
- * @param themeColors The theme colors to apply
- */
-declare function applyThemeColorsToGauge(config: ArcgisChart["config"], themeColors: ChartThemeColors): void;
-/**
- * Applies the theme colors to heat chart specific properties.
- * @param config The config to alter
- * @param themeColors The theme colors to apply
- */
-declare function applyThemeColorsToHeatChart(config: ArcgisChart["config"], themeColors: ChartThemeColors): void;
-/**
- * Applies the theme to the loader colors in the chart options.
- * @param props.options The chart options
- * @param props.calciteThemeApplied The currently applied calcite theme
- * @param props.config The chart config
- * @returns A modified copy of the chart options
- */
-export declare function applyThemeToLoaderColors(props: {
-    options: ChartOptions;
-    calciteThemeApplied: ArcgisChart["calciteThemeApplied"];
-    config: ArcgisChart["config"];
-}): ChartOptions;
-/**
- * Apply a theme colors to the chart config.
- * The only theme supported currently is the Calcite dark mode.
- * @param chartElement The chart element
- * @param config The chart config
- */
-export declare function applyThemeColors(chartElement: HTMLArcgisChartElement, config: ArcgisChart["config"]): ArcgisChart["config"];
-export declare const commonThemesPrivateFunctions: {
-    applyThemeColorsToAxes: typeof applyThemeColorsToAxes;
-    applyThemeColorsToBackground: typeof applyThemeColorsToBackground;
-    applyThemeColorsToTitleFooterSubtitle: typeof applyThemeColorsToTitleFooterSubtitle;
-    applyThemeColorsToSeries: typeof applyThemeColorsToSeries;
-    applyThemeColorsToPieChartSeries: typeof applyThemeColorsToPieChartSeries;
-    applyThemeColorsToLegend: typeof applyThemeColorsToLegend;
-    applyThemeColorsToGauge: typeof applyThemeColorsToGauge;
-    applyThemeColorsToHeatChart: typeof applyThemeColorsToHeatChart;
-    getCalciteDarkThemeColors: typeof getCalciteDarkThemeColors;
-    updateOverlaySymbolColor: typeof updateOverlaySymbolColor;
-    updateFillSymbolColor: typeof updateFillSymbolColor;
-    updateMarkerSymbolColor: typeof updateMarkerSymbolColor;
-};
-export {};

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 watch handler 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 watchLayerFilter(component: ArcgisChart): IHandle | undefined;
-/**
- * Adds a watch handler on the feature layer, so every time the renderer is modified we update the chart.
- *
- * @param component The chart component
- */
-export declare function watchLayerRenderer(component: ArcgisChart): IHandle | undefined;
-/**
- * Adds a watch handler 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 watchExtentChange(component: ArcgisChart): Promise<IHandle[] | undefined>;
-/**
- * Adds a watch handler on the view's time extent, so every time extent is modified we update the chart.
- * @param component The chart component
- */
-export declare function watchViewTimeExtent(component: ArcgisChart): IHandle | undefined;
-/**
- * Adds a watch handler on the feature layer, so every time the fields are modified we update the chart.
- *
- * @param component The chart component
- */
-export declare function watchLayerFields(component: ArcgisChart): IHandle | undefined;
-/**
- * Adds a watch handler 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 watchSelectionsChangeInView(component: ArcgisChart): IHandle | undefined;