@arcgis/map-components 5.0.0-next.13 → 5.0.0-next.131

package/dist/components/arcgis-link-chart-nonspatial-visibility-toggle/customElement.d.ts

@@ -0,0 +1,86 @@
+/// <reference path="../../index.d.ts" />
+import { ArcgisReferenceElement } from '../../utils/component-utils';
+import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
+import { IconName } from '../../utils/action-utils';
+import { default as LinkChartView } from '@arcgis/core/views/LinkChartView';
+
+type State = "disabled" | "ready";
+type NonspatialMode = "hidden" | "visible";
+/**
+ * The <link-chart-nonspatial-visibility-toggle> component is for use in link charts that allows users to switch whether or not nonspatial data is visible in the view.  Spatial entities are those with a value in a defined geometry property in a traditional map context.  A Spatial relataionship is one where both endpoints are spatial
+ *
+ * Note: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart-nonspatial-visibility-toggle/)
+ *
+ * @since 5.0
+ */
+export declare class ArcgisLinkChartNonspatialVisibilityToggle extends LitElement {
+    /**
+     * The view associated with the component.
+     *   > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Link Chart Nonspatial Visibility Toggle component will be associated with a map or scene component rather than using the `view` property.
+     */
+    view?: LinkChartView;
+    /**
+     * If true, the component will not be destroyed automatically when it is
+     * disconnected from the document. This is useful when you want to move the
+     * component to a different place on the page, or temporarily hide it. If this
+     * is set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart-nonspatial-visibility-toggle/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
+     */
+    autoDestroyDisabled: boolean;
+    icon?: IconName;
+    /** The component's default label. */
+    label?: string;
+    /**
+     * Replace localized message strings with your own strings.
+     *
+     * _**Note**: Individual message keys may change between releases._
+     */
+    messageOverrides?: typeof this.messages._overrides;
+    /**
+     * By assigning the `id` attribute of the LinkChart component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the LinkChart.
+     *
+     * See also:
+     * - [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
+     */
+    referenceElement?: ArcgisReferenceElement | string;
+    /**
+     * The current state of the component.
+     *
+     * @default "loading"
+     */
+    get state(): State;
+    /** @default "m" */
+    visualScale: "l" | "m" | "s";
+    /** Permanently destroy the component. */
+    destroy(): Promise<void>;
+    /**
+     * Switches the nonspatial visility setting
+     *
+     * @param nonspatialVisibilitySetting
+     */
+    switchNonspatialVisibility(nonspatialVisibilitySetting: NonspatialMode): Promise<void>;
+    /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
+    readonly arcgisPropertyChange: TargetedEvent<this, {
+        name: "state";
+    }>;
+    /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
+    readonly arcgisReady: TargetedEvent<this, void>;
+    private messages: Partial<{
+        toggleLabel: string;
+    }> & import('@arcgis/lumina/controllers').T9nMeta<{
+        toggleLabel: string;
+    }>;
+    "@eventTypes": {
+        "arcgisPropertyChange": ArcgisLinkChartNonspatialVisibilityToggle["arcgisPropertyChange"]["detail"];
+        "arcgisReady": ArcgisLinkChartNonspatialVisibilityToggle["arcgisReady"]["detail"];
+    };
+}
+export declare const exportsForTests: {
+    changeNonspatialDataDisplay: (view: LinkChartView, mode: "hidden" | "visible") => void;
+    useView: (component: ArcgisLinkChartNonspatialVisibilityToggle) => LinkChartView | undefined;
+};
+export {};

package/dist/components/arcgis-link-chart-nonspatial-visibility-toggle/customElement.js

@@ -0,0 +1,57 @@
+import { c as o } from "../../chunks/runtime.js";
+import { html as n } from "lit";
+import { usePropertyChange as r } from "@arcgis/lumina/controllers";
+import { u as l } from "../../chunks/useT9n.js";
+import { LitElement as h, createEvent as c, nothing as p } from "@arcgis/lumina";
+import { u as m } from "../../chunks/useView.js";
+import { log as d } from "@arcgis/toolkit/log";
+import { when as g } from "@arcgis/core/core/reactiveUtils.js";
+/*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
+See https://js.arcgis.com/5.0/esri/copyright.txt for details.
+v5.0.0-next.131 */
+const a = (i) => i === "hidden" ? "hide-link-chart-nonspatial-data" : "show-link-chart-nonspatial-data";
+class y extends h {
+  constructor() {
+    super(...arguments), this.messages = l(), this._state = "disabled", this.view = s.useView(this), this.autoDestroyDisabled = !1, this.icon = a(this.view?.map.linkChartProperties.nonspatialDataDisplay?.mode), this.visualScale = "m", this.arcgisPropertyChange = r()("state"), this.arcgisReady = c();
+  }
+  static {
+    this.properties = { _state: 16, view: 0, autoDestroyDisabled: 5, icon: 0, label: 1, messageOverrides: 0, referenceElement: 1, state: 32, visualScale: 1 };
+  }
+  get state() {
+    return this._state;
+  }
+  async destroy() {
+    await this.manager.destroy();
+  }
+  async switchNonspatialVisibility(t) {
+    this.view && (s.changeNonspatialDataDisplay(this.view, t), this.icon = a(t));
+  }
+  loaded() {
+    this.manager.onLifecycle(() => [
+      g(() => this.view?.ready ? "ready" : "disabled", (t) => {
+        this._state = t, this.icon = a(this.view?.map.linkChartProperties.nonspatialDataDisplay?.mode);
+      }, { sync: !0, initial: !0 })
+    ]);
+  }
+  _handleToggle() {
+    const e = this.view?.map.linkChartProperties.nonspatialDataDisplay?.mode === "hidden" ? "visible" : "hidden";
+    this.switchNonspatialVisibility(e);
+  }
+  render() {
+    const { messages: t } = this;
+    return this.state === "ready" && this.view?.map.mapType !== "webLinkChart" && d("error", this, "The <arcgis-link-chart-nonspatial-visibility-toggle> component must be used with an <arcgis-link-chart> component to provide the view"), n`<calcite-action .scale=${this.visualScale} .icon=${this.icon} @click=${this._handleToggle} @keyup=${(e) => {
+      e.key === "Enter" && this._handleToggle();
+    }} .disabled=${this.view?.map.mapType !== "webLinkChart"} .text=${t.toggleLabel} title=${t.toggleLabel ?? p} data-testid=link-chart-nonspatial-visibility-toggle-action></calcite-action>`;
+  }
+}
+const s = {
+  changeNonspatialDataDisplay: (i, t) => {
+    i.map.changeNonspatialDataDisplay(t);
+  },
+  useView: (i) => m(i)
+};
+o("arcgis-link-chart-nonspatial-visibility-toggle", y);
+export {
+  y as ArcgisLinkChartNonspatialVisibilityToggle,
+  s as exportsForTests
+};

package/dist/components/arcgis-link-chart-nonspatial-visibility-toggle/index.d.ts

@@ -0,0 +1,2 @@
+import "@esri/calcite-components/components/calcite-action";
+export * from "./customElement.js";

package/dist/components/arcgis-link-chart-nonspatial-visibility-toggle/index.js

@@ -0,0 +1,2 @@
+import "@esri/calcite-components/components/calcite-action";
+export * from "./customElement.js";

package/dist/components/arcgis-locate/customElement.d.ts

@@ -1,9 +1,9 @@
-/// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference path="../../index.d.ts" />
 import { Use } from '@arcgis/lumina/controllers';
 import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
 import { default as LocateViewModel } from './LocateViewModel';
+import { IconName } from '../../utils/action-utils';
 
 declare const useLocateViewModel: (component: LitElement & Pick<LocateViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<LocateViewModel>) => LocateViewModel;
 /**
@@ -20,9 +20,9 @@ declare const useLocateViewModel: (component: LitElement & Pick<LocateViewModel,
 export declare class ArcgisLocate extends LitElement {
     /**
      * The view associated with the component.
-     *   > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the ArcgisLocate component will be associated with a map or scene component rather than using the `view` property.
+     *   > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Locate component will be associated with a map or scene component rather than using the `view` property.
      */
-    view?: __esri.MapView | __esri.SceneView | undefined;
+    view?: import('@arcgis/core/views/MapView').default | import('@arcgis/core/views/SceneView').default | undefined;
     /**
      * If true, the component will not be destroyed automatically when it is
      * disconnected from the document. This is useful when you want to move the
@@ -40,17 +40,17 @@ export declare class ArcgisLocate extends LitElement {
      * @default false
      */
     goToLocationDisabled: boolean;
-    goToOverride: __esri.GoToOverride | undefined;
+    goToOverride: import('@arcgis/core/widgets/support/types').GoToOverride | undefined;
     /** The graphic used to show the user's location on the map. */
-    graphic: __esri.Graphic;
+    graphic: import('@arcgis/core/Graphic').default;
     /**
      * Icon which represents the component.
      * Typically used when the component is controlled by another component (e.g. by the Expand component).
      *
-     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
      * @default "gps-off"
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
      */
-    icon?: string | undefined;
+    icon?: IconName;
     /** The component's default label. */
     label?: string;
     /**
@@ -61,8 +61,6 @@ export declare class ArcgisLocate extends LitElement {
     messageOverrides?: typeof this.messages._overrides;
     /** @default false */
     popupDisabled: boolean;
-    /** @deprecated since 4.34, use `slot` instead. */
-    position?: __esri.UIPosition;
     /**
      * By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
      *
@@ -77,7 +75,14 @@ export declare class ArcgisLocate extends LitElement {
      */
     scale: number | undefined;
     /** The current state of the component. */
-    state: "ready" | "disabled" | "error" | "feature-unsupported" | "locating";
+    readonly state: "error" | "disabled" | "ready" | "feature-unsupported" | "locating";
+    /**
+     * Specifies the size of the component.
+     *
+     * @default "m"
+     * @since 5.0
+     */
+    visualScale: HTMLCalciteButtonElement["scale"];
     /**
      * This function provides the ability to interrupt and cancel the process of
      * programmatically obtaining the location of the user's device.
@@ -131,5 +136,11 @@ export declare class ArcgisLocate extends LitElement {
         positionUnavailable: string;
         cancel: string;
     }>;
+    "@eventTypes": {
+        "arcgisError": ArcgisLocate["arcgisError"]["detail"];
+        "arcgisPropertyChange": ArcgisLocate["arcgisPropertyChange"]["detail"];
+        "arcgisReady": ArcgisLocate["arcgisReady"]["detail"];
+        "arcgisSuccess": ArcgisLocate["arcgisSuccess"]["detail"];
+    };
 }
 export {};