@arcgis/charts-components 5.0.0-next.136 → 5.0.0-next.137

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;

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

@@ -1,109 +0,0 @@
-import { default as FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView.js';
-import { SupportedLayer, CSVOptions } from '../../interfaces';
-import { ModelTypes } from '../../model';
-import { IField } from '../../spec';
-import { SupportedLocalesForFormats } from '../localization/interfaces';
-import { ChartConfig } from '../types';
-/**
- * A utility function to compare if a value has changed deeply.
- */
-export declare function hasChangedDeep<T>(value: T, oldValue?: T): boolean;
-/**
- * A utility function to compare if a value has changed deeply or shallowly.
- */
-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 value - The value to format.
- * @param 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.
- * @param locale - The locale to use for number formatting.
- */
-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 - 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 - The layer associated with the chart, used for additional data context.
- * @param props.fieldList - 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 date - The date to check, should be a string or a number.
- */
-export declare const isValidDate: (date: unknown) => date is Date | number | string;
-/**
- * Returns a unique ID.
- *
- * @example
- * 33c2c20e-5a9e-c7be-1b23-b210e6218831
- */
-export declare function generateGUID(): string;

package/dist/utils/data/stats/class-breaks.d.ts

@@ -1,91 +0,0 @@
-import { Color } from '../../../spec';
-import { ClassBreakInfo } from '../../chart-config/utils/class-breaks';
-import { ClassBreaksRendererResult } from '@arcgis/core/smartMapping/renderers/color.js';
-import { ColorRamp } from '@arcgis/core/smartMapping/symbology/types.js';
-/**
- * Generates a color per class break (length = `numberOfClassBreaks`).
- *
- * @param props - Options.
- * @param props.numberOfClassBreaks - Number of colors to generate.
- * @param props.selectedColorRamp - Optional ArcGIS color ramp to sample from (assumed already flipped upstream).
- * @param props.colorRamp - Optional explicit Charts colors. If its length matches `numberOfClassBreaks`, it is used as-is.
- * @returns Charts colors as an array of RGBA tuples.
- *
- * @example
- * ```ts
- * // Prefer the explicit colorRamp when it already matches the break count.
- * generateColorsForClassBreaks({ numberOfClassBreaks: 5, colorRamp: [[...], ...] });
- * ```
- */
-export declare function generateColorsForClassBreaks(props: {
-    numberOfClassBreaks: number;
-    selectedColorRamp?: ColorRamp;
-    colorRamp?: Color[];
-}): Color[];
-/**
- * Builds {@link ClassBreakInfo} entries (label + symbol) from a Smart Mapping renderer result.
- *
- * @param props - Options.
- * @param props.classBreaksRendererResult - ArcGIS Core class breaks renderer output.
- * @param props.numberOfClassBreaks - Number of breaks used to generate colors.
- * @param props.selectedColorRamp - Optional ArcGIS ramp (assumed already flipped upstream).
- * @param props.colorRamp - Optional explicit Charts colors.
- * @returns Array of {@link ClassBreakInfo}; empty if there are no break infos.
- *
- * @note Gotcha: min/max values are normalized for display (`floor(min)`, `ceil(max)`).
- *
- * @example
- * ```ts
- * const infos = extractClassBreakInfos({ classBreaksRendererResult, numberOfClassBreaks: 5 });
- * // infos[0].label might be "≤ 10"
- * ```
- */
-export declare function extractClassBreakInfos(props: {
-    classBreaksRendererResult: ClassBreaksRendererResult;
-    numberOfClassBreaks: number;
-    selectedColorRamp?: ColorRamp;
-    colorRamp?: Color[];
-}): ClassBreakInfo[];
-/**
- * Converts a Charts RGB/RGBA tuple to a CSS hex string.
- *
- * @param rgbaColor - `[r, g, b]` or `[r, g, b, a]` (alpha is ignored).
- * @returns Hex color string in the form `#RRGGBB`.
- *
- * @note Values are clamped to 0–255.
- *
- * @example
- * ```ts
- * convertRgbaToHexString([255, 0, 0, 255]); // → "#ff0000"
- * ```
- */
-export declare function convertRgbaToHexString(rgbaColor: number[] | null | undefined): string;
-export declare const ColorRampCategoriesToTags: {
-    readonly all: readonly ["*"];
-    readonly light: readonly ["light"];
-    readonly dark: readonly ["dark"];
-    readonly redsAndYellows: readonly ["oranges", "reds", "yellows"];
-    readonly greens: readonly ["greens"];
-    readonly blues: readonly ["blues"];
-    readonly purplesAndPinks: readonly ["purples", "pinks"];
-    readonly browns: readonly ["browns"];
-    readonly grays: readonly ["grays"];
-    readonly bright: readonly ["bright"];
-    readonly subdued: readonly ["subdued"];
-    readonly colorblindFriendly: readonly ["colorblind-friendly"];
-};
-export declare const ColorRampCategories: {
-    readonly all: "all";
-    readonly light: "light";
-    readonly dark: "dark";
-    readonly redsAndYellows: "redsAndYellows";
-    readonly greens: "greens";
-    readonly blues: "blues";
-    readonly purplesAndPinks: "purplesAndPinks";
-    readonly browns: "browns";
-    readonly grays: "grays";
-    readonly bright: "bright";
-    readonly subdued: "subdued";
-    readonly colorblindFriendly: "colorblindFriendly";
-};
-export type ColorRampCategories = (typeof ColorRampCategories)[keyof typeof ColorRampCategories];

package/dist/utils/type-guards/chart-types.d.ts

@@ -1,13 +0,0 @@
-import { WebBoxPlot, WebChart, WebHeatChart } from '../../spec';
-/**
- * Determines if the chart config is a heat chart configuration
- * @param chartConfig The chart configuration object.
- * @returns True if the chart config is a heat chart configuration, false otherwise.
- */
-export declare function isHeatChartConfig(chartConfig?: WebChart): chartConfig is WebHeatChart;
-/**
- * Determines if the chart config is a box plot chart configuration
- * @param chartConfig The chart configuration object.
- * @returns True if the chart config is a box plot chart configuration, false otherwise.
- */
-export declare function isBoxPlotChartConfig(chartConfig?: WebChart): chartConfig is WebBoxPlot;