@arcgis/map-components
Version:
ArcGIS Map Components
106 lines (104 loc) • 4.54 kB
TypeScript
/// <reference types="@arcgis/core/interfaces.d.ts" />
/// <reference types="../../index.d.ts" />
import { Use } from '@arcgis/lumina/controllers';
import { default as FloorFilter } from '@arcgis/core/widgets/FloorFilter.js';
import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
import { ArcgisReferenceElement } from '../../utils/component-utils';
declare const useFloorFilterWidget: (component: LitElement & Pick<FloorFilter, "icon" | "label" | "viewModel" | "headingLevel" | "facility" | "level" | "longNames" | "site"> & {
state?: unknown;
viewModel?: __esri.FloorFilterViewModel | 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?: __esri.LinkChartView | __esri.MapView | __esri.SceneView;
};
autoDestroyDisabled: boolean;
destroy: () => Promise<void>;
}) => FloorFilter;
/**
* The Floor Filter component simplifies visualization of GIS data for a specific floor of a building in your application.
*
* [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-floor-filter/)
*/
export declare class ArcgisFloorFilter 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-floor-filter/#destroy) method when you are done to
* prevent memory leaks.
*
* @default false
*/
autoDestroyDisabled: boolean;
/**
* The currently selected facility.
*
* [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#facility)
*/
facility: string | nullish;
/**
* Indicates the heading level to use for the headings separating floors in buildings.
*
* @default 2
*/
headingLevel: number;
/**
* 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 "floor-plan"
*/
icon: string;
/**
* The widget's label.
*
* [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)
*/
label: string | nullish;
/**
* The currently selected floor level.
*
* [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#level)
*/
level: string | nullish;
/**
* Determines if the widget is expanded or collapsed.
*
* [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#longNames)
*
* @default false
*/
longNames: boolean;
/** @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 currently selected site.
*
* [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#site)
*/
site: string | nullish;
/** Permanently destroy the component. */
destroy(): Promise<void>;
updateWebDocument(webMap: __esri.WebMap): Promise<void>;
/** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
readonly arcgisReady: TargetedEvent<this, void>;
}
export {};