@arcgis/charts-components 4.34.0-next.10 → 4.34.0-next.100

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

@@ -2,8 +2,8 @@ import { Graphics, Root, Series, Sprite, Template, Tooltip } from '@amcharts/amc
 import { PieSeries } from '@amcharts/amcharts5/percent.js';
 import { RadarLineSeries } from '@amcharts/amcharts5/radar.js';
 import { XYSeries, ColumnSeries, LineSeries } from '@amcharts/amcharts5/xy.js';
-import { ChartTypes } from '../../../../../utils';
 import { DateTimeFormatOptions, NumberFormatOptions, WebChartAxis, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartDataItemValue, WebChartLineChartSeries, WebChartRadarChartSeries } from '@arcgis/charts-spec';
+import { ChartTypes } from '../../../../../utils';
 import { BarAndLineChartTooltipProps } from '../interfaces';
 /**
  * Adding an extra padding on the tooltip's label to avoid its scrollbar to show up.
@@ -35,15 +35,10 @@ export declare function initializeLineAndRadarChartTooltip(element: Template<Gra
 export declare function initializeSeriesTooltip(series: PieSeries | XYSeries): Tooltip;
 /**
  * Initializes the tooltip associated to the markers on a series
- * @param root The root of the buttlet
- * @param series The series on what the bullet is assoicated with
+ * @param root The root of the bullet
+ * @param series The series on what the bullet is associated with
  */
 export declare function initializeBulletTooltip(root: Root, series: PieSeries | XYSeries): Tooltip;
-/**
- * Adds padding and background opacity to tooltip
- * @param tooltip The tooltip
- */
-export declare function setTooltipStyle(tooltip?: Tooltip): void;
 /**
  * A callback to check if tooltip needs to be reversed
  *

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

@@ -35,7 +35,7 @@ export declare function showElement(element: DataItem<IAxisDataItem> | Graphics
  * @param parent The parent container to search in.
  * @param useChildId Optional flag that tells the method to use the childId or search for it (note: used for dual axis charts)
  */
-export declare function findContainerChild<T extends Container | Label>(props: {
+export declare function findContainerChild<T extends Container | Graphics | Label>(props: {
     childId: string;
     parent: Container;
     useChildId?: boolean;
@@ -47,3 +47,11 @@ export declare function findContainerChild<T extends Container | Label>(props: {
  * @param parentUID The parent container id.
  */
 export declare function getUniqueElementID(elementId: string, parentUID: number): string;
+/**
+ * With amCharts v5, there is no layout validated method or knowning when the chart is ready
+ * see: https://www.amcharts.com/docs/v5/getting-started/root-element/#chart-ready-event
+ * For now, we do similar to amCharts an wait 100ms to do anything with elements positions
+ * "Our code waits until there's an idle moment of at least 100ms, before "deciding" the chart is fully functional and initial animations are played out."
+ * We return the timeout in case we need to clear it for "frameended"
+ */
+export declare function runAfterChartIsReady<T>(block: () => T, delay?: number): NodeJS.Timeout;

package/dist/chart-rendering/next/chart-library-elements/utils/interfaces.d.ts

@@ -7,3 +7,5 @@ export declare const footerLabelId = "arcgis_charts_footer";
 export declare const legendContainerId = "arcgis_charts_legend_container";
 export declare const legendTitleId = "arcgis_charts_legend_title";
 export declare const axisTitleId = "arcgis_charts_axis_title_id";
+export declare const loaderContainerId = "arcgis_charts_loader_container";
+export declare const spinnerId = "arcgis_charts_loader_spinner";

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

@@ -14,6 +14,7 @@ interface SpecificChartDefaults {
         histogramNormalDistribution: string;
     };
     chartPadding: number;
+    legendPadding: number;
     axisLabelSpacing: {
         verticalAxisLabelSidePadding: number;
         horizontalAxisLabelPaddingTop: number;

package/dist/chart-rendering/next/interfaces.d.ts

@@ -2,7 +2,7 @@ import { Container, Graphics, ISpritePointerEvent } from '@amcharts/amcharts5';
 import { IPointerEvent } from '@amcharts/amcharts5/.internal/core/render/backend/Renderer.js';
 import { RadarChart } from '@amcharts/amcharts5/radar.js';
 import { XYChart, XYCursor } from '@amcharts/amcharts5/xy.js';
-import { CommonStrings, ErrorStrings, QueryObject } from '../../utils';
+import { ErrorStrings, QueryObject, UtilsStrings } from '../../utils';
 import { TimeIntervalInfo, WebChart, WebChartDataTypes, WebGaugeChart } from '@arcgis/charts-spec';
 import { AxisLabelFormatCallback, GuideTooltipFormatCallback } from '../common/interfaces';
 export declare const amChartsV5License = "AM5C241025748";
@@ -54,7 +54,7 @@ export interface UpdateAxesCommonProps<ChartType extends RadarChart | XYChart, C
     data?: WebChartDataTypes;
     queryObject: QueryObject;
     xAxisLabelFormatter?: AxisLabelFormatCallback;
-    commonStrings: CommonStrings;
+    utilsStrings: UtilsStrings;
     errorStrings: ErrorStrings;
 }
 export interface UpdateAxesProps extends UpdateAxesCommonProps<XYChart, WebChart> {

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

@@ -1,8 +1,20 @@
 import { SerialChart } from '@amcharts/amcharts5';
-import { WebChart, WebChartDataTypes, WebGaugeChart } from '@arcgis/charts-spec';
+import { WebChart, WebChartDataTypes, WebGaugeChart, WebChartTypes } from '@arcgis/charts-spec';
 import { ErrorStrings, QueryObject, SelectionSource } from '../../../../utils';
 import { ChartOptions } from '../../../common/interfaces';
 import { ApplySelectionOnSeriesProps } from './interfaces';
+/**
+ * Checks whether a selection has been applied to all the series from a chart
+ *
+ * @param props.chart The chart
+ * @param props.chartType The chart type
+ * @param props.showMean Whether the mean lines are shown on the box plot
+ */
+declare function whetherSelectionAppliedToAllTheSeries(props: {
+    chart: SerialChart;
+    chartType?: WebChartTypes;
+    showMean?: boolean;
+}): boolean;
 /**
  * Apply a selection on a specific series
  *
@@ -36,3 +48,7 @@ export declare function applySelectionOnChart(props: {
  * @param selectionSource The source of the selection
  */
 export declare function finalizeSelection(chart: SerialChart, selectionSource: SelectionSource): Promise<void>;
+export declare const nextSelectionApplyPrivateFunctions: {
+    whetherSelectionAppliedToAllTheSeries: typeof whetherSelectionAppliedToAllTheSeries;
+};
+export {};

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

@@ -1,6 +1,11 @@
 import { Graphics, SerialChart, Slice, Template } from '@amcharts/amcharts5';
 import { PieSeries } from '@amcharts/amcharts5/percent.js';
-import { ColumnSeries, LineSeries } from '@amcharts/amcharts5/xy.js';
+import { XYCursor, ColumnSeries, LineSeries } 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...)
@@ -13,3 +18,7 @@ export declare function addSelectionByClick(element: Graphics | Template<Graphic
  * @param chart The chart
  */
 export declare function addSelectionOnChart(chart: SerialChart): void;
+export declare const selectionPrivateFunctions: {
+    isSelectionByRange: typeof isSelectionByRange;
+};
+export {};

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

@@ -1,6 +1,6 @@
 import { Chart, Root, Modal } from '@amcharts/amcharts5';
-import { ErrorStrings, ValidationStatus, DataWarningKeywords } from '../../../../utils';
 import { WebChart, WebChartDataTypes, WebGaugeChart } from '@arcgis/charts-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;
@@ -28,7 +28,7 @@ export declare function displayInvalidConfigMessage(props: {
     errorStrings: ErrorStrings;
 }): Promise<void>;
 /**
- * Setting a message for the chart to display when it fails to create the chart due to bad data.
+ * 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
@@ -36,7 +36,6 @@ export declare function displayInvalidConfigMessage(props: {
  * @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 openModal Whether to open the modal or not
  * @param errorStrings The t9n error strings
  */
 export declare function raiseInvalidDataWarning(props: {
@@ -46,7 +45,6 @@ export declare function raiseInvalidDataWarning(props: {
     invalidType?: DataWarningKeywords;
     elementCount?: number;
     seriesCount?: number;
-    openModal?: boolean;
     errorStrings: ErrorStrings;
 }): Promise<void>;
 /**

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

@@ -1,7 +1,8 @@
 import { Root, DateFormatter, NumberFormatter } from '@amcharts/amcharts5';
 import { ILocale } from '@amcharts/amcharts5/.internal/core/util/Language.js';
 import { WebChartTypes } from '@arcgis/charts-spec';
-export declare function fetchChartLocaleStrings(locale?: string): Promise<ILocale>;
+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
  *

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

@@ -1,10 +1,38 @@
 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
  *
@@ -103,3 +131,8 @@ export declare function getValueFromGuideStorage<T>(storageKey: number, property
  * @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,4 +1,4 @@
-import { Graphics, Template } from '@amcharts/amcharts5';
+import { Graphics, IDisposer, Template } from '@amcharts/amcharts5';
 import { WebChartDataTypes, WebChartTextSymbol } from '@arcgis/charts-spec';
 import { AxisLabelFormatCallback } from '../../../common/interfaces';
 import { CommonStorageType } from '../../../common/memory-storage/interfaces';
@@ -9,6 +9,7 @@ export type ZeroGridLineType = {
     visible?: boolean;
 };
 export interface StorageType extends CommonStorageType {
+    legend: CommonStorageType["legend"];
     cursor: CommonStorageType["cursor"];
     chart: CommonStorageType["chart"] & {
         data?: WebChartDataTypes;
@@ -17,12 +18,14 @@ export interface StorageType extends CommonStorageType {
     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;

package/dist/chart-rendering/stable/chart-library-elements/axes/gauge/index.d.ts

@@ -1,7 +1,99 @@
-import { GaugeChart } from '@amcharts/amcharts4/charts.js';
-import { CommonStrings, ErrorStrings, QueryObject } from '../../../../../utils';
-import { WebChartAxis, WebChartDataItem, WebGaugeChart } from '@arcgis/charts-spec';
+import { ILocale } from '@amcharts/amcharts4/.internal/core/utils/Language.js';
+import { Axis, AxisRendererCircular, ClockHand, GaugeChart, ValueAxis } from '@amcharts/amcharts4/charts.js';
+import { ErrorStrings, QueryObject, UtilsStrings } from '../../../../../utils';
+import { NumberFormatOptions, WebChartAxis, WebChartDataItem, WebChartGaugeAxis, WebChartNeedle, WebChartText, WebChartTextSymbol, WebGaugeChart } from '@arcgis/charts-spec';
 import { AxisLabelFormatCallback, GaugeInnerLabelFormatCallback } from '../../../../common/interfaces';
+declare function initializeAxisNeedle(chart: GaugeChart): ClockHand;
+/**
+ * Retrieves the value to display on the gauge. It will use either the one provided by the data, or the
+ * one already displayed.
+ */
+declare function getGaugeValue(props: {
+    chart: GaugeChart;
+    x?: string;
+    data?: WebChartDataItem[];
+    valueFormat: NumberFormatOptions;
+    minimum?: number | null;
+    maximum?: number | null;
+}): number | null | undefined;
+declare function updateAxisNeedle(props: {
+    chart: GaugeChart;
+    needle?: WebChartNeedle;
+    gaugeValue?: number | null;
+}): void;
+declare function initializeAxisInnerLabel(chart: GaugeChart): void;
+declare function updateAxisInnerLabel(props: {
+    chart: GaugeChart;
+    innerLabelConfig?: WebChartText;
+    valueFormat: NumberFormatOptions;
+    gaugeInnerLabelFormatter?: GaugeInnerLabelFormatCallback;
+    gaugeValue?: number | null;
+}): void;
+/**
+ * Creates ticks (with and without a label) based on the input parameters.
+ * This function also removes existing ones before creating new ones,
+ * and slightly adjusts the value of the last tick, if needed.
+ *
+ * @param props.axis The axis of which the ticks and labels are to be created
+ * @param props.min The min value for the first tick
+ * @param props.max The max value for the last tick
+ * @param props.labelsIncrement The label increment
+ * @param props.numberOfIntervals The number of intervals (space between 2 axis tick labels)
+ * @param props.valueFormat The number format of the axis
+ */
+declare function createGaugeTicksAndLabels(props: {
+    axis: ValueAxis<AxisRendererCircular>;
+    min: number;
+    max: number;
+    labelsIncrement: number;
+    numberOfIntervals: number;
+    valueFormat: NumberFormatOptions;
+}): void;
+declare function updateGaugeAxisLabels(props: {
+    chart: GaugeChart;
+    axis: Axis<AxisRendererCircular>;
+    onlyShowFirstAndLastLabels: boolean;
+    valueFormat: NumberFormatOptions;
+    axisLabelConfigContent?: WebChartText;
+    axisValueFormatter?: AxisLabelFormatCallback;
+}): void;
+declare function updateGaugeTicks(axis: Axis<AxisRendererCircular>, axisConfig?: WebChartGaugeAxis): void;
+/**
+ * Updates the axis labels' visibility.
+ *
+ * Note: the visibility is based on two properties from the axis config:
+ * - labels' `visible`
+ * - `onlyShowFirstAndLastLabels`
+ *
+ * @param axis the axis
+ * @param axisConfig the axis config
+ */
+declare function updateLabelsVisibility(axis: Axis<AxisRendererCircular>, axisConfig: WebChartGaugeAxis): void;
+/**
+ * Handles the "first and last labels" feature. If the option is enabled, we add guides at the chart's extremities and
+ * set labels on them to display the axis min and max.
+ *
+ * @param axisConfig
+ */
+declare function initializeFirstAndLastLabels(axisConfig: WebChartGaugeAxis): void;
+/**
+ * Adjusts the first and last labels position. They are currently created as guide labels, so we access them through
+ * the axis guides, to set a dx and dy adapter on them.
+ *
+ * Note: this function needs to be called after `updateAxis()` as we need the guides to be created on the axis first.
+ *
+ * @param axis
+ */
+declare function adjustFirstAndLastLabelsPosition(axis: Axis<AxisRendererCircular>): void;
+/** Apply the axis labels styling and the desired format to the first and last labels. */
+declare function updateFirstAndLastLabels(props: {
+    chart: GaugeChart;
+    axis: Axis<AxisRendererCircular>;
+    onlyShowFirstAndLastLabels: boolean;
+    valueFormat: NumberFormatOptions;
+    gaugeLabelConfigContent?: WebChartText;
+    axisValueFormatter?: AxisLabelFormatCallback;
+}): void;
 /**
  * Initializes the gauge axis
  *
@@ -9,6 +101,22 @@ import { AxisLabelFormatCallback, GaugeInnerLabelFormatCallback } from '../../..
  * @param valueFormat The axis value format
  */
 export declare function initializeGaugeAxis(chart: GaugeChart, valueFormat: WebChartAxis["valueFormat"]): void;
+declare function getInnerLabelHTMLValue(props: {
+    valueFormat: NumberFormatOptions;
+    iLocale: ILocale;
+    formatLocale?: string;
+    gaugeValue?: number | null;
+    innerLabelConfigContent?: WebChartTextSymbol;
+    gaugeInnerLabelFormatter?: GaugeInnerLabelFormatCallback;
+}): string;
+declare function getGaugeLabelHTMLValue(props: {
+    valueFormat: NumberFormatOptions;
+    iLocale: ILocale;
+    formatLocale?: string;
+    itemLabelValue?: number | null;
+    gaugeLabelConfigContent?: WebChartTextSymbol;
+    axisValueFormatter?: AxisLabelFormatCallback;
+}): string;
 /**
  * Updates a gauge axis based on the configuration.
  * The data is used to update the needle position and inner label value.
@@ -29,6 +137,23 @@ export declare function updateGaugeAxis(props: {
     queryObject?: QueryObject;
     axisValueFormatter?: AxisLabelFormatCallback;
     gaugeInnerLabelFormatter?: GaugeInnerLabelFormatCallback;
-    commonStrings: CommonStrings;
+    utilsStrings: UtilsStrings;
     errorStrings: ErrorStrings;
 }): Promise<void>;
+export declare const axesGaugePrivateFunctions: {
+    initializeFirstAndLastLabels: typeof initializeFirstAndLastLabels;
+    getGaugeLabelHTMLValue: typeof getGaugeLabelHTMLValue;
+    updateFirstAndLastLabels: typeof updateFirstAndLastLabels;
+    adjustFirstAndLastLabelsPosition: typeof adjustFirstAndLastLabelsPosition;
+    initializeAxisNeedle: typeof initializeAxisNeedle;
+    getGaugeValue: typeof getGaugeValue;
+    updateAxisNeedle: typeof updateAxisNeedle;
+    initializeAxisInnerLabel: typeof initializeAxisInnerLabel;
+    updateAxisInnerLabel: typeof updateAxisInnerLabel;
+    getInnerLabelHTMLValue: typeof getInnerLabelHTMLValue;
+    createGaugeTicksAndLabels: typeof createGaugeTicksAndLabels;
+    updateGaugeTicks: typeof updateGaugeTicks;
+    updateGaugeAxisLabels: typeof updateGaugeAxisLabels;
+    updateLabelsVisibility: typeof updateLabelsVisibility;
+};
+export {};

package/dist/chart-rendering/stable/chart-library-elements/axes/histogram/index.d.ts

@@ -1,4 +1,11 @@
+import { AxisDataItem } from '@amcharts/amcharts4/charts.js';
 import { InitializeHistogramAxesProps, UpdateHistogramAxesProps } from './interfaces';
+/**
+ * Finds the width from the longest label
+ *
+ * @param axisTicks Array of ticks with labels
+ */
+declare function getLongestLabelWidth(axisTicks: AxisDataItem[]): number;
 export declare function initializeHistogramAxes(props: InitializeHistogramAxesProps): void;
 /**
  * Function to update the horizontal and vertical axes of the histogram
@@ -10,3 +17,7 @@ export declare function initializeHistogramAxes(props: InitializeHistogramAxesPr
  * @param props
  */
 export declare function updateHistogramAxes(props: UpdateHistogramAxesProps): Promise<void>;
+export declare const axesHistogramPrivateFunctions: {
+    getLongestLabelWidth: typeof getLongestLabelWidth;
+};
+export {};

package/dist/chart-rendering/stable/chart-library-elements/axes/histogram/interfaces.d.ts

@@ -1,5 +1,5 @@
 import { XYChart } from '@amcharts/amcharts4/charts.js';
-import { CommonStrings, ErrorStrings } from '../../../../../utils';
+import { ErrorStrings, UtilsStrings } from '../../../../../utils';
 import { WebChart, WebChartBin } from '@arcgis/charts-spec';
 import { AxisLabelFormatCallback, GuideTooltipFormatCallback } from '../../../../common/interfaces';
 export interface UpdateHistogramAxesProps {
@@ -9,7 +9,7 @@ export interface UpdateHistogramAxesProps {
     guideTooltipFormatter?: GuideTooltipFormatCallback;
     xAxisLabelFormatter?: AxisLabelFormatCallback;
     yAxisLabelFormatter?: AxisLabelFormatCallback;
-    commonStrings: CommonStrings;
+    utilsStrings: UtilsStrings;
     errorStrings: ErrorStrings;
 }
 export interface InitializeHistogramAxesProps {

package/dist/chart-rendering/stable/chart-library-elements/axes/interfaces.d.ts

@@ -1,5 +1,5 @@
 import { XYChart } from '@amcharts/amcharts4/charts.js';
-import { CommonStrings, ErrorStrings } from '../../../../utils';
+import { ErrorStrings, UtilsStrings } from '../../../../utils';
 import { TimeIntervalInfo, WebChart, WebChartTypes } from '@arcgis/charts-spec';
 import { AxisLabelFormatCallback, GuideTooltipFormatCallback } from '../../../common/interfaces';
 export interface UpdateBarAndLineChartProps {
@@ -15,7 +15,7 @@ export interface UpdateBarAndLineChartProps {
     xAxisLabelFormatter?: AxisLabelFormatCallback;
     yAxisLabelFormatter?: AxisLabelFormatCallback;
     secondaryYAxisLabelFormatter?: AxisLabelFormatCallback;
-    commonStrings: CommonStrings;
+    utilsStrings: UtilsStrings;
     errorStrings: ErrorStrings;
 }
 export interface InitializeBarAndLineChartAxesProps {

package/dist/chart-rendering/stable/chart-library-elements/axes/scatter-plot/index.d.ts

@@ -1,5 +1,5 @@
 import { XYChart } from '@amcharts/amcharts4/charts.js';
-import { CommonStrings, ErrorStrings } from '../../../../../utils';
+import { ErrorStrings, UtilsStrings } from '../../../../../utils';
 import { WebChart } from '@arcgis/charts-spec';
 import { AxisLabelFormatCallback, GuideTooltipFormatCallback } from '../../../../common/interfaces';
 export declare function initializeScatterplotAxes(chart: XYChart, axesConfig: WebChart["axes"]): void;
@@ -10,6 +10,6 @@ export declare function updateScatterplotAxes(props: {
     guideTooltipFormatter?: GuideTooltipFormatCallback;
     xAxisLabelFormatter?: AxisLabelFormatCallback;
     yAxisLabelFormatter?: AxisLabelFormatCallback;
-    commonStrings: CommonStrings;
+    utilsStrings: UtilsStrings;
     errorStrings: ErrorStrings;
 }): Promise<void>;

package/dist/chart-rendering/stable/chart-library-elements/axes/utils/axis-format/index.d.ts

@@ -1,7 +1,7 @@
-import { Axis, PieChart, CategoryAxis, ValueAxis, XYChart } from '@amcharts/amcharts4/charts.js';
+import { Axis, PieChart, CategoryAxis, DateAxis, ValueAxis, XYChart } from '@amcharts/amcharts4/charts.js';
 import { DataItem } from '@amcharts/amcharts4/core.js';
 import { ErrorStrings } from '../../../../../../utils';
-import { WebChartAxis, WebChartTextSymbol, WebChartTypes } from '@arcgis/charts-spec';
+import { DateTimeFormatOptions, WebChartAxis, WebChartTextSymbol, WebChartTypes } from '@arcgis/charts-spec';
 import { AxisLabelFormatCallback } from '../../../../../common/interfaces';
 /**
  * Returns true if the input chart is a XYChart and uses a date axis
@@ -47,6 +47,19 @@ export declare function categoryAxisFormatterCallback(props: {
  * @param axis The axis on which to assign set the label formatter
  */
 export declare function initializeAxisFormatter(axis: Axis): void;
+/**
+ * Updates an adapter on a date axis labels that formats them according to either the config
+ * or a custom formatter passed when the chart is created or updated.
+ *
+ * @param props.axis is an instance of DateAxis
+ * @param props.formatOptions contains INTL.DateTimeFormat options info for formatting date-time
+ * @param props.axisValueFormatter custom label formatter
+ */
+declare function updateDateAxisFormatter(props: {
+    axis: DateAxis;
+    formatOptions: DateTimeFormatOptions;
+    dateAxisFormatter?: AxisLabelFormatCallback;
+}): void;
 /**
  * Updates the formatter used by the axis to render the labels.
  *
@@ -69,3 +82,7 @@ export declare function updateAxisFormat(props: {
     axisValueFormatter?: AxisLabelFormatCallback;
     errorStrings: ErrorStrings;
 }): Promise<void>;
+export declare const utilsAxisformatPrivateFunctions: {
+    updateDateAxisFormatter: typeof updateDateAxisFormatter;
+};
+export {};

package/dist/chart-rendering/stable/chart-library-elements/axes/utils/axis-renderer/index.d.ts

@@ -1,7 +1,8 @@
 import { Axis, AxisRenderer, GaugeChart, XYSeries, XYChart } from '@amcharts/amcharts4/charts.js';
 import { List } from '@amcharts/amcharts4/core.js';
-import { CommonStrings, ErrorStrings } from '../../../../../../utils';
+import { ErrorStrings, UtilsStrings } from '../../../../../../utils';
 import { TimeIntervalInfo, WebChart, WebChartAxis, WebChartLabelBehavior, WebChartStackedKinds, WebChartTypes } from '@arcgis/charts-spec';
+import { getAxisSeriesIds } from '../../../../../common/axes';
 import { AxisLabelFormatCallback, GuideTooltipFormatCallback } from '../../../../../common/interfaces';
 /**
  * Resets the chart's axes zoom level to display the chart in full extent.
@@ -56,6 +57,59 @@ export declare function initializeXYChartAxes(props: {
  * @param isSecondValueAxis Whether the axis is the second value axis (in dual axis mode)
  */
 export declare function whetherLogScaleIsDataCompatible(axis: Axis, isSecondValueAxis?: boolean): boolean;
+/**
+ * Activating the `logarithmic` property of the axis.
+ * Activated only on a value or date axis and according to the config property.
+ *
+ * @param props.axis The axis
+ * @param props.isLogarithmic Whether the axis should use a logarithmic scale
+ * @param props.isSecondValueAxis Whether the axis is the second value axis (in dual axis mode)
+ */
+declare function updateAxisLogarithmic(props: {
+    axis: Axis;
+    isLogarithmic?: boolean;
+    isSecondValueAxis?: boolean;
+}): void;
+/**
+ * Indicates whether the `strictMinMax` option should be applied to the axis.
+ * Returns true only if:
+ *   - the axis is a value axis
+ *   - the axis config logarithmic scale is off, or is on with at least minimum or maximum value specified
+ *   - the axis config buffer is not requested
+ *
+ * @param axis The axis
+ * @param axisConfig The axis config
+ * @returns
+ */
+declare function shouldApplyStrictMinMax(axis: Axis, axisConfig?: WebChartAxis): boolean;
+/**
+ * Activating the `strictMinMax` property of the axis.
+ * `strictMinMax` will remove any buffer around the data's extent, so the top/bottom of the highest/lowest bar or point will
+ * determine the axis max/min
+ * Activated when the axis is ValueAxis, when the logarithmic option is off (or on with at least the minimum or maximum value specified) and when the buffer option is true.
+ *
+ * @param axis The axis to apply the strictMinMax to
+ * @param axisConfig The axis config
+ */
+declare function updateAxisStrictMinMax(axis: Axis, axisConfig?: WebChartAxis): boolean;
+/**
+ * Calculates the minimum value to the nearest and lowest power of 10 for an axis when the axis is logarithmic
+ * For example,
+ * - if min = 5, we set the new min to 1
+ * - if min = 12, we set the new min to 10
+ * - if min = 55, we set the new min to 10
+ * - if min = 9999, we set the new min to 1,000
+ * - if min = 12345, we set the new min to 10,000
+ * - if min = 0.05, we set the new min to 0.01
+ * - if min = 0.0005, we set the new min to 0.0001
+ * The point is to force the axis to render nice rounded values, going 10, 100, 1,000...
+ * ...rather than something like 344.67, 3,446.7, 34,467...
+ *
+ * @param dataMinValue The minimum value from the data
+ * @returns The calculated minimum value if the input dataMinValue is greater than 0
+ * Otherwise, undefined
+ */
+declare function getBestMinValueForAxisLogarithmic(dataMinValue: number): number | undefined;
 /**
  * Updates an axis min max properties.
  *
@@ -85,6 +139,16 @@ export declare function updateBaseInterval(props: {
     timeIntervalInfo?: TimeIntervalInfo;
     dateBaseInterval?: TimeIntervalInfo;
 }): void;
+/**
+ * Indicates whether a series should be used to trigger the update of the axis min/max values.
+ * We are currently rejecting:
+ * - the overlays (trendline and histogram)
+ * - the box plot series that are not CandlestickSeries
+ *
+ * @param series The series instance
+ * @param chartType The chart type
+ */
+declare function allowSeriesToUpdateAxisMinMax(series: XYSeries, chartType?: WebChartTypes): boolean;
 /**
  * When a series is shown or hidden (from the legend for instance), or when its data is updated, we want the value
  * axis bounds to be updated accordingly to the visible series only. When `strictMinMax` is set to `true`, amCharts
@@ -110,7 +174,7 @@ export declare function updateAxis(props: {
     axisValueFormatter?: AxisLabelFormatCallback;
     isSecondValueAxis?: boolean;
     isRotated?: boolean;
-    commonStrings: CommonStrings;
+    utilsStrings: UtilsStrings;
     errorStrings: ErrorStrings;
 }): Promise<void>;
 /**
@@ -128,7 +192,7 @@ export declare function updateAxis(props: {
  * @param props.xAxisLabelFormatter The x-axis label HTML formatter
  * @param props.yAxisLabelFormatter The y-axis label HTML formatter
  * @param props.secondaryYAxisLabelFormatter The secondary y-axis label HTML formatter
- * @param props.commonStrings The common t9n strings
+ * @param props.utilsStrings The t9n utils strings
  * @param props.errorStrings The t9n error strings
  */
 export declare function updateXYChartAxes(props: {
@@ -144,6 +208,15 @@ export declare function updateXYChartAxes(props: {
     xAxisLabelFormatter?: AxisLabelFormatCallback;
     yAxisLabelFormatter?: AxisLabelFormatCallback;
     secondaryYAxisLabelFormatter?: AxisLabelFormatCallback;
-    commonStrings: CommonStrings;
+    utilsStrings: UtilsStrings;
     errorStrings: ErrorStrings;
 }): Promise<void>;
+export declare const utilsAxisrendererPrivateFunctions: {
+    getBestMinValueForAxisLogarithmic: typeof getBestMinValueForAxisLogarithmic;
+    shouldApplyStrictMinMax: typeof shouldApplyStrictMinMax;
+    updateAxisStrictMinMax: typeof updateAxisStrictMinMax;
+    updateAxisLogarithmic: typeof updateAxisLogarithmic;
+    getAxisSeriesIds: typeof getAxisSeriesIds;
+    allowSeriesToUpdateAxisMinMax: typeof allowSeriesToUpdateAxisMinMax;
+};
+export {};