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

package/dist/utils/defaults/index.d.ts

@@ -1,212 +1,485 @@
-import { CategoryFormatOptions, Color, DateTimeFormatOptions, HistogramOverlays, IFont, ISimpleFillSymbol, ISimpleLineSymbol, ISimpleMarkerSymbol, NumberFormatOptions, ScatterplotOverlays, SizePolicy, WebBoxPlot, WebChart, WebChartAxis, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartCursorCrosshair, WebChartGaugeAxis, WebChartGaugeSeries, WebChartHeatChartSeries, WebChartHistogramSeries, WebChartLegend, WebChartLineChartSeries, WebChartNeedle, WebChartOverlay, WebChartPieChartSeries, WebChartPieChartTick, WebChartRadarChartSeries, WebChartScatterplotSeries, WebChartText, WebChartTextSymbol, WebGaugeChart, WebHeatChart, WebChartStackedKinds, WebChartTypes } from '../../spec';
-import { CommonStrings } from '../localization/interfaces';
-import { ChartElementLimit, ChartElementTechnicalLimit, ChartTextProps, QueryDefaults, TextElements } from './interfaces';
-export declare const histogramBinCount = 32;
-export declare const featuresExtentField = "arcgis_charts_features_extent";
-export declare const queryDefaults: QueryDefaults;
-export declare const queryCalculatedExpr: string[];
-export declare const fullOpacity = 1;
-export declare const reducedOpacity = 0.7;
-export declare const defaultGridLineOpacity = 25;
-export declare const defaultAxisLineColor: Color;
-export declare const defaultPieTickColor: Color;
-export declare const defaultLineSymbolStyle: "esriSLSSolid";
-export declare const defaultLineSymbolWidth = 2;
-export declare const pieChartSpecialSlicesId: {
+import type { WebChartStackedKinds, WebChartTypes } from "../../spec/chart-object-literals.js";
+import type { Color, IFont, ISimpleFillSymbol, ISimpleLineSymbol, ISimpleMarkerSymbol } from "../../spec/rest-js-types.js";
+import type { CategoryFormatOptions, DateTimeFormatOptions, HistogramOverlays, NumberFormatOptions, ScatterplotOverlays, SizePolicy, WebBoxPlot, WebChart, WebChartAxis, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartCursorCrosshair, WebChartGaugeAxis, WebChartGaugeSeries, WebChartHeatChartSeries, WebChartHistogramSeries, WebChartLegend, WebChartLineChartSeries, WebChartNeedle, WebChartOverlay, WebChartPieChartSeries, WebChartPieChartTick, WebChartRadarChartSeries, WebChartScatterplotSeries, WebChartText, WebChartTextSymbol, WebGaugeChart, WebHeatChart } from "../../spec/web-chart.js";
+import type { CommonStrings } from "../localization/interfaces.js";
+import type { ChartElementLimit, ChartElementTechnicalLimit, ChartTextProps, QueryDefaults, TextElements } from "./interfaces.js";
+
+/** @internal */
+export const histogramBinCount: 32;
+
+/** @internal */
+export const featuresExtentField: "arcgis_charts_features_extent";
+
+/** @internal */
+export const queryDefaults: QueryDefaults;
+
+/** @internal */
+export const queryCalculatedExpr: (string | string | string | string)[];
+
+/** @internal */
+export const fullOpacity: 1;
+
+/** @internal */
+export const reducedOpacity: 0.7;
+
+/** @internal */
+export const defaultGridLineOpacity: 25;
+
+/** @internal */
+export const defaultAxisLineColor: Color;
+
+/** @internal */
+export const defaultPieTickColor: Color;
+
+/** @internal */
+export const defaultLineSymbolStyle: "esriSLSSolid";
+
+/** @internal */
+export const defaultLineSymbolWidth: 2;
+
+/** @internal */
+export const pieChartSpecialSlicesId: {
     defaultGroupOfSlicesId: string;
     sliceIdPrefix: string;
     undefinedSliceId: string;
     nullSliceId: string;
     emptySliceId: string;
 };
-export declare const defaultBoxPlotCategory = "arcgis_charts_box_plot_category";
-export declare const defaultHeatChartFields: {
+
+/** @internal */
+export const defaultBoxPlotCategory: "arcgis_charts_box_plot_category";
+
+/** @internal */
+export const defaultHeatChartFields: {
     valueField: string;
     xField: string;
     yField: string;
 };
-export declare const ramp: Color[];
-export declare const darkModeRamp: Color[];
-export declare const darkModeOverlayRamp: Color[];
+
+/** @internal */
+export const defaultHeatChartNumberOfBreaks: {
+    min: number;
+    max: number;
+};
+
+/**
+ * default color set from Pro
+ *
+ * @internal
+ */
+export const ramp: Color[];
+
+/** @internal */
+export const darkModeRamp: Color[];
+
+/** @internal */
+export const darkModeOverlayRamp: Color[];
+
 /**
  * Returns a specific color from the default ramp, given an index. If the index is > than the ramp length,
  * we use modulo to get the corresponding color.
- * @param props.colorIndex The index to fetch the color from the `ramp` or `overlayRamp` array
- * @param props.opacity The opacity to set the alpha value, set to 255 as default
- * @param props.histogramOverlays The boolean that is used to identify from which array to fetch default colors
+ *
+ * @param props - The index to fetch the color from the `ramp` or `overlayRamp` array
+ * @internal
  */
-export declare function getOneRampColor(props: {
+export function getOneRampColor(props: {
     colorIndex?: number;
     opacity?: number;
     histogramOverlays?: boolean;
 }): Color;
-export declare function getDefaultColor(opacity?: number): Color;
+
+/**
+ * @param opacity
+ * @internal
+ */
+export function getDefaultColor(opacity?: number): Color;
+
 /**
  * Gets default cursor crosshair
+ *
  * @returns default cursor crosshair
+ * @internal
  */
-export declare function getDefaultCursorCrosshair(): WebChartCursorCrosshair;
+export function getDefaultCursorCrosshair(): WebChartCursorCrosshair;
+
 /**
  * random color with alpha 70% for authoring page.
- * @param opacityPercentage default is 1
+ *
+ * @param opacityPercentage - default is 1
+ * @internal
+ */
+export function generateRandomRestColor(opacityPercentage?: number): Color;
+
+/**
+ * @param type
+ * @internal
+ */
+export function getDefaultFont(type?: TextElements): IFont;
+
+/**
+ * @param text
+ * @param font
+ * @param type
+ * @internal
  */
-export declare function generateRandomRestColor(opacityPercentage?: number): Color;
-export declare function getDefaultFont(type?: TextElements): IFont;
-export declare function getDefaultTextSymbol(text?: string, font?: IFont, type?: TextElements): WebChartTextSymbol;
-export declare function getDefaultChartText(props?: ChartTextProps): WebChartText;
-export declare function getDefaultLineSymbol(props?: {
+export function getDefaultTextSymbol(text?: string, font?: IFont, type?: TextElements): WebChartTextSymbol;
+
+/**
+ * @param props
+ * @internal
+ */
+export function getDefaultChartText(props?: ChartTextProps): WebChartText;
+
+/**
+ * @param props
+ * @internal
+ */
+export function getDefaultLineSymbol(props?: {
     color?: Color;
     useRandomColor?: boolean;
-    useRampColor?: {
-        colorIndex?: number;
-    };
+    useRampColor?: { colorIndex?: number; };
     width?: number;
     opacity?: number;
     isHistogramOverlay?: boolean;
 }): ISimpleLineSymbol;
-export declare function getDefaultCategoryFormat(): CategoryFormatOptions;
-export declare function getDefaultDateFormat(): DateTimeFormatOptions;
-export declare function getDefaultNumberFormat(): NumberFormatOptions;
-export declare function getDefaultStatNumberFormat(): NumberFormatOptions;
-export declare function getDefaultPercentNumberFormat(): NumberFormatOptions;
-export declare function getDefaultValueAxis(text?: string): WebChartAxis;
-export declare function getDefaultLegend(): WebChartLegend;
-export declare function getDefaultOverlay(overlayIndex: number): WebChartOverlay;
-export declare function getDefaultBackground(): Color;
-export declare function getDefaultTitle(commonStrings: CommonStrings): string;
-export declare function getDefaultBoxPlotElementSymbol(seriesIndex?: number, useRandomColor?: boolean): ISimpleFillSymbol;
+
+/** @internal */
+export function getDefaultCategoryFormat(): CategoryFormatOptions;
+
+/** @internal */
+export function getDefaultDateFormat(): DateTimeFormatOptions;
+
+/** @internal */
+export function getDefaultNumberFormat(): NumberFormatOptions;
+
+/** @internal */
+export function getDefaultStatNumberFormat(): NumberFormatOptions;
+
+/** @internal */
+export function getDefaultPercentNumberFormat(): NumberFormatOptions;
+
+/**
+ * @param text
+ * @internal
+ */
+export function getDefaultValueAxis(text?: string): WebChartAxis;
+
+/** @internal */
+export function getDefaultLegend(): WebChartLegend;
+
+/**
+ * @param overlayIndex
+ * @internal
+ */
+export function getDefaultOverlay(overlayIndex: number): WebChartOverlay;
+
+/** @internal */
+export function getDefaultBackground(): Color;
+
+/**
+ * @param commonStrings
+ * @internal
+ */
+export function getDefaultTitle(commonStrings: CommonStrings): string;
+
+/**
+ * @param seriesIndex
+ * @param useRandomColor
+ * @internal
+ */
+export function getDefaultBoxPlotElementSymbol(seriesIndex: number | undefined, useRandomColor?: boolean): ISimpleFillSymbol;
+
 /**
  * Returns a default marker symbol for a line chart
- * @param seriesIndex The series index to pick a symbol color
- * @param useRandomColor Whether to randomize the marker color
- * @returns
+ *
+ * @param seriesIndex - The series index to pick a symbol color
+ * @internal
  */
-export declare function getDefaultLineChartMarkerSymbol(seriesIndex?: number): ISimpleMarkerSymbol;
+export function getDefaultLineChartMarkerSymbol(seriesIndex?: number): ISimpleMarkerSymbol;
+
 /**
  * Returns a default line symbol for a line chart
- * @param seriesIndex The series index to pick a symbol color
+ *
+ * @param seriesIndex - The series index to pick a symbol color
+ * @internal
  */
-export declare function getDefaultLineChartLineSymbol(seriesIndex?: number): ISimpleLineSymbol;
-export declare function getDefaultScatterplotMarkerSymbol(useRandomColor?: boolean): ISimpleMarkerSymbol;
-export declare function getDefaultScatterplotSizePolicy(): Required<SizePolicy>;
-export declare function getDefaultTrendLine(useRandomColor?: boolean): Required<ScatterplotOverlays>;
-export declare function getHeatChartSeries(objectIdField?: string): WebChartHeatChartSeries;
-export declare function getScatterplotSeries(): WebChartScatterplotSeries;
+export function getDefaultLineChartLineSymbol(seriesIndex?: number): ISimpleLineSymbol;
+
+/**
+ * @param useRandomColor
+ * @internal
+ */
+export function getDefaultScatterplotMarkerSymbol(useRandomColor?: boolean): ISimpleMarkerSymbol;
+
+/** @internal */
+export function getDefaultScatterplotSizePolicy(): Required<SizePolicy>;
+
+/**
+ * @param useRandomColor
+ * @internal
+ */
+export function getDefaultTrendLine(useRandomColor?: boolean): Required<ScatterplotOverlays>;
+
+/**
+ * @param commonStrings
+ * @param objectIDField
+ * @internal
+ */
+export function getHeatChartSeries(commonStrings: CommonStrings, objectIDField?: string): WebChartHeatChartSeries;
+
+/** @internal */
+export function getScatterplotSeries(): WebChartScatterplotSeries;
+
 /**
  * Returns default axes based on chart type as per the WebChart Specification
- * @param commonStrings The common strings used in the chart
- * @param chartType The type of WebChart which is of type WebChartTypes
+ *
+ * @param commonStrings - The common strings used in the chart
+ * @param chartType - The type of WebChart which is of type WebChartTypes
+ * @internal
  */
-export declare function getDefaultAxes(commonStrings: CommonStrings, chartType: WebChartTypes): WebChartAxis[];
+export function getDefaultAxes(commonStrings: CommonStrings, chartType: WebChartTypes): WebChartAxis[];
+
 /**
  * Returns the default gauge needle
+ *
+ * @internal
  */
-export declare function getDefaultGaugeNeedle(): WebChartNeedle;
+export function getDefaultGaugeNeedle(): WebChartNeedle;
+
 /**
  * Returns the gauge axes
+ *
+ * @param commonStrings
+ * @internal
  */
-export declare function getGaugeAxes(commonStrings: CommonStrings): WebChartGaugeAxis[];
+export function getGaugeAxes(commonStrings: CommonStrings): WebChartGaugeAxis[];
+
 /**
  * Returns a default LineChartSeries object as per the WebChart Specification
+ *
+ * @param props
+ * @internal
  */
-export declare function getDefaultLineChartSeries(props: {
+export function getDefaultLineChartSeries(props: {
     commonStrings: CommonStrings;
     objectIDField?: string;
     seriesIndex?: number;
 }): Required<Pick<WebChartLineChartSeries, "dataLabels" | "lineSymbol" | "markerSymbol" | "query">> & WebChartLineChartSeries;
+
 /**
  * Returns a default RadarChartSeries object as per the WebChart Specification
+ *
+ * @param props
+ * @internal
  */
-export declare function getDefaultRadarChartSeries(props: {
+export function getDefaultRadarChartSeries(props: {
     commonStrings: CommonStrings;
     objectIDField?: string;
     seriesIndex?: number;
 }): Required<Pick<WebChartRadarChartSeries, "dataLabels" | "lineSymbol" | "markerSymbol" | "query">> & WebChartRadarChartSeries;
+
 /**
  * Returns a default symbol for a bar chart series
- * @param seriesIndex The series index to pick a symbol color
+ *
+ * @param seriesIndex - The series index to pick a symbol color
+ * @internal
  */
-export declare function getDefaultBarChartSeriesSymbol(seriesIndex?: number): ISimpleFillSymbol;
+export function getDefaultBarChartSeriesSymbol(seriesIndex?: number): ISimpleFillSymbol;
+
 /**
  * Returns a default BarChartSeries object as per the WebChart Specification
+ *
+ * @param props
+ * @internal
  */
-export declare function getDefaultBarChartSeries(props: {
+export function getDefaultBarChartSeries(props: {
     objectIDField?: string;
     seriesIndex?: number;
     commonStrings: CommonStrings;
 }): Required<Pick<WebChartBarChartSeries, "dataLabels" | "fillSymbol" | "query">> & WebChartBarChartSeries;
+
 /**
  * Returns a default BoxPlotSeries object as per the WebBoxPlot Specification
+ *
+ * @param commonStrings
+ * @param seriesIndex
+ * @internal
  */
-export declare function getDefaultBoxPlotSeries(commonStrings: CommonStrings, seriesIndex?: number): WebChartBoxPlotSeries;
+export function getDefaultBoxPlotSeries(commonStrings: CommonStrings, seriesIndex?: number): WebChartBoxPlotSeries;
+
 /**
  * Returns a default pie chart tick object as per the WebChart Specification
+ *
+ * @internal
  */
-export declare function getDefaultPieChartTick(): WebChartPieChartTick;
+export function getDefaultPieChartTick(): WebChartPieChartTick;
+
 /**
  * Returns a default symbol for a pie chart
+ *
+ * @internal
  */
-export declare function getDefaultPieChartSymbol(): ISimpleFillSymbol;
+export function getDefaultPieChartSymbol(): ISimpleFillSymbol;
+
 /**
  * Returns a default PieChartSeries object as per the WebChart Specification
+ *
+ * @param commonStrings
+ * @param objectIDField
+ * @internal
  */
-export declare function getDefaultPieChartSeries(commonStrings: CommonStrings, objectIDField?: string): Required<Pick<WebChartPieChartSeries, "dataLabels" | "fillSymbol" | "query">> & WebChartPieChartSeries;
+export function getDefaultPieChartSeries(commonStrings: CommonStrings, objectIDField?: string): Required<Pick<WebChartPieChartSeries, "dataLabels" | "fillSymbol" | "query">> & WebChartPieChartSeries;
+
 /**
  * Returns a default GaugeSeries object as per the WebChart Specification
+ *
+ * @param props
+ * @internal
  */
-export declare function getDefaultGaugeSeries(props: {
-    objectIDField?: string;
-}): WebChartGaugeSeries;
+export function getDefaultGaugeSeries(props: { objectIDField?: string; }): WebChartGaugeSeries;
+
 /**
  * Returns the default chart rotation.
+ *
+ * @internal
  */
-export declare function getDefaultChartRotation(): boolean;
-export declare function getDefaultBarChart(commonStrings: CommonStrings, id?: string): WebChart;
-export declare function getDefaultBoxPlot(commonStrings: CommonStrings, id?: string): WebBoxPlot;
-export declare function getDefaultLineChart(commonStrings: CommonStrings, id?: string): WebChart;
-export declare function getDefaultRadarChart(commonStrings: CommonStrings, id?: string): WebChart;
-export declare function getDefaultPieChart(commonStrings: CommonStrings, id?: string): WebChart;
-export declare function getDefaultGauge(commonStrings: CommonStrings, id?: string): WebGaugeChart;
-export declare function getDefaultScatterplot(commonStrings: CommonStrings, id?: string): WebChart;
+export function getDefaultChartRotation(): boolean;
+
 /**
- * Gets default heat chart
  * @param commonStrings
  * @param id
+ * @internal
+ */
+export function getDefaultBarChart(commonStrings: CommonStrings, id?: string): WebChart;
+
+/**
+ * @param commonStrings
+ * @param id
+ * @internal
+ */
+export function getDefaultBoxPlot(commonStrings: CommonStrings, id?: string): WebBoxPlot;
+
+/**
+ * @param commonStrings
+ * @param id
+ * @internal
+ */
+export function getDefaultLineChart(commonStrings: CommonStrings, id?: string): WebChart;
+
+/**
+ * @param commonStrings
+ * @param id
+ * @internal
+ */
+export function getDefaultRadarChart(commonStrings: CommonStrings, id?: string): WebChart;
+
+/**
+ * @param commonStrings
+ * @param id
+ * @internal
+ */
+export function getDefaultPieChart(commonStrings: CommonStrings, id?: string): WebChart;
+
+/**
+ * @param commonStrings
+ * @param id
+ * @internal
+ */
+export function getDefaultGauge(commonStrings: CommonStrings, id?: string): WebGaugeChart;
+
+/**
+ * @param commonStrings
+ * @param id
+ * @internal
+ */
+export function getDefaultScatterplot(commonStrings: CommonStrings, id?: string): WebChart;
+
+/**
+ * Gets default heat chart
+ *
+ * @param commonStrings - Common strings
+ * @param objectIDField - Object ID field
  * @returns WebHeatChart
+ * @internal
  */
-export declare function getDefaultHeatChart(commonStrings: CommonStrings, objectIDField: string): WebHeatChart;
-export declare function getDefaultHistogramOverlays(): Required<HistogramOverlays>;
-export declare function getDefaultHistogramSymbol(): ISimpleFillSymbol;
-export declare function getDefaultHistogramSeries(): Omit<Required<WebChartHistogramSeries>, "dataTooltipDateFormat" | "dataTooltipPercentFormat" | "dataTooltipValueFormat" | "query">;
-export declare function getDefaultHistogram(commonStrings: CommonStrings, id?: string): WebChart;
+export function getDefaultHeatChart(commonStrings: CommonStrings, objectIDField: string): WebHeatChart;
+
+/** @internal */
+export function getDefaultHistogramOverlays(): Required<HistogramOverlays>;
+
+/** @internal */
+export function getDefaultHistogramSymbol(): ISimpleFillSymbol;
+
+/** @internal */
+export function getDefaultHistogramSeries(): Omit<Required<WebChartHistogramSeries>, "dataTooltipDateFormat" | "dataTooltipPercentFormat" | "dataTooltipValueFormat" | "query">;
+
+/**
+ * @param commonStrings
+ * @param id
+ * @internal
+ */
+export function getDefaultHistogram(commonStrings: CommonStrings, id?: string): WebChart;
+
 /**
  * Returns a list of render limitations, mainly set for performance reasons. They can be overridden through the chart options,
  * or let as defaults.
+ *
+ * @param customizedLimits
+ * @internal
  */
-export declare function getChartLimits(customizedLimits?: ChartElementLimit): Required<ChartElementLimit>;
+export function getChartLimits(customizedLimits?: ChartElementLimit): Required<ChartElementLimit>;
+
 /**
  * Returns a list of technical limitations, mainly to the size of large queries.
+ *
+ * @internal
  */
-export declare function getChartTechnicalLimits(): ChartElementTechnicalLimit;
+export function getChartTechnicalLimits(): ChartElementTechnicalLimit;
+
 /**
  * Returns the label for the provided aggregation type.
+ *
  * @param aggregationType
+ * @param commonStrings
+ * @internal
  */
-export declare function getDefaultAggregationTypeLabel(aggregationType: string | undefined, commonStrings: CommonStrings): string;
+export function getDefaultAggregationTypeLabel(aggregationType: string | undefined, commonStrings: CommonStrings): string;
+
 /**
  * Returns the label for the provided time aggregation type.
+ *
+ * @param timeAggregationType
+ * @param commonStrings
+ * @internal
  */
-export declare function getDefaultTimeAggregationTypeLabel(timeAggregationType: string | undefined, commonStrings: CommonStrings): string;
+export function getDefaultTimeAggregationTypeLabel(timeAggregationType: string | undefined, commonStrings: CommonStrings): string;
+
 /**
  * Returns the default stacked type for Bar or Line chart with multiple series.
- *  */
-export declare function getDefaultStackedType(): WebChartStackedKinds;
+ *
+ * @internal
+ */
+export function getDefaultStackedType(): WebChartStackedKinds;
+
 /**
  * Returns the default label to show when there is no R2 value computed or set for scatterplot
+ *
+ * @param commonStrings
+ * @internal
  */
-export declare function getDefaultNoR2Label(commonStrings: CommonStrings): string;
-export declare const pieChartInnerRadius = 0;
-export declare const boxPlotOutliersSuffix = "_arcgis_charts_outliers";
-export declare const boxPlotZScoreSuffix = "_arcgis_charts_z_score";
-export declare const defaultColorForBoxPlotWithMeanLines: Color;
-export declare const percentageSuffix = " percentage ";
+export function getDefaultNoR2Label(commonStrings: CommonStrings): string;
+
+/** @internal */
+export const pieChartInnerRadius: 0;
+
+/** @internal */
+export const boxPlotOutliersSuffix: "_arcgis_charts_outliers";
+
+/** @internal */
+export const boxPlotZScoreSuffix: "_arcgis_charts_z_score";
+
+/** @internal */
+export const defaultColorForBoxPlotWithMeanLines: Color;
+
+/** @internal */
+export const percentageSuffix: " percentage ";