@arcgis/charts-components 4.33.0-next.106 → 4.33.0-next.108

package/dist/loader.js

@@ -2,7 +2,7 @@ import { r as e } from "./chunks/runtime.js";
 import { makeDefineCustomElements as t } from "@arcgis/lumina";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.33/esri/copyright.txt for details.
-v4.33.0-next.106 */
+v4.33.0-next.108 */
 const o = t(e, {
   "arcgis-chart": [() => import("./components/arcgis-chart/customElement.js"), "actionMode,autoDisposeChart,chartLimits:,chartWillRender:,componentVersion,cursorRange,dataLabelFormatter:,disableInteractions,disableTogglingLegendItems,enableConfiguration,enableResponsiveFeatures,errorPolicy,featureIndex,filterByExtent,filterBySelection,gaugeInnerLabelFormatter:,guideTooltipFormatter:,hideEmptySeries,hideLicenseWatermark,hideLoaderAnimation,ignoreSmoothRenderingLimit,ignoreViewExtent,layer:,layerFieldsChangePolicy,layerFilterChangePolicy,layerRendererChangePolicy,legendPosition,legendValueLabelFormatter:,legendVisibility,loaderColors:,messageOptions:,model:,placeholder,queueChartCreation,replaceNoValueCategoryWithZero,returnFeaturesExtent,returnSelectionIndexes,returnSelectionOIDs,rotation,runtimeDataFilters:,secondaryYAxisLabelFormatter:,selectionData:,selectionTheme:,setTimeBinningInfoWhenNotProvided,syncSelection,syncSelectionsBetweenChartAndLayerViewPolicy,timeZone,tooltipFormatter:,updateSplitBySeries:,useAnimatedCharts,usePopupTemplateFieldsInfo,view:,viewTimeExtentChangePolicy,xAxisLabelFormatter:,yAxisLabelFormatter:;clearSelection,errorAlert,exportImage,notify,refresh,resetZoom,switchSelection"],
   "arcgis-charts-action-bar": [() => import("./components/arcgis-charts-action-bar/customElement.js"), "actionBarSelectionMode,chartElement:,chartType,clearSelectionState,clearSelectionTitle,clearSelectionToggle,editChartState,editChartTitle,editChartToggle,expanded,filterByExtentState,filterByExtentTitle,filterByExtentToggle,filterBySelectionState,filterBySelectionTitle,filterBySelectionToggle,forceDisableActions,fullExtentState,fullExtentTitle,fullExtentToggle,hiddenActions:,legendState,legendTitle,legendToggle,messageOverrides:,rotateChartState,rotateChartTitle,rotateChartToggle,selectionState,selectionTitle,selectionToggle,switchSelectionState,switchSelectionTitle,switchSelectionToggle,zoomState,zoomTitle,zoomToggle"],

package/dist/model/chart-model/chart-model.d.ts

@@ -1,4 +1,4 @@
-import { Color, LegendItemVisibility, SupportedLayer, WebChartTextSymbol } from '@arcgis/charts-spec';
+import { Color, IDrawingInfo, LegendItemVisibility, SupportedLayer, WebChartTextSymbol } from '@arcgis/charts-spec';
 import { ModelParams } from '../interfaces/chart-interfaces';
 import { LayerInfo } from '../interfaces/common';
 import { ChartConfig, ChartSubType, ChartTypes, SupportedChartSeries } from '../../utils';
@@ -29,13 +29,13 @@ export declare abstract class ChartModel extends EventTarget {
     dataStore: any;
     /**
      * Completes the async setup process for the chart model. Must be called before using the model.
-     * @param {ModelParams} params - The parameters to be used to set up the chart model.
+     * @param {ModelParams} params The parameters to be used to set up the chart model.
      * @async **This method is `async` and must be awaited for the changes to take effect.**
      */
     abstract setup(params: ModelParams<ChartConfig>): Promise<void>;
     /**
      * Checks if the current chart model is for the same chart as another chart model.
-     * @param {ChartModel | undefined} otherModel - The other chart model to compare to.
+     * @param {ChartModel | undefined} otherModel The other chart model to compare to.
      * @returns {boolean}
      */
     isSameChartAs(otherModel: ChartModel | undefined): boolean;
@@ -46,9 +46,9 @@ export declare abstract class ChartModel extends EventTarget {
     getConfig(): ChartConfig;
     /**
      * Sets the chart configuration object.
-     * @param {ChartConfig} newConfig - The new configuration object.
+     * @param {ChartConfig} config The configuration object.
      */
-    setConfig(newConfig: ChartConfig): void;
+    setConfig(config: ChartConfig): void;
     /**
      * Gets the chart type.
      * @returns {ChartTypes}
@@ -66,15 +66,20 @@ export declare abstract class ChartModel extends EventTarget {
     getChartId(): string | undefined;
     /**
      * Sets the chart id.
-     * @param {string} newId
+     * @param {string} id
      */
-    setChartId(newId: string): void;
+    setChartId(id: string): void;
     /**
      * Promise that resolves when the setup process is complete.
      *
      * **Note: This promise does not need to be awaited if the `setup` method has already been awaited. It is simply provided as a way to await the setup process from other functions if needed to avoid race conditions.**
      */
     setupFinished: Promise<void>;
+    /**
+     * Gets the version of the chart configuration.
+     * @returns {string}
+     */
+    getVersion(): string;
     /**
      * Gets the chart title text.
      * @returns {string}
@@ -82,9 +87,9 @@ export declare abstract class ChartModel extends EventTarget {
     getTitleText(): string;
     /**
      * Sets the chart title text.
-     * @param {string} newTitle - The new title text.
+     * @param {string} title The title text.
      */
-    setTitleText(newTitle: string): void;
+    setTitleText(title: string): void;
     /**
      * Gets the chart subtitle text.
      * @returns {string}
@@ -92,9 +97,9 @@ export declare abstract class ChartModel extends EventTarget {
     getSubtitleText(): string;
     /**
      * Sets the chart subtitle text.
-     * @param {string} newSubTitle - The new subtitle text.
+     * @param {string} subtitle The subtitle text.
      */
-    setSubtitleText(newSubTitle: string): void;
+    setSubtitleText(subtitle: string): void;
     /**
      * Gets the chart description text.
      * @returns {string}
@@ -102,11 +107,11 @@ export declare abstract class ChartModel extends EventTarget {
     getDescriptionText(): string;
     /**
      * Sets the chart description text.
-     * @param {string} newDescription - The new description text.
+     * @param {string} description The description text.
      */
-    setDescriptionText(newDescription: string): void;
+    setDescriptionText(description: string): void;
     /**
-     * Gets whether the chart title is visible or not.
+     * Gets whether or not the chart title is visible.
      *
      * `true`: Chart title is visible.
      *
@@ -118,19 +123,43 @@ export declare abstract class ChartModel extends EventTarget {
      */
     getChartTitleVisibility(): boolean;
     /**
-     * Sets whether the chart title is visible or not.
+     * Sets whether or not the chart title is visible.
      *
      * `true`: Show chart title.
      *
      * `false`: Hide chart title.
      *
-     * @param {boolean} newVisibility - The new visibility state of the chart title.
+     * @param {boolean} visibility The visibility state of the chart title.
      *
      * **Note: Even if the title is visible, it may not be displayed if the title text is empty.**
      */
-    setChartTitleVisibility(newVisibility: boolean): void;
+    setChartTitleVisibility(visibility: boolean): void;
     /**
-     * Gets whether the chart description is visible or not.
+     * Gets whether or not the chart subtitle is visible.
+     *
+     * `true`: Chart subtitle is visible.
+     *
+     * `false`: Chart subtitle is hidden.
+     *
+     * @returns {boolean}
+     *
+     * **Note: Even if the subtitle is visible, it may not be displayed if the subtitle text is empty.**
+     */
+    getChartSubtitleVisibility(): boolean;
+    /**
+     * Sets whether or not the chart subtitle is visible.
+     *
+     * `true`: Show chart subtitle.
+     *
+     * `false`: Hide chart subtitle.
+     *
+     * @param {boolean} visibility The visibility state of the chart subtitle.
+     *
+     * **Note: Even if the subtitle is visible, it may not be displayed if the subtitle text is empty.**
+     */
+    setChartSubtitleVisibility(visibility: boolean): void;
+    /**
+     * Gets whether or not the chart description is visible.
      *
      * `true`: Description is visible.
      *
@@ -142,17 +171,27 @@ export declare abstract class ChartModel extends EventTarget {
      */
     getDescriptionVisibility(): boolean;
     /**
-     * Sets whether the chart description is visible or not.
+     * Sets whether or not the chart description is visible.
      *
      * `true`: Show description.
      *
      * `false`: Hide description.
      *
-     * @param {boolean} newVisibility - The new visibility state of the description.
+     * @param {boolean} visibility The visibility state of the description.
      *
      * **Note: Even if the description is visible, it may not be displayed if the description text is empty.**
      */
-    setDescriptionVisibility(newVisibility: boolean): void;
+    setDescriptionVisibility(visibility: boolean): void;
+    /**
+     * Gets the chart renderer.
+     * @returns {IDrawingInfo["renderer"] | undefined} The chart renderer if defined, otherwise undefined.
+     */
+    getChartRenderer(): IDrawingInfo["renderer"] | undefined;
+    /**
+     * Sets the chart renderer.
+     * @param renderer The chart renderer to set.
+     */
+    setChartRenderer(renderer: IDrawingInfo["renderer"]): void;
     /**
      * Gets the title text symbol. Contains styling information such as font, color, and symbol style.
      * @returns {WebChartTextSymbol | undefined}
@@ -160,9 +199,19 @@ export declare abstract class ChartModel extends EventTarget {
     getTitleSymbol(): WebChartTextSymbol | undefined;
     /**
      * Sets the title text symbol. Contains styling information such as font, color, and symbol style.
-     * @param {WebChartTextSymbol | undefined} newTitleSymbol - The new title symbol.
+     * @param {WebChartTextSymbol | undefined} titleSymbol The title symbol.
+     */
+    setTitleSymbol(titleSymbol: WebChartTextSymbol | undefined): void;
+    /**
+     * Gets the subtitle text symbol. Contains styling information such as font, color, and symbol style.
+     * @returns {WebChartTextSymbol | undefined}
+     */
+    getSubtitleSymbol(): WebChartTextSymbol | undefined;
+    /**
+     * Sets the subtitle text symbol. Contains styling information such as font, color, and symbol style.
+     * @param {WebChartTextSymbol | undefined} subtitleSymbol The title symbol.
      */
-    setTitleSymbol(newTitleSymbol: WebChartTextSymbol | undefined): void;
+    setSubtitleSymbol(subtitleSymbol: WebChartTextSymbol | undefined): void;
     /**
      * Gets the description text symbol. Contains styling information such as font, color, and symbol style.
      * @returns {WebChartTextSymbol | undefined}
@@ -170,9 +219,9 @@ export declare abstract class ChartModel extends EventTarget {
     getDescriptionSymbol(): WebChartTextSymbol | undefined;
     /**
      * Sets the description text symbol. Contains styling information such as font, color, and symbol style.
-     * @param {WebChartTextSymbol | undefined} newDescriptionSymbol - The new description symbol.
+     * @param {WebChartTextSymbol | undefined} descriptionSymbol The description symbol.
      */
-    setDescriptionSymbol(newDescriptionSymbol: WebChartTextSymbol | undefined): void;
+    setDescriptionSymbol(descriptionSymbol: WebChartTextSymbol | undefined): void;
     /**
      * Gets the background color of the chart.
      * @returns {Color | undefined}
@@ -180,9 +229,9 @@ export declare abstract class ChartModel extends EventTarget {
     getBackgroundColor(): Color | undefined;
     /**
      * Sets the background color of the chart.
-     * @param {Color | undefined} newBackgroundColor - The new background color.
+     * @param {Color | undefined} backgroundColor The background color.
      */
-    setBackgroundColor(newBackgroundColor: Color | undefined): void;
+    setBackgroundColor(backgroundColor: Color | undefined): void;
     /**
      * Gets the visibility of a series.
      * @param seriesIndex The series index
@@ -203,7 +252,7 @@ export declare abstract class ChartModel extends EventTarget {
      *
      * If the series index is out of bounds, this function will return `undefined`.
      *
-     * @param {number} seriesIndex
+     * @param {number} seriesIndex The index of the series.
      * @returns {string | undefined}
      */
     getSeriesId(seriesIndex: number): string | undefined;
@@ -228,15 +277,14 @@ export declare abstract class ChartModel extends EventTarget {
     getChartSubType(): ChartSubType;
     /**
      * Sets whether to fetch `null` values for them to be counted or displayed as categories on the chart.
-     * @param  {ChartConfig<WebChartBarChartSeries} config - The chart config.
      *
-     * @returns boolean - The fetch NULL values.
+     * @param fetchNULLValues Whether to fetch `null` values.
      */
     setFetchNULLValues(fetchNULLValues: boolean): void;
     /**
      * Gets whether to fetch `null` values for them to be counted or displayed as categories on the chart.
      *
-     * @returns boolean - The fetch NULL values.
+     * @returns {boolean} Boolean value indicates whether NULL values will be fetched.
      */
     getFetchNULLValues(): boolean;
     /**

package/dist/model/chart-model/utils/data.d.ts

@@ -1,15 +1,13 @@
 import { ChartConfig } from '../../../utils';
 /**
- * Set whether to fetch `null` values for them to be counted or displayed as categories on the chart.
- * @param  {ChartConfig<WebChartBarChartSeries} config - The chart config.
- *
- * @returns boolean - The fetch NULL values.
+ * Sets whether to fetch `null` values for them to be counted or displayed as categories on the chart.
+ * @param fetchNULLValues Whether to fetch `null` values.
+ * @param config The chart config.
  */
 export declare const setFetchNULLValues: (fetchNULLValues: boolean, config: ChartConfig) => void;
 /**
- * Get whether to fetch `null` values for them to be counted or displayed as categories on the chart.
- * @param  {ChartConfig<WebChartBarChartSeries} config - The chart config.
- *
- * @returns boolean - The fetch NULL values.
+ * Gets whether to fetch `null` values for them to be counted or displayed as categories on the chart.
+ * @param config The chart config.
+ * @returns {boolean} Boolean value indicates whether NULL values will be fetched.
  */
 export declare const getFetchNULLValues: (config: ChartConfig) => boolean;

package/dist/model/chart-model/utils/format.d.ts

@@ -1,35 +1,46 @@
-import { ChartConfig } from '../../../utils';
 import { Color, WebChartTextSymbol } from '@arcgis/charts-spec';
+import { ChartConfig } from '../../../utils';
 /**
  * Gets the title text symbol from the chart config.
- * @param config
+ * @param config The chart config object
  */
 export declare const getTitleSymbol: (config: ChartConfig) => WebChartTextSymbol | undefined;
 /**
  * Sets the title text symbol in the chart config.
- * @param config
- * @param newTitleSymbol
+ * @param config The chart config object
+ * @param textSymbol The title symbol to set
+ */
+export declare const setTitleSymbol: (textSymbol: WebChartTextSymbol | undefined, config: ChartConfig) => void;
+/**
+ * Gets the subtitle text symbol from the chart config.
+ * @param config The chart config object
+ */
+export declare const getSubtitleSymbol: (config: ChartConfig) => WebChartTextSymbol | undefined;
+/**
+ * Sets the subtitle text symbol in the chart config.
+ * @param config The chart config object
+ * @param textSymbol The subtitle symbol to set
  */
-export declare const setTitleSymbol: (newTitleSymbol: WebChartTextSymbol | undefined, config: ChartConfig) => void;
+export declare const setSubtitleSymbol: (textSymbol: WebChartTextSymbol | undefined, config: ChartConfig) => void;
 /**
  * Gets the description text symbol from the chart config.
- * @param config
+ * @param config The chart config object
  */
 export declare const getDescriptionSymbol: (config: ChartConfig) => WebChartTextSymbol | undefined;
 /**
  * Sets the description text symbol in the chart config.
- * @param config
- * @param newDescriptionSymbol
+ * @param config The chart config object
+ * @param textSymbol The description symbol to set
  */
-export declare const setDescriptionSymbol: (newDescriptionSymbol: WebChartTextSymbol | undefined, config: ChartConfig) => void;
+export declare const setDescriptionSymbol: (textSymbol: WebChartTextSymbol | undefined, config: ChartConfig) => void;
 /**
  * Gets the background color from the chart config.
- * @param config
+ * @param config The chart config object
  */
 export declare const getBackgroundColor: (config: ChartConfig) => Color | undefined;
 /**
  * Sets the background color in the chart config.
- * @param config
- * @param newBackgroundColor
+ * @param config The chart config object
+ * @param backgroundColor The background color to set
  */
-export declare const setBackgroundColor: (newBackgroundColor: Color | undefined, config: ChartConfig) => void;
+export declare const setBackgroundColor: (backgroundColor: Color | undefined, config: ChartConfig) => void;

package/dist/model/chart-model/utils/general.d.ts

@@ -1,56 +1,85 @@
+import { IDrawingInfo } from '@arcgis/charts-spec';
 import { ChartConfig } from '../../../utils';
+/**
+ * Gets the version of the chart configuration.
+ * @returns {string}
+ */
+export declare const getVersion: (config: ChartConfig) => string | undefined;
 /**
  * Gets the title text of the chart from the config
- * @param config - the config object
+ * @param config The config object
  */
 export declare const getTitleText: (config: ChartConfig) => string;
 /**
  * Sets the title text of the chart
- * @param newTitleText - the new title text
- * @param config - the config object
+ * @param titleText The title text
+ * @param config The config object
  */
-export declare const setTitleText: (newTitleText: string, config: ChartConfig) => void;
+export declare const setTitleText: (titleText: string, config: ChartConfig) => void;
 /**
  * Gets the subtitle text of the chart from the config
- * @param config - the config object
+ * @param config The config object
  */
 export declare const getSubtitleText: (config: ChartConfig) => string;
 /**
  * Sets the subtitle text of the chart
- * @param newSubTitleText - the new subtitle text
- * @param config - the config object
+ * @param subtitleText The subtitle text
+ * @param config The config object
  */
-export declare const setSubtitleText: (newSubTitleText: string, config: ChartConfig) => void;
+export declare const setSubtitleText: (subtitleText: string, config: ChartConfig) => void;
 /**
  * Gets the description text
- * @param config - the config object
+ * @param config The config object
  */
 export declare const getDescriptionText: (config: ChartConfig) => string;
 /**
  * Sets the description text of the chart
- * @param newDescriptionText  - the new description text
- * @param config - the config object
+ * @param descriptionText  The description text
+ * @param config The config object
  */
-export declare const setDescriptionText: (newDescriptionText: string, config: ChartConfig) => void;
+export declare const setDescriptionText: (descriptionText: string, config: ChartConfig) => void;
 /**
  * Gets whether the chart title is visible.
- * @param config - the config object
+ * @param config The config object
  */
 export declare const getChartTitleVisibility: (config: ChartConfig) => boolean;
 /**
  * Sets whether to the chart title is visible.
- * @param newVisibility - whether to show the chart title or not
- * @param config - the config object
+ * @param visibility Whether or not to show the chart title
+ * @param config The config object
+ */
+export declare const setChartTitleVisibility: (visibility: boolean, config: ChartConfig) => void;
+/**
+ * Gets whether the chart subtitle is visible.
+ * @param config The config object
+ */
+export declare const getChartSubtitleVisibility: (config: ChartConfig) => boolean;
+/**
+ * Sets whether to the chart subtitle is visible.
+ * @param visibility Whether or not to show the chart subtitle
+ * @param config The config object
  */
-export declare const setChartTitleVisibility: (newVisibility: boolean, config: ChartConfig) => void;
+export declare const setChartSubtitleVisibility: (visibility: boolean, config: ChartConfig) => void;
 /**
  * Gets whether the description is visible.
- * @param config - the config object
+ * @param config The config object
  */
 export declare const getDescriptionVisibility: (config: ChartConfig) => boolean;
 /**
  * Sets whether the description is visible.
- * @param newVisibility - whether to show the description or not
- * @param config - the config object
+ * @param visibility Whether or not to show the description
+ * @param config The config object
+ */
+export declare const setDescriptionVisibility: (visibility: boolean, config: ChartConfig) => void;
+/**
+ * Gets the chart renderer from the chart config.
+ * @param config  The chart config
+ * @returns {IDrawingInfo["renderer"] | undefined} The chart renderer if defined, otherwise undefined.
+ */
+export declare const getChartRenderer: (config: ChartConfig) => IDrawingInfo["renderer"] | undefined;
+/**
+ * Sets the chart renderer in the chart config.
+ * @param renderer The chart renderer to set.
+ * @param config The chart config to set the renderer on.
  */
-export declare const setDescriptionVisibility: (newVisibility: boolean, config: ChartConfig) => void;
+export declare const setChartRenderer: (renderer: IDrawingInfo["renderer"] | undefined, config: ChartConfig) => void;