@arcgis/charts-components 4.34.0-next.133 → 4.34.0-next.134

package/dist/components/arcgis-charts-action-bar/customElement.d.ts

@@ -19,50 +19,362 @@ import { ArcgisChart } from '../arcgis-chart/customElement.js';
  * @slot [custom-action-below] - A slot for adding custom `calcite-action` to the bottom of the default actions.
  */
 export declare class ArcgisChartsActionBar extends LitElement {
+    /** Overwrite localized strings for this component */
     messageOverrides?: typeof this._messages._overrides;
+    /**
+     * Chart type used to determine which default actions to display.
+     *
+     * @category Public
+     * @type {SupportedCharts | undefined}
+     * @default undefined
+     */
     chartType?: ChartTypes;
+    /**
+     * Chart element reference with which the action bar is associated.
+     *
+     * @category Public
+     * @type {HTMLArcgisChartElement}
+     * @default undefined
+     */
     chartElement?: HTMLArcgisChartElement;
+    /**
+     * When `true`, overrides the individual settings for each action to instead force disable them all.
+     *
+     * @category Public
+     * @type {boolean}
+     * @default false
+     */
     forceDisableActions: boolean;
+    /**
+     * When active, the edit chart action is highlighted.
+     *
+     * @category Public
+     * @type {ActionToggle}
+     * @default "inactive"
+     */
     editChartToggle: ActionToggle;
+    /**
+     * When disabled, interaction with the edit chart action is prevented and the component is displayed with lower opacity.
+     *
+     * @category Public
+     * @type {ActionState}
+     * @default "disabled"
+     */
     editChartState: ActionState;
+    /**
+     * Custom title for the edit chart action.
+     *
+     * @category Public
+     * @type {string | undefined}
+     * @default undefined
+     */
     editChartTitle?: string;
+    /**
+     * When active, the legend action is highlighted.
+     *
+     * @category Public
+     * @type {ActionToggle}
+     * @default "inactive"
+     */
     legendToggle: ActionToggle;
+    /**
+     * When disabled, interaction with the legend action is prevented and the component is displayed with lower opacity.
+     *
+     * @category Public
+     * @type {ActionState}
+     * @default "enabled"
+     */
     legendState: ActionState;
+    /**
+     * Custom title for the legend action.
+     *
+     * @category Public
+     * @type {string | undefined}
+     * @default undefined
+     */
     legendTitle?: string;
+    /**
+     * When active, the rotate chart action is highlighted.
+     *
+     * @category Public
+     * @type {ActionToggle}
+     * @default "inactive"
+     */
     rotateChartToggle: ActionToggle;
+    /**
+     * When disabled, interaction with the rotate chart action is prevented and the component is displayed with lower opacity.
+     *
+     * @category Public
+     * @type {ActionState}
+     * @default "enabled"
+     */
     rotateChartState: ActionState;
+    /**
+     * Custom title for the rotate chart action.
+     *
+     * @category Public
+     * @type {string | undefined}
+     * @default undefined
+     */
     rotateChartTitle?: string;
+    /**
+     * When active, the filter by selection action is highlighted.
+     *
+     * @category
+     * Public
+     * type {ActionToggle}
+     * @default "inactive"
+     */
     filterBySelectionToggle: ActionToggle;
+    /**
+     * When disabled, interaction with the filter by selection action is prevented and the component is displayed with lower opacity.
+     *
+     * @category Public
+     * @type {ActionState}
+     * @default "enabled"
+     */
     filterBySelectionState: ActionState;
+    /**
+     * Custom title for the filter by selection action.
+     *
+     * @category Public
+     * @type {string | undefined}
+     * @default undefined
+     */
     filterBySelectionTitle?: string;
+    /**
+     * When active, the filter by extent action is highlighted.
+     *
+     * @category Public
+     * @type {ActionToggle}
+     * @default "inactive"
+     */
     filterByExtentToggle: ActionToggle;
+    /**
+     * When disabled, interaction with the filter by extent action is prevented and the component is displayed with lower opacity.
+     *
+     * @category Public
+     * @type {ActionState}
+     * @default "enabled"
+     */
     filterByExtentState: ActionState;
+    /**
+     * Custom title for the filter by extent action.
+     *
+     * @category Public
+     * @type {string | undefined}
+     * @default undefined
+     */
     filterByExtentTitle?: string;
+    /**
+     * Action bar selection mode. Defines which selection mode the slotted action bar should use.
+     *
+     * @category Public
+     * @type {Extract<ActionModes, "monoSelection" | "multiSelection" | "multiSelectionWithCtrlKey">}
+     * @default "multiSelectionWithCtrlKey"
+     */
     actionBarSelectionMode?: Extract<ActionModes, "monoSelection" | "multiSelection" | "multiSelectionWithCtrlKey">;
+    /**
+     * When active, the selection action is highlighted.
+     *
+     * @category Public
+     * @type {ActionToggle}
+     * @default "inactive"
+     */
     selectionToggle: ActionToggle;
+    /**
+     * When disabled, interaction with the selection action is prevented and the component is displayed with lower opacity.
+     *
+     * @category Public
+     * @type {ActionState}
+     * @default "enabled"
+     */
     selectionState: ActionState;
+    /**
+     * Custom title for the selection action.
+     *
+     * @category Public
+     * @type {string | undefined}
+     * @default undefined
+     */
     selectionTitle?: string;
+    /**
+     * When active, the zoom action is highlighted.
+     *
+     * @category Public
+     * @type {ActionToggle}
+     * @default "inactive"
+     */
     zoomToggle: ActionToggle;
+    /**
+     * When disabled, interaction with the zoom action is prevented and the component is displayed with lower opacity.
+     *
+     * @category Public
+     * @type {ActionState}
+     * @default "enabled"
+     */
     zoomState: ActionState;
+    /**
+     * Custom title for the zoom action.
+     *
+     * @category Public
+     * @type {string | undefined}
+     * @default undefined
+     */
     zoomTitle?: string;
+    /**
+     * When active, the full extent action is highlighted.
+     *
+     * @category Public
+     * @type {ActionToggle}
+     * @default "inactive"
+     */
     fullExtentToggle: ActionToggle;
+    /**
+     * When disabled, interaction with the full extent action is prevented and the component is displayed with lower opacity.
+     *
+     * @category Public
+     * @type {ActionState}
+     * @default "enabled"
+     */
     fullExtentState: ActionState;
+    /**
+     * Custom title for the full extent action.
+     *
+     * @category Public
+     * @type {string | undefined}
+     * @default undefined
+     */
     fullExtentTitle?: string;
+    /**
+     * When active, the clear selection action is highlighted.
+     *
+     * @category Public
+     * @type {ActionToggle}
+     * @default "inactive"
+     */
     clearSelectionToggle: ActionToggle;
+    /**
+     * When disabled, interaction with the clear selection action is prevented and the component is displayed with lower opacity.
+     *
+     * @category Public
+     * @type {ActionState}
+     * @default "enabled"
+     */
     clearSelectionState: ActionState;
+    /**
+     * Custom title for the clear selection action.
+     *
+     * @category Public
+     * @type {string | undefined}
+     * @default undefined
+     */
     clearSelectionTitle?: string;
+    /**
+     * When active, the switch selection action is highlighted.
+     *
+     * @category Public
+     * @type {ActionToggle}
+     * @default "inactive"
+     */
     switchSelectionToggle: ActionToggle;
+    /**
+     * When disabled, interaction with the switch selection action is prevented and the component is displayed with lower opacity.
+     *
+     * @category Public
+     * @type {ActionState}
+     * @default "enabled"
+     */
     switchSelectionState: ActionState;
+    /**
+     * Custom title for the switch selection action.
+     *
+     * @category Public
+     * @type {string | undefined}
+     * @default undefined
+     */
     switchSelectionTitle?: string;
+    /**
+     * When disabled, interaction with the download image is prevented and the component is displayed with lower opacity.
+     *
+     * @category Public
+     * @type {ActionState}
+     * @default "enabled"
+     */
     exportAsImageState: ActionState;
+    /**
+     * Custom title for the download chart action.
+     *
+     * @category Public
+     * @type {string | undefined}
+     * @default undefined
+     */
     exportAsImageTitle?: string;
+    /**
+     * When disabled, interaction with the download CSV is prevented and the component is displayed with lower opacity.
+     *
+     * @category Public
+     * @type {ActionState}
+     * @default "enabled"
+     */
     exportAsCSVState: ActionState;
+    /**
+     * Custom title for the download CSV action.
+     *
+     * @category Public
+     * @type {string | undefined}
+     * @default undefined
+     */
     exportAsCSVTitle?: string;
+    /**
+     * The CSV export action is disabled for certain chart types.
+     *
+     * Modify this property to add or remove chart types from the list of disabled types.
+     *
+     * @category Public
+     * @type {WebChartTypes[]}
+     * @default [WebChartTypes.ScatterSeries, WebChartTypes.BoxPlotSeries]
+     */
     disableCSVExportForChartTypes: WebChartTypes[];
+    /**
+     * When disabled, interaction with the export action is prevented and the component is displayed with lower opacity.
+     *
+     * @category Public
+     * @type {ActionState}
+     * @default "enabled"
+     */
     exportActionState: ActionState;
+    /**
+     * When `true`, the action bar is expanded.
+     *
+     * @category Public
+     * @type {boolean}
+     * @default false
+     */
     expanded: boolean;
+    /**
+     * Holds a list of actions to hide from the action bar.
+     *
+     * **Note:** The edit chart action is hidden by default. To show it, remove its value from this array.
+     *
+     * @category Public
+     * @type {DefaultChartActions[]}
+     * @default ["editChart"]
+     */
     hiddenActions: DefaultChartActions[];
+    /**
+     * Event triggered once action bar expand is toggled
+     *
+     * @type {EventEmitter<boolean>}
+     * @event
+     */
     readonly arcgisActionBarToggle: TargetedEvent<this, boolean>;
+    /**
+     * Event triggered once a default action is selected
+     *
+     * @type {EventEmitter<DefaultActionSelectPayload>}
+     * @event
+     */
     readonly arcgisDefaultActionSelect: TargetedEvent<this, DefaultActionSelectPayload>;
     private _messages;
 }

package/dist/components/arcgis-charts-action-bar/customElement.js

@@ -22,7 +22,7 @@ import { LitElement as O, renderElement as B, safeStyleMap as D, createEvent as
 import { d as n } from "../../chunks/chart-ui-utils2.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.34/esri/copyright.txt for details.
-v4.34.0-next.133 */
+v4.34.0-next.134 */
 function V(h) {
   return h?.tagName.toLowerCase() === "arcgis-chart";
 }

package/dist/components/arcgis-charts-config-axes/customElement.d.ts

@@ -5,16 +5,73 @@ import { ModelWithMultiAxes } from '../../model/mixins';
 
 /** @private */
 export declare class ArcgisChartsConfigAxes extends LitElement {
+    /** Overwrite localized strings for this component */
     messageOverrides?: typeof this._messages._overrides;
+    /**
+     * Chart Model.
+     *
+     * @category Public
+     */
     model: ModelWithMultiAxes;
+    /**
+     * Data min and max values for x and y fields
+     *
+     * @category Public
+     */
     calculatedDataMinMaxBounds?: CalculatedMinMaxBoundsPayload[];
+    /**
+     * When true, the content of the component will be displayed.
+     *
+     * @default false
+     */
     open: boolean;
+    /**
+     * Whether to show the input option to set X-axis minimum bound.
+     *
+     * @category Public
+     * @default false
+     */
     showMinXBoundOption?: boolean;
+    /**
+     * Whether to show the input option to set X-axis maximum bound.
+     *
+     * @category Public
+     * @default false
+     */
     showMaxXBoundOption?: boolean;
+    /**
+     * Whether to show the input option to set Y-axis minimum bound.
+     *
+     * @category Public
+     * @default false
+     */
     showMinYBoundOption?: boolean;
+    /**
+     * Whether to show the input option to set Y-axis maximum bound.
+     *
+     * @category Public
+     * @default false
+     */
     showMaxYBoundOption?: boolean;
+    /**
+     * Whether to show the switch option to enable X-axis logarithmic scale.
+     *
+     * @category Public
+     * @default false
+     */
     showEnableXLogOption?: boolean;
+    /**
+     * Whether to show the switch option to enable Y-axis logarithmic scale.
+     *
+     * @category Public
+     * @default false
+     */
     showEnableYLogOption?: boolean;
+    /**
+     * Min/Max bounds computed by the chart
+     *
+     * @category Public
+     */
     calculatedMinMaxBounds?: CalculatedMinMaxBoundsPayload[];
     private _messages;
 }

package/dist/components/arcgis-charts-config-axes/customElement.js

@@ -4,7 +4,7 @@ import { u as e } from "../../chunks/useT9n.js";
 import { LitElement as d } from "@arcgis/lumina";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.34/esri/copyright.txt for details.
-v4.34.0-next.133 */
+v4.34.0-next.134 */
 const u = o`:host{display:flex;flex-direction:column;width:var(--arcgis-charts-config-calcite-block-default-width)}`;
 class l extends d {
   constructor() {

package/dist/components/arcgis-charts-config-axis/customElement.d.ts

@@ -5,20 +5,97 @@ import { ModelWithMultiAxes } from '../../model/mixins';
 
 /** @private */
 export declare class ArcgisChartsConfigAxis extends LitElement {
+    /** Overwrite localized strings for this component */
     messageOverrides?: typeof this._messages._overrides;
+    /**
+     * Chart Model.
+     *
+     * @category Public
+     */
     model: ModelWithMultiAxes;
+    /**
+     * Whether this axis component is for the X-axis or the Y-axis.
+     *
+     * @category Public
+     * @default false
+     */
     isXAxis: boolean;
+    /**
+     * Title of the axis.
+     *
+     * @category Public
+     * @default ""
+     */
     axisTitle: string;
+    /**
+     * Maximum limit for maxBounds input
+     *
+     * @category Public
+     */
     maxBoundMaxLimit?: number;
+    /**
+     * Minimum limit for maxBounds input
+     *
+     * @category Public
+     */
     maxBoundMinLimit?: number;
+    /**
+     * Minimum limit for minBounds input
+     *
+     * @category Public
+     */
     minBoundMinLimit?: number;
+    /**
+     * Maximum limit for minBounds input
+     *
+     * @category Public
+     */
     minBoundMaxLimit?: number;
+    /**
+     * Show maximum bounds option for the axis.
+     *
+     * @category Public
+     * @default false
+     */
     showMaxBoundOption?: boolean;
+    /**
+     * Show minimum bounds option for the axis.
+     *
+     * @category Public
+     * @default false
+     */
     showMinBoundOption?: boolean;
+    /**
+     * Show enable logarithmic option for the axis.
+     *
+     * @category Public
+     * @default false
+     */
     showEnableLogOption?: boolean;
+    /**
+     * Data max value for the field used by the axis.
+     *
+     * @category Public
+     */
     dataMaxValue?: number;
+    /**
+     * Data min value for the field used by the axis.
+     * Used to know when to enable the logarithmic switch.
+     *
+     * @category Public
+     */
     dataMinValue?: number;
+    /**
+     * Initial value for the max bound.
+     *
+     * @category Public
+     */
     initialMaxBound?: number;
+    /**
+     * Initial value for the min bound.
+     *
+     * @category Public
+     */
     initialMinBound?: number;
     private _messages;
 }

package/dist/components/arcgis-charts-config-axis/customElement.js

@@ -2,7 +2,7 @@ import { c as b } from "../../chunks/runtime.js";
 import { W as d } from "../../chunks/series-types.js";
 import { debounce as m } from "lodash-es";
 import { g as f, s as N } from "../../chunks/store.js";
-import { a as c, m as g, b as a, U as M, s as x } from "../../chunks/chart-ui-utils2.js";
+import { b as c, m as g, c as a, U as M, s as x } from "../../chunks/chart-ui-utils2.js";
 import { A as B } from "../../chunks/axis-model-wrapper.js";
 import { u as p } from "../../chunks/useT9n.js";
 import { css as v, html as s } from "lit";
@@ -10,7 +10,7 @@ import { createRef as r, ref as h } from "lit/directives/ref.js";
 import { LitElement as C, renderElement as I, safeClassMap as u } from "@arcgis/lumina";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.34/esri/copyright.txt for details.
-v4.34.0-next.133 */
+v4.34.0-next.134 */
 const o = {
   linkContainer: "link-container",
   label: "label",

package/dist/components/arcgis-charts-config-bar-chart/customElement.d.ts

@@ -9,13 +9,59 @@ import { ChartAuthoringPages } from '../../interfaces';
 
 /** @private */
 export declare class ArcgisChartsConfigBarChart extends LitElement {
+    /**
+     * Bar Chart Model.
+     *
+     * @type {BarChartModel}
+     * @category Public
+     * @default undefined
+     */
     model: BarChartModel;
+    /**
+     * Custom time zone for the chart.
+     *
+     * @type {MapView["timeZone"] | undefined}
+     * @category Public
+     * @default undefined
+     */
     timeZone?: MapView["timeZone"];
+    /**
+     * Popover placement use it from the viewer to place the popover.
+     *
+     * @category Public
+     * @default "leading"
+     */
     popoverPlacement: HTMLCalcitePopoverElement["placement"];
+    /**
+     * list of series color
+     *
+     * @category Public
+     */
     seriesColor?: SeriesSymbolsMap;
+    /**
+     * Min/Max bounds computed by the chart
+     *
+     * @category Public
+     */
     calculatedMinMaxBounds?: CalculatedMinMaxBoundsPayload[];
+    /**
+     * Specific page to be opened
+     *
+     * @category Public
+     */
     page?: ChartAuthoringPages;
+    /**
+     * layer instance on which the charts are created or edited.
+     *
+     * @category Public
+     */
     layer?: SupportedLayer;
+    /**
+     * usePopupTemplateFieldsInfo can be set to true to read the fields from layer.popupTemplate
+     *
+     * @category Public
+     * @default false
+     */
     usePopupTemplateFieldsInfo?: boolean;
     readonly arcgisChartsConfigNoSeriesUpdate: TargetedEvent<this, void>;
 }

package/dist/components/arcgis-charts-config-bar-chart/customElement.js

@@ -11,14 +11,14 @@ import "@arcgis/core/rest/support/StatisticDefinition.js";
 import "@arcgis/core/time/TimeExtent.js";
 import "@arcgis/core/core/promiseUtils.js";
 import "@arcgis/core/request.js";
-import { b as d, h as g } from "../../chunks/index4.js";
+import { b as d, h as g } from "../../chunks/index5.js";
 import "@arcgis/toolkit/dom";
 import { LitElement as m, createEvent as f } from "@arcgis/lumina";
 import { css as p, html as a } from "lit";
 import { C as s } from "../../chunks/interfaces2.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.34/esri/copyright.txt for details.
-v4.34.0-next.133 */
+v4.34.0-next.134 */
 const C = p`:host{margin-bottom:var(--arcgis-charts-intra-section-margin);margin-top:var(--arcgis-charts-intra-section-margin);height:100%}`;
 class u extends m {
   constructor() {

package/dist/components/arcgis-charts-config-bar-chart-data/customElement.d.ts

@@ -7,9 +7,25 @@ import { DataChangeErrorPayload } from '../../utils/components/event-payloads';
 
 /** @private */
 export declare class ArcgisChartsConfigBarChartData extends LitElement {
+    /** Overwrite localized strings for this component */
     messageOverrides?: typeof this._messages._overrides;
+    /**
+     * Bar Chart Model.
+     *
+     * @category Public
+     */
     model: BarChartModel;
+    /**
+     * Fields Information of the Feature layer
+     *
+     * @category Public
+     */
     layerFieldsInfo: IField[];
+    /**
+     * When true, the content of the component will be displayed.
+     *
+     * @default false
+     */
     open?: boolean;
     readonly arcgisChartsConfigBarChartDataNumericFieldValidate: TargetedEvent<this, void>;
     readonly arcgisChartsConfigDataChangeError: TargetedEvent<this, DataChangeErrorPayload>;

package/dist/components/arcgis-charts-config-bar-chart-data/customElement.js

@@ -2,7 +2,8 @@ import { c as L } from "../../chunks/runtime.js";
 import { keyed as S } from "lit/directives/keyed.js";
 import "@arcgis/toolkit/intl";
 import { isEqual as $ } from "lodash-es";
-import { d as g, l as I, a as v, W as p, p as b } from "../../chunks/series-types.js";
+import { a as g, i as I, W as p, m as b } from "../../chunks/series-types.js";
+import { a as v } from "../../chunks/rest-js-object-literals.js";
 import { b9 as F, aU as O, aV as k, b as B, cd as y, ce as D, p as A, cx as w, ck as E } from "../../chunks/interfaces.js";
 import "d3-array";
 import "@arcgis/core/geometry/support/jsonUtils.js";
@@ -25,7 +26,7 @@ import { createRef as c, ref as m } from "lit/directives/ref.js";
 import { LitElement as K, createEvent as C, safeClassMap as l, renderElement as j } from "@arcgis/lumina";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.34/esri/copyright.txt for details.
-v4.34.0-next.133 */
+v4.34.0-next.134 */
 const r = {
   label: "label",
   fieldList: "field-list",