@arcgis/map-components 5.0.0-next.98 → 5.0.0-next.99

package/dist/components/arcgis-building-explorer/building-filter/BuildingNumericFilterViewModel.d.ts

@@ -0,0 +1,118 @@
+import { DomainInfo } from '../support/types';
+import { default as Accessor } from '@arcgis/core/core/Accessor.js';
+import { default as Collection } from '@arcgis/core/core/Collection.js';
+import { default as BuildingSceneLayer } from '@arcgis/core/layers/BuildingSceneLayer';
+import { ConstructorProps } from '../../../utils/types';
+type State = "disabled" | "failed" | "loading" | "ready";
+export type BuildingNumericFilterViewModelProperties = ConstructorProps<BuildingNumericFilterViewModel, "allowedValues" | "enabled" | "layers" | "state" | "value"> & {
+    isDefaultViewModel?: boolean;
+};
+/**
+ * Base class for the level filter and the construction phase filter
+ */
+export default abstract class BuildingNumericFilterViewModel extends Accessor {
+    #private;
+    constructor(properties?: BuildingNumericFilterViewModelProperties);
+    protected initialize(): void;
+    destroy(): void;
+    /**
+     * Whether the filter is enabled. If false, the filter's expression won't be
+     * used to filter a {@link module:esri/layers/BuildingSceneLayer}.
+     *
+     * @default false
+     */
+    get enabled(): boolean;
+    set enabled(value: boolean);
+    get value(): number;
+    set value(value: number);
+    /**
+     * The minimum value allowed for the filter.
+     */
+    get min(): nullish | number;
+    /**
+     * The maximum value allowed for the filter.
+     */
+    get max(): nullish | number;
+    get allowedValues(): readonly number[];
+    set allowedValues(value: nullish | readonly number[]);
+    /**
+     * Whether the next value can be selected.
+     */
+    get hasNext(): boolean;
+    /**
+     * Whether the previous value can be selected.
+     */
+    get hasPrevious(): boolean;
+    get layers(): Collection<BuildingSceneLayer>;
+    set layers(value: Collection<BuildingSceneLayer>);
+    private _state;
+    /**
+     * The current state of the view model.
+     */
+    get state(): State;
+    protected set state(value: State);
+    /**
+     * The expressions used to show only components which match this filter.
+     */
+    get filterExpressions(): FilterExpressions;
+    protected _valueBeforeReady?: number;
+    /**
+     * The index of the current value in the list of allowed values or -1 if the
+     * value could not be found (should never happen).
+     */
+    protected get _valueIndex(): number;
+    /**
+     * Map between values allowed for the filter and their respective names. This
+     * is essentially the source of truth for the VM, from which we can extract
+     * the allowed values, compute min/max, get the coded name of a value.
+     */
+    protected _domainInfo: DomainInfo;
+    /**
+     * Selects the specified value for the filter. In case the filter is disabled, this
+     * method also enables it by setting [enabled](#enabled) to `true`.
+     *
+     * @param value - The value which is to be selected.
+     */
+    select(value: number): void;
+    /**
+     * Removes the filter by setting [enabled](#enabled) to `false`.
+     */
+    clear(): void;
+    /**
+     * Selects the next value, if available. If [enabled](#enabled) is `false`,
+     * the first allowed value is selected.
+     */
+    next(): void;
+    /**
+     * Selects the previous value, if available. If [enabled](#enabled) is `false`,
+     * the last allowed value is selected.
+     */
+    previous(): void;
+    /**
+     * If the field that is used for filtering has a coded value domain, the label for the value can
+     * be used to be displayed in a tooltip or in the widget UI. This method returns the label
+     * corresponding to a certain value.
+     *
+     * @param value - A filter value.
+     * @return The label corresponding to the filter value.
+     */
+    getValueLabel(value: number): nullish | string;
+    /**
+     * Called after the layers have been loaded. Here subclasses should collect all
+     * the necessary domains and prepare a valid `DomainInfo`.
+     */
+    protected abstract _setup(): void;
+    private _loadLayers;
+    private _onLayersChange;
+}
+export interface FilterExpressions {
+    /**
+     * Expression used to filter components which should be rendered in solid mode.
+     */
+    solid: nullish | string;
+    /**
+     * Expression used to filter components which should be rendered in x-ray mode.
+     */
+    xRay: nullish | string;
+}
+export {};

package/dist/components/arcgis-building-explorer/building-filter/BuildingPhase.d.ts

@@ -0,0 +1,28 @@
+import { FilterExpressions, BuildingNumericFilterViewModelProperties, default as BuildingNumericFilterViewModel } from './BuildingNumericFilterViewModel';
+type BuildingPhaseProperties = BuildingNumericFilterViewModelProperties;
+/**
+ * BuildingPhase provides information for the construction phase filter, such as
+ * the value selected by the user or the minimum and maximum allowed values.
+ * Construction phases are used to track site development for a [`BuildingSceneLayer`](https://next.gha.afd.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html).
+ * Setting a construction phase in the [`BuildingExplorer`](https://next.gha.afd.arcgis.com/javascript/latest/references/map-components/arcgis-building-explorer/) selects everything in the layer which is already constructed
+ * at that phase (created phase <= selected phase) but not yet demolished (demolished phase > selected phase).
+ * The goal is to display what the building or construction site looks like at that selected phase.
+ */
+export default class BuildingPhase extends BuildingNumericFilterViewModel {
+    constructor(properties?: BuildingPhaseProperties);
+    get filterExpressions(): FilterExpressions;
+    private _createdPhaseFieldName?;
+    private _demolishedPhaseFieldName?;
+    get _lastValue(): number;
+    protected _setup(): void;
+    /**
+     * Parses the `filterExpression`s in the specified filter to try and determine
+     * the phase used to create the filter. This value can then be used to restore
+     * the UI to the correct state.
+     *
+     * @param filter
+     *    The filter whose expressions are to be parsed.
+     */
+    private _parseValueFromFilter;
+}
+export {};

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

@@ -1,34 +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, "label" | "headingLevel" | "viewModel" | "icon" | "layers"> & {
-    state?: unknown;
-    viewModel?: import('@arcgis/core/widgets/BuildingExplorer/BuildingExplorerViewModel').default | 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
-        /** @copyDoc */
-        ?: __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.
  *
@@ -37,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 Building Explorer component will be associated with a map or scene component rather than using the `view` property.
      */
-    view?: import('@arcgis/core/views/SceneView').default | null | undefined;
+    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
@@ -60,67 +94,39 @@ export declare class ArcgisBuildingExplorer extends LitElement {
      * Indicates the heading level to use for the component title.
      *
      * @default 3
-     * @since 4.20
-     * @see [Heading Elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements)
-     * @example buildingExplorer.headingLevel = 4;
-     */
-    headingLevel: import('@arcgis/core/widgets/support/types').HeadingLevel;
-    /**
-     * When set to `false`, the disciplines and categories sublayer list is not displayed.
-     *
-     * @default true
-     */
-    hideDisciplines: boolean | undefined;
-    /**
-     * When set to `false`, the building levels filter is not displayed.
-     *
-     * @default true
      */
-    hideLevels: boolean | undefined;
-    /**
-     * When set to `false`, the construction phases filter is not displayed.
-     *
-     * @default true
-     */
-    hidePhases: boolean | undefined;
+    headingLevel: HeadingLevel;
+    /** @default false */
+    hideDisciplines: boolean;
+    /** @default false */
+    hideLevels: boolean;
+    /** @default false */
+    hidePhases: boolean;
     /**
      * Icon which represents the component.
      * Typically used when the component is controlled by another component (e.g. by the Expand component).
      *
      * @default "organization"
-     * @since 4.27
-     * @see [Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)
-     * @see [Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)
      * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
      */
-    get icon(): typeof this.widget.icon;
-    set icon(value: IconName);
+    icon: IconName;
+    /** The component's default label. */
+    label?: string;
     /**
-     * The component's default label.
-     *
-     * @since 4.11
-     */
-    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: import('@arcgis/core/core/Collection').default<import('@arcgis/core/layers/BuildingSceneLayer').default>;
-    /**
-     * 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.
-     */
-    readonly level: import('@arcgis/core/widgets/BuildingExplorer/BuildingLevel').default;
-    /**
-     * 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.
-     */
-    readonly phase: import('@arcgis/core/widgets/BuildingExplorer/BuildingPhase').default;
+    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;
     /**
@@ -129,28 +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: "disabled" | "ready" | "loading" | "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>;
-    private widget: BuildingExplorer;
     readonly _setterTypes: {
-        icon?: IconName;
+        level?: number | undefined;
+        phase?: number | undefined;
+        levels?: readonly number[] | undefined;
+        phases?: readonly number[] | undefined;
     };
 }
 export {};