@arcgis/map-components
Version:
ArcGIS Map Components
126 lines (124 loc) • 6.1 kB
TypeScript
/// <reference types="@arcgis/core/interfaces.d.ts" />
/// <reference types="../../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 { ArcgisReferenceElement } from '../../utils/component-utils';
declare const useBuildingExplorerWidget: (component: LitElement & Pick<BuildingExplorer, "icon" | "label" | "viewModel" | "headingLevel" | "layers"> & {
state?: unknown;
viewModel?: __esri.BuildingExplorerViewModel | undefined;
closed?: boolean;
icon: import('@arcgis/components-utils').Nil | string;
label: import('@arcgis/components-utils').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;
};
autoDestroyDisabled: boolean;
destroy: () => Promise<void>;
}) => BuildingExplorer;
/**
* 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.
*
* **Known limitations**
*
* 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/)
*/
export declare class ArcgisBuildingExplorer extends LitElement {
/**
* 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-building-explorer/#destroy) method when you are done to
* prevent memory leaks.
*
* @default false
*/
autoDestroyDisabled: boolean;
/**
* Indicates the heading level to use for the component title.
*
* @default 3
*/
headingLevel: number;
/** @default false */
hideDisciplines: boolean | undefined;
/** @default false */
hideLevels: boolean | undefined;
/** @default false */
hidePhases: boolean | undefined;
/**
* Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).
*
* See also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
*
* @default "organization"
*/
icon: string;
/** The component's default label. */
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.
*
* [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;
/** @default "bottom-left" */
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.
*
* @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";
}>;
/** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
readonly arcgisReady: TargetedEvent<this, void>;
}
export {};