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

package/dist/chart-rendering/next/selection/index.d.ts

@@ -1,32 +0,0 @@
-import { Graphics, SerialChart, Slice, Template } from '@amcharts/amcharts5';
-import { PieSeries } from '@amcharts/amcharts5/percent.js';
-import { XYCursor, ColumnSeries, LineSeries, XYChart } from '@amcharts/amcharts5/xy.js';
-/**
- * Indicates whether a selection has been made by click-and-drag
- * @param cursor The chart's cursor
- */
-declare function isSelectionByRange(cursor?: XYCursor): boolean;
-/**
- * Adds the selection by click feature to a series
- * @param element The element to add the selection to (bullet, column template...)
- * @param series The chart series
- */
-export declare function addSelectionByClick(element: Graphics | Template<Graphics | Slice>, series: ColumnSeries | LineSeries | PieSeries): void;
-/**
- * Adds a listener to the xy chart to handle the selection:
- * - by hit, but only to clear the selection. The selection by hit on a an element (bullet...)
- * The selection by click is handled by the functions initializing the elements (e.g. initializeScatterplotMarkers())
- *
- * @param chart The chart
- */
-export declare function addClearSelection(chart: SerialChart): void;
-/**
- * Adds a listener to the xy chart to handle the selection by range.
- * The selection by click is handled by the functions initializing the elements (e.g. initializeScatterplotMarkers())
- * @param chart The chart
- */
-export declare function addRangeSelectionOnXYChart(chart: XYChart): void;
-export declare const selectionPrivateFunctions: {
-    isSelectionByRange: typeof isSelectionByRange;
-};
-export {};

package/dist/chart-rendering/next/selection/switch/index.d.ts

@@ -1,7 +0,0 @@
-import { SerialChart } from '@amcharts/amcharts5';
-/**
- * Switches selection already done on the chart instance.
- *
- * @param chart The chart
- */
-export declare function switchSelection(chart: SerialChart): Promise<void>;

package/dist/chart-rendering/next/selection/utils/index.d.ts

@@ -1,45 +0,0 @@
-import { Graphics, Slice, Sprite, Template, Series } from '@amcharts/amcharts5';
-import { SelectionTheme } from '../../../../utils';
-import { PointerUpEvent, SelectEndedEvent } from '../../interfaces';
-/**
- * Indicates whether the multi-selection is requested, either because the user is pressing the Ctrl/Cmd key when performing a selection,
- * or because the multi-selection-with-ctrl-key option has been selected.
- * // TODO: to implement to finalize migration from v4:
- * - click on axis label
- *
- * @param selectionEvent The click or range selection event
- */
-export declare function isMultiSelectionOn(selectionEvent: PointerUpEvent | SelectEndedEvent): boolean;
-/**
- * Set the state on the chart element.
- *
- * @param props.element The element of which state is to be toggled.
- * @param props.selected Indicate whether the element is the target of, or part of, a group selection via a hit or range selection event.
- * @param props.multiSelect Indicate whether multiple selection mode is currently on. Default value is true if not provided.
- * @param props.isDateOrCategoryAxis Indicate whether the current x-axis is a date or category axis.  Default value is false if not provided.
- * @param props.backToDefaultState Indicate whether default inactive state should be used. Default value is false if not provided.
- */
-export declare function toggleStateForElement(props: {
-    element?: Sprite;
-    selected: boolean;
-    multiSelect?: boolean;
-    isDateOrCategoryAxis?: boolean;
-    backToDefaultState?: boolean;
-}): boolean;
-/**
- * Indicates whether the elements that are not part of the current selection action (click or range)
- * need to be deselected.
- * It is true when the action mode is 'mono-selection' or 'multi-selection-with-ctrl-key' and the Ctrl/Cmd key is not pressed.
- * False otherwise (new selection is added to the current one).
- *
- * @param selectionEvent The click or range selection event
- * @param series The series instance
- */
-export declare function needToDeselectOtherElements(selectionEvent: PointerUpEvent | SelectEndedEvent, series: Series): boolean;
-/**
- * This function sets the theme applied to the elements (bars, slices...) when they are selected.
- *
- * @param element The element to which the theme is to be applied.
- * @param customSelectionTheme The custom selection theme to be applied.
- */
-export declare function setSelectionTheme(element: Sprite | Template<Graphics | Slice>, customSelectionTheme?: SelectionTheme): void;

package/dist/chart-rendering/next/types/index.d.ts

@@ -1,2 +0,0 @@
-export { Color as AmChartsColor, color as amChartsColorUtil } from '@amcharts/amcharts5';
-export type { Color as EsriColor } from '../../../spec';

package/dist/chart-rendering/next/utils/chart-modal/index.d.ts

@@ -1,100 +0,0 @@
-import { Chart, Root, Modal } from '@amcharts/amcharts5';
-import { WebChart, WebChartDataTypes, WebGaugeChart } from '../../../../spec';
-import { ErrorStrings, ValidationStatus, DataWarningKeywords } from '../../../../utils';
-import { NotifyOptions } from '../../../common/interfaces';
-export declare function initializeChartModal(root: Root): Modal;
-export declare function resetChartModal(chartModal: Modal): void;
-export declare function displayModalMessage(props: {
-    chartModal: Modal;
-    message?: string;
-    title?: string;
-    closable: boolean;
-}): void;
-/**
- * Validates the `WebChart` config and displays the `Errors` and `Warnings` them in the chart popup.
- * Both `Errors` and `Warnings` are non-dismissible.
- *
- * @param props.chartModal The chart's modal
- * @param props.chartConfig The optional chart config
- * @param props.createMessage The optional error and warning to be displayed
- * @param props.status The validation status containing details about why the config is invalid
- * @param props.errorStrings The t9n error strings
- */
-export declare function displayInvalidConfigMessage(props: {
-    chartModal?: Modal;
-    chartConfig?: WebChart | WebGaugeChart;
-    createMessage?: string;
-    status: ValidationStatus;
-    errorStrings: ErrorStrings;
-}): void;
-/**
- * Setting a message for the chart to raise and display, if prefer, when it fails to create the chart due to bad data.
- *
- * @param chart The chart
- * @param chartModal The chart's modal
- * @param chartConfig The chart's config
- * @param invalidType The type of invalid data
- * @param elementCount The number of elements related to the error
- * @param seriesCount The number of series in the chart
- * @param errorStrings The t9n error strings
- */
-export declare function raiseInvalidDataWarning(props: {
-    chart: Chart;
-    chartModal?: Modal;
-    chartConfig?: WebChart;
-    invalidType?: DataWarningKeywords;
-    elementCount?: number;
-    seriesCount?: number;
-    errorStrings: ErrorStrings;
-}): void;
-/**
- * Checks whether the logarithmic scale can be applied to the chart's axes when the option is enabled.
- * If not:
- * - sends an event
- * - opens the chart's modal (when the chart options don't say otherwise) with a default message
- *
- * @param props.chart The chart
- * @param props.chartModal The chart's modal
- * @param props.data The chart's data
- * @param props.errorStrings The t9n error strings
- */
-export declare function raiseLogScaleNotCompatibleWarning(props: {
-    chart: Chart;
-    chartModal?: Modal;
-    data?: WebChartDataTypes;
-    errorStrings: ErrorStrings;
-}): void;
-/**
- * Checks whether the chart's data is empty and if so:
- * - sends an event
- * - opens the chart's modal (when the chart options don't say otherwise) with a default message
- *
- * @param chart The chart
- * @param chartModal The chart's modal
- * @param chartConfig The chart's config
- * @param data The chart's data
- * @param errorStrings The t9n error strings
- */
-export declare function raiseNoDataWarning(props: {
-    chart: Chart;
-    chartModal?: Modal;
-    chartConfig?: WebChart | WebGaugeChart;
-    data?: WebChartDataTypes;
-    errorStrings: ErrorStrings;
-}): void;
-/**
- * Notifies the uses with any message we want to display on the chart modal.
- *
- * @param props.chart The chart
- * @param props.chartModal The chart's modal
- * @param props.message The message to display
- * @param props.heading The title
- * @param props.options NotifyOptions for the modal
- */
-export declare function notify(props: {
-    chart: Chart;
-    chartModal: Modal;
-    message?: string;
-    heading?: string;
-    options?: NotifyOptions;
-}): void;

package/dist/chart-rendering/next/utils/chart-utils/index.d.ts

@@ -1,22 +0,0 @@
-import { Root } from '@amcharts/amcharts5';
-import { DateTimeFormatOptions, NumberFormatOptions } from '../../../../spec';
-import { ExportChartImageOptions } from '../../../common/interfaces';
-/**
- * Formats a number or date
- *
- * @param props.value
- * @param props.valueFormat
- * @param props.iLocale
- * @param props.formatLocale
- */
-export declare function format(props: {
-    root: Root;
-    value: Date | number;
-    valueFormat: DateTimeFormatOptions | NumberFormatOptions;
-    formatLocale?: string;
-}): string;
-/** exports the chart as an image (png | jpg) */
-export declare function exportImage(props: {
-    root: Root;
-    exportOptions: ExportChartImageOptions;
-}): Promise<File>;

package/dist/chart-rendering/next/utils/config-utils/index.d.ts

@@ -1,37 +0,0 @@
-import { SerialChart } from '@amcharts/amcharts5';
-import { WebChart, WebChartBoxPlotDataItem, WebChartDataItem } from '../../../../spec';
-/**
- * Generates a new config with only the series that has data if:
- * - the hideEmptySeries is set to true,
- * - the chart is an instance of XYChart and not a Pie chart.
- * - at least one series has data.
- * When a new config is generated, it is also stored in the chart's storage for later use.
- * The function also stores the number of series in the chart's storage.
- * If all the series in the config are filtered out, the original config will be returned instead.
- *
- * @param props.chart The chart.
- * @param props.hideEmptySeries Indicates if empty series should be hidden from the chart and the legend
- * @param props.config The chart's config
- * @param props.data The data to check against; if not provided, the chart's data will be used
- * @returns An object indicating whether series has been filtered out and the updated config with only the series that has data.
- * If there is no series being filtered out, the original config will be returned.
- */
-export declare function filterOutEmptySeriesFromChartConfig(props: {
-    chart: SerialChart;
-    hideEmptySeries: boolean;
-    config: WebChart;
-    data?: WebChartBoxPlotDataItem | WebChartDataItem[];
-}): {
-    seriesFilteredOut: boolean;
-    updatedConfig: WebChart;
-};
-/**
- * Compares two configs and indicates whether the style of series has changed.
- *
- * **Note**: This function is currently not yet applied to box-plots
- *
- * @param oldConfig - The previous config
- * @param newConfig - The updated config
- * @returns A boolean indicating whether the series style has changed
- */
-export declare function hasSeriesStyleChanged(oldConfig: WebChart, newConfig: WebChart): boolean;

package/dist/chart-rendering/next/utils/index.d.ts

@@ -1,32 +0,0 @@
-import { Sprite } from '@amcharts/amcharts5';
-/**
- * Indicates whether an amCharts element is still available (non null, non undefined, non disposed)
- *
- * @param element
- */
-export declare function isElementValid(element: Sprite): boolean;
-/**
- * Converts a color represented by a string into a RGBa object
- *
- * @param input The color to convert
- */
-export declare function hexColorToRGB(input: string): {
-    r: number;
-    g: number;
-    b: number;
-    a?: number;
-} | undefined;
-/**
- * Determines if an RGBA color is light or dark, considering opacity.
- * @param props.r - Red (0-255)
- * @param props.g - Green (0-255)
- * @param props.b - Blue (0-255)
- * @param props.a - Alpha (0-1)
- * @returns boolean
- */
-export declare function isColorLight(props: {
-    r: number;
-    g: number;
-    b: number;
-    a?: number;
-}): boolean;

package/dist/chart-rendering/next/utils/localization/bg_BG.d.ts

@@ -1,16 +0,0 @@
-declare const _default: {
-    "Zoom Out": string;
-    "From %1 to %2": string;
-    "From %1": string;
-    "To %1": string;
-};
-export default _default;
-/**
- * amCharts 5 locale
- *
- * Locale: bg_BG
- * Language: Bulgarian
- * TODO: add data and time formatters after discussing with amcharts and esri i18n team.
- *
- * Follow instructions in [on this page](https://www.amcharts.com/docs/v5/concepts/locales/creating-translations/) to make corrections or add new translations.
- */

package/dist/chart-rendering/next/utils/localization/index.d.ts

@@ -1,19 +0,0 @@
-import { Root, DateFormatter, NumberFormatter } from '@amcharts/amcharts5';
-import { ILocale } from '@amcharts/amcharts5/.internal/core/util/Language.js';
-import { WebChartTypes } from '../../../../spec';
-import { SupportedLocale } from '@arcgis/toolkit/intl';
-export declare function fetchChartLocaleStrings(locale?: SupportedLocale): Promise<ILocale>;
-/**
- * Generates a number or date formatter based on the chart's locale and the intl options
- *
- * @param props.root The root
- * @param props.type The type of formatter to generate
- * @param props.intlOptions The intl options for the formatter
- * @param props.formatLocale The format locale
- */
-export declare function getFormatter<FormatterType extends DateFormatter | NumberFormatter>(props: {
-    root: Root;
-    type: typeof WebChartTypes.DateAxisFormat | typeof WebChartTypes.NumberAxisFormat;
-    intlOptions?: Intl.NumberFormatOptions;
-    formatLocale?: string;
-}): FormatterType;

package/dist/chart-rendering/next/utils/localization/sk_SK.d.ts

@@ -1,16 +0,0 @@
-declare const _default: {
-    "Zoom Out": string;
-    "From %1 to %2": string;
-    "From %1": string;
-    "To %1": string;
-};
-export default _default;
-/**
- * amCharts 5 locale
- *
- * Locale: sk_SK
- * Language: Slovak
- * TODO: add data and time formatters after discussing with amcharts and esri i18n team.
- *
- * Follow instructions in [on this page](https://www.amcharts.com/docs/v5/concepts/locales/creating-translations//) to make corrections or add new translations.
- */

package/dist/chart-rendering/next/utils/memory-storage/index.d.ts

@@ -1,138 +0,0 @@
-import { StorageType } from './interfaces';
-type AllStorageTypes = StorageType["axis"] | StorageType["chart"] | StorageType["guide"] | StorageType["label"] | StorageType["legend"] | StorageType["marker"] | StorageType["series"];
-type AllStorageKeys = keyof StorageType["axis"] & keyof StorageType["chart"] & keyof StorageType["guide"] & keyof StorageType["label"] & keyof StorageType["legend"] & keyof StorageType["marker"] & keyof StorageType["series"];
-/**
- * Disposes a specific storage. To be used when a chart is disposed for instance
- *
- * @param memoryStorageId
- */
-export declare function deleteStorage(storageKey?: number): void;
-/**
- * Retrieves a legend property from a specific storage.
- * @param storageKey The legend id
- * @param propertyName The property to retrieve
- */
-export declare function getValueFromLegendStorage<T>(storageKey: number, propertyName: AllStorageKeys): T | undefined;
-/**
- * Updates a legend property from a specific storage
- * @param storageKey The legend id
- * @param informationToStore An object containing the properties to update. It will append and replace the existing ones for the given storage key and id.
- */
-export declare function updateLegendStorage(storageKey: number, informationToStore: AllStorageTypes): void;
-/**
- * Updates a specific storage
- *
- * @param storageKey The key to update (chart id, label id...)
- * @param informationToStore An object containing the properties to update. It will append and replace the existing ones for the given storage key and id.
- */
-declare function updateStorage(storageKey: number, informationToStore: AllStorageTypes): void;
-/**
- * Retrieves a property from a specific storage
- *
- * @param storageKey The key to update (chart id, label id...)
- * @param propertyName The property to retrieve
- */
-declare function getValueFromStorage<T>(storageKey: number, propertyName: AllStorageKeys): T | undefined;
-/**
- * Retrieves a cursor property from a specific storage
- *
- * @param storageKey The cursor id
- * @param propertyName The property to retrieve
- */
-export declare function getValueFromCursorStorage<T>(storageKey: number, propertyName: keyof StorageType["cursor"]): T | undefined;
-/**
- * Updates a cursor property from a specific storage
- *
- * @param storageKey The cursor id
- * @param informationToStore An object containing the properties to update. It will append and replace the existing ones for the given storage key and id.
- */
-export declare function updateCursorStorage(storageKey: number, informationToStore: StorageType["cursor"]): void;
-/**
- * Retrieves a chart property from a specific storage.
- *
- * @param storageKey The chart id
- * @param propertyName The property to retrieve
- */
-export declare function getValueFromChartStorage<T>(storageKey: number, propertyName: keyof StorageType["chart"]): T | undefined;
-/**
- * Updates a chart property from a specific storage
- *
- * @param storageKey The chart id
- * @param informationToStore An object containing the properties to update. It will append and replace the existing ones for the given storage key and id.
- */
-export declare function updateChartStorage(storageKey: number, informationToStore: StorageType["chart"]): void;
-/**
- * Retrieves a series property from a specific storage.
- *
- * @param storageKey The series id
- * @param propertyName The property to retrieve
- */
-export declare function getValueFromSeriesStorage<T>(storageKey: number, propertyName: keyof StorageType["series"]): T | undefined;
-/**
- * Updates a series property from a specific storage
- *
- * @param storageKey The series id
- * @param informationToStore An object containing the properties to update. It will append and replace the existing ones for the given storage key and id.
- */
-export declare function updateSeriesStorage(storageKey: number, informationToStore: StorageType["series"]): void;
-/**
- * Retrieves an axis property from a specific storage.
- *
- * @param storageKey The axis id
- * @param propertyName The property to retrieve
- */
-export declare function getValueFromAxisStorage<T>(storageKey: number, propertyName: keyof StorageType["axis"]): T | undefined;
-/**
- * Updates an axis property from a specific storage
- *
- * @param storageKey The axis id
- * @param informationToStore An object containing the properties to update. It will append and replace the existing ones for the given storage key and id.
- */
-export declare function updateAxisStorage(storageKey: number, informationToStore: StorageType["axis"]): void;
-/**
- * Retrieves a marker property from a specific storage.
- *
- * @param storageKey The marker id
- * @param propertyName The property to retrieve
- */
-export declare function getValueFromMarkerStorage<T>(storageKey: number, propertyName: keyof StorageType["marker"]): T | undefined;
-/**
- * Updates a marker property from a specific storage
- *
- * @param storageKey The marker id
- * @param informationToStore An object containing the properties to update. It will append and replace the existing ones for the given storage key and id.
- */
-export declare function updateMarkerStorage(storageKey: number, informationToStore: StorageType["marker"]): void;
-/**
- * Retrieves a label property from a specific storage.
- *
- * @param storageKey The label id
- * @param propertyName The property to retrieve
- */
-export declare function getValueFromLabelStorage<T>(storageKey: number, propertyName: keyof StorageType["label"]): T | undefined;
-/**
- * Updates a label property from a specific storage
- *
- * @param storageKey The label id
- * @param informationToStore An object containing the properties to update. It will append and replace the existing ones for the given storage key and id.
- */
-export declare function updateLabelStorage(storageKey: number, informationToStore: StorageType["label"]): void;
-/**
- * Retrieves a guide property from a specific storage.
- *
- * @param storageKey The guide id
- * @param propertyName The property to retrieve
- */
-export declare function getValueFromGuideStorage<T>(storageKey: number, propertyName: keyof StorageType["guide"]): T | undefined;
-/**
- * Updates a guide property from a specific storage
- *
- * @param storageKey The guide id
- * @param informationToStore An object containing the properties to update. It will append and replace the existing ones for the given storage key and id.
- */
-export declare function updateGuideStorage(storageKey: number, informationToStore: StorageType["guide"]): void;
-export declare const nextUtilsMemoryStoragePrivateFunctions: {
-    updateStorage: typeof updateStorage;
-    getValueFromStorage: typeof getValueFromStorage;
-};
-export {};

package/dist/chart-rendering/next/utils/memory-storage/interfaces.d.ts

@@ -1,39 +0,0 @@
-import { Graphics, IDisposer, Template } from '@amcharts/amcharts5';
-import { WebChartDataTypes, WebChartTextSymbol } from '../../../../spec';
-import { AxisLabelFormatCallback } from '../../../common/interfaces';
-import { CommonStorageType } from '../../../common/memory-storage/interfaces';
-import { MappedTextSymbol } from '../../chart-library-elements/symbols/interfaces';
-export type ZeroGridLineType = {
-    displayZeroLine?: boolean;
-    strokeWidth?: number;
-    visible?: boolean;
-};
-export interface StorageType extends CommonStorageType {
-    legend: CommonStorageType["legend"];
-    cursor: CommonStorageType["cursor"];
-    chart: CommonStorageType["chart"] & {
-        data?: WebChartDataTypes;
-        locale?: string;
-    };
-    series: CommonStorageType["series"] & {
-        bulletTemplate?: Template<Graphics>;
-        isSelectionApplied?: boolean;
-        tooltipCallback?: IDisposer;
-    };
-    axis: CommonStorageType["axis"] & {
-        rotation?: number;
-        labelsSymbol?: MappedTextSymbol;
-        zeroGridLine?: ZeroGridLineType;
-        labelFormatter?: AxisLabelFormatCallback;
-        minGridDistanceCallbackDisposer?: IDisposer;
-    };
-    marker: CommonStorageType["marker"] & {
-        selected?: boolean;
-    };
-    label: CommonStorageType["label"] & {
-        guideLabelConfig?: WebChartTextSymbol;
-    };
-    guide: {
-        name?: string;
-    };
-}

package/dist/chart-rendering/next/utils/misc/index.d.ts

@@ -1,15 +0,0 @@
-import { Series } from '@amcharts/amcharts5';
-import { ListAutoDispose } from '@amcharts/amcharts5/.internal/core/util/List.js';
-import { WebChartSeries } from '../../../../spec/web-chart';
-/**
- * Function swapping the series following the position changes array.
- * Ignores individually the swap request if the indexes are invalid.
- * @param chartSeries The chart series
- * @param oldSeries The old series configuration
- * @param newSeries The new series configuration
- */
-export declare function swapSeries(props: {
-    chartSeries: ListAutoDispose<Series>;
-    oldSeries: WebChartSeries[];
-    newSeries: WebChartSeries[];
-}): void;

package/dist/chart-rendering/next/utils/series/index.d.ts

@@ -1,13 +0,0 @@
-import { Series } from '@amcharts/amcharts5';
-/**
- * Gets x-axis field name. Honored is rotated
- *
- * @param series The series instance
- */
-export declare function getXFieldFromSeriesDataFields(series: Series): string;
-/**
- * Gets y-axis field name. Honored is rotated.
- *
- * @param series The series instance
- */
-export declare function getYFieldFromSeriesDataFields(series: Series): string;

package/dist/chart-rendering/next/utils/states/index.d.ts

@@ -1,9 +0,0 @@
-import { Graphics, Template } from '@amcharts/amcharts5';
-import { MappedFillSymbol } from '../../chart-library-elements/symbols/interfaces';
-/**
- * Updates an element's default state with properties related to fill and outline whenever appropriated.
- *
- * @param element The element containing the state to style
- * @param stylingInfo The styling information
- */
-export declare function updateElementStateFillProperties(element?: Graphics | Template<Graphics>, stylingInfo?: MappedFillSymbol): void;