@arcgis/map-components 5.0.0-next.1 → 5.0.0-next.100

package/dist/components/arcgis-building-explorer/customElement.d.ts

@@ -1,31 +1,70 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference path="../../index.d.ts" />
 import { Use } from '@arcgis/lumina/controllers';
-import { default as BuildingExplorer } from '@arcgis/core/widgets/BuildingExplorer.js';
-import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
+import { PublicLitElement as LitElement, JsxNode, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
+import { IconName } from '../../utils/action-utils';
+import { useView } from '../../controllers/useView';
+import { HeadingLevel } from '../../support/heading';
+import { default as SceneView } from '@arcgis/core/views/SceneView.js';
+import { default as BuildingSceneLayer } from '@arcgis/core/layers/BuildingSceneLayer.js';
 
-declare const useBuildingExplorerWidget: (component: LitElement & Pick<BuildingExplorer, "icon" | "label" | "layers" | "viewModel" | "headingLevel"> & {
-    state?: unknown;
-    viewModel?: __esri.BuildingExplorerViewModel | undefined;
-    closed?: boolean;
-    icon: import('@arcgis/toolkit/type').nil | string;
-    label: import('@arcgis/toolkit/type').nil | string;
-    referenceElement?: ArcgisReferenceElement | string;
-    position?: __esri.UIPosition;
-    arcgisReady: import('@arcgis/lumina').EventEmitter;
-    arcgisPropertyChange: import('@arcgis/lumina').EventEmitter<{
-        name: string;
-    }> | undefined;
-    el: HTMLElement & {
-        childElem?: HTMLElement & {
-            ownedBy?: HTMLElement;
-        };
-        view?: __esri.LinkChartView | __esri.MapView | __esri.SceneView | nullish;
+declare const messages: (value: {
+    level: {
+        title: string;
+        selectLevel: string;
+        clearLevel: string;
+        nextLevel: string;
+        previousLevel: string;
+        currentLevel: string;
     };
-    autoDestroyDisabled: boolean;
-    destroy: () => Promise<void>;
-}) => BuildingExplorer;
+    phase: {
+        title: string;
+        nextPhase: string;
+        previousPhase: string;
+        currentPhase: string;
+    };
+    disciplines: {
+        title: string;
+        expand: string;
+        collapse: string;
+        hideSublayer: string;
+        showSublayer: string;
+    };
+    failed: string;
+    unsupported: string;
+    noData: string;
+    componentLabel: string;
+    loading: string;
+}) => {
+    level: {
+        title: string;
+        selectLevel: string;
+        clearLevel: string;
+        nextLevel: string;
+        previousLevel: string;
+        currentLevel: string;
+    };
+    phase: {
+        title: string;
+        nextPhase: string;
+        previousPhase: string;
+        currentPhase: string;
+    };
+    disciplines: {
+        title: string;
+        expand: string;
+        collapse: string;
+        hideSublayer: string;
+        showSublayer: string;
+    };
+    failed: string;
+    unsupported: string;
+    noData: string;
+    componentLabel: string;
+    loading: string;
+};
+export type Messages = ReturnType<typeof messages>;
 /**
  * The Building Explorer component is used to filter and explore the various components of [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html). BuildingSceneLayers are complex digital models of buildings and interiors and can contain thousands of components grouped in sublayers. Using this component, buildings can be filtered by level, construction phase or by disciplines and categories.
  *
@@ -34,15 +73,13 @@ declare const useBuildingExplorerWidget: (component: LitElement & Pick<BuildingE
  * Building Explorer is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.
  *
  * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-building-explorer/)
- *
- * @since 4.28
  */
 export declare class ArcgisBuildingExplorer 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 ArcgisBuildingExplorer 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 Building Explorer component will be associated with a map or scene component rather than using the `view` property.
      */
-    view?: __esri.SceneView | nullish;
+    view?: SceneView;
     /**
      * 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
@@ -58,48 +95,39 @@ export declare class ArcgisBuildingExplorer extends LitElement {
      *
      * @default 3
      */
-    headingLevel: number;
+    headingLevel: HeadingLevel;
     /** @default false */
-    hideDisciplines: boolean | undefined;
+    hideDisciplines: boolean;
     /** @default false */
-    hideLevels: boolean | undefined;
+    hideLevels: boolean;
     /** @default false */
-    hidePhases: boolean | undefined;
+    hidePhases: boolean;
     /**
      * 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 "organization"
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
      */
-    icon: string;
+    icon: IconName;
     /** The component's default label. */
-    label: string;
+    label?: string;
     /**
-     * A [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html)
-     * of layers of type [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html)
-     * that are added to the componen for exploration.
+     * An array of layers of type [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html) that are added to the component for exploration.
      *
      * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#layers)
      */
-    layers: __esri.Collection<__esri.BuildingSceneLayer>;
-    /**
-     * Contains information about the level filter, such as
-     * the value selected by the user in the Level element
-     * or the minimum and maximum allowed values.
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingExplorerViewModel.html#level)
-     */
-    readonly level: __esri.BuildingLevel;
-    /**
-     * Contains information about the construction phase filter, such as
-     * the value selected by the user in the Construction phases element
-     * and the minimum and maximum allowed values.
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingExplorerViewModel.html#phase)
-     */
-    readonly phase: __esri.BuildingPhase;
-    /** @deprecated since 4.34, use [`slot`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/slot) instead. */
+    get layers(): BuildingSceneLayer[];
+    set layers(layers: BuildingSceneLayer[]);
+    get level(): number;
+    set level(value: number | undefined);
+    get phase(): number;
+    set phase(value: number | undefined);
+    get levels(): readonly number[];
+    set levels(values: readonly number[] | undefined);
+    get phases(): readonly number[];
+    set phases(values: readonly number[] | undefined);
+    /** @deprecated since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) 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.
@@ -107,24 +135,19 @@ export declare class ArcgisBuildingExplorer extends LitElement {
      * @see [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 component's state. The values mean the following:
-     *
-     * * `disabled` -  	component is being created
-     * * `loading` - layers and statistics are loading
-     * * `ready` - component is ready
-     * * `failed` - component failed to load data
-     *
-     * @default "disabled"
-     */
-    readonly state: "ready" | "loading" | "disabled" | "failed";
     /** Permanently destroy the component. */
     destroy(): 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" | "level" | "phase";
+        name: "level" | "phase";
     }>;
     /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, void>;
+    readonly _setterTypes: {
+        level?: number | undefined;
+        phase?: number | undefined;
+        levels?: readonly number[] | undefined;
+        phases?: readonly number[] | undefined;
+    };
 }
 export {};