@arcgis/map-components
Version:
ArcGIS Map Components
76 lines (74 loc) • 3.25 kB
TypeScript
/// <reference types="@arcgis/core/interfaces.d.ts" />
/// <reference types="../../index.d.ts" />
import { Use } from '@arcgis/components-controllers';
import { Nil } from '@arcgis/components-utils';
import { default as Legend } from '@arcgis/core/widgets/Legend.js';
import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
import { ArcgisReferenceElement } from '../../utils/component-utils';
declare const useLegendWidget: (component: import('@arcgis/components-controllers').StencilLifecycles & {
manager: import('@arcgis/components-controllers').ControllerManager;
el: HTMLElement;
autoDestroyDisabled?: boolean;
destroy?: () => Promise<void>;
} & Pick<Legend, never> & {
reactiveUtils?: typeof __esri.reactiveUtils;
state?: unknown;
viewModel?: __esri.LegendViewModel | undefined;
icon: Nil | string;
label: Nil | string;
referenceElement: ArcgisReferenceElement | Nil | string;
position: __esri.UIPosition;
arcgisReady: import('@arcgis/components-controllers').EventEmitter;
arcgisPropertyChange: import('@arcgis/components-controllers').EventEmitter<{
name: string;
}> | undefined;
el: HTMLElement & {
childElem?: HTMLElement & {
ownedBy?: HTMLElement;
};
view?: __esri.MapView | __esri.SceneView | Nil;
};
autoDestroyDisabled: boolean;
destroy: () => Promise<void>;
}, options?: {
editConstructorProperties(props: __esri.LegendProperties | undefined): __esri.LegendProperties | Promise<__esri.LegendProperties | undefined> | undefined;
} | undefined) => Legend;
/** The Legend component describes the symbols used to represent layers in a map.
*/
export declare class ArcgisLegend extends LitElement {
activeLayerInfos: __esri.Collection<__esri.ActiveLayerInfo>;
/**
* 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\` method when you are done to prevent
* memory leaks.
*/
autoDestroyDisabled: boolean;
basemapLegendVisible: boolean;
headingLevel: number;
hideLayersNotInCurrentView: boolean;
/**
* Icon which represents the component.
* Typically used when the component is controlled by another component (e.g. by the Expand component).
* Search [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.
*/
icon: string;
/** The component's default label. */
label: string;
layerInfos: __esri.LegendLayerInfos[];
legendStyle: string | __esri.LegendStyle;
position: __esri.UIPosition;
referenceElement: ArcgisReferenceElement | Nil | string;
respectLayerDefinitionExpression: boolean;
/** @default false */
respectLayerVisibilityDisabled: boolean;
readonly state: "ready" | "disabled";
/** Permanently destroy the component */
destroy(): Promise<void>;
readonly arcgisPropertyChange: TargetedEvent<this, {
name: "state";
}>;
readonly arcgisReady: TargetedEvent<this, undefined>;
}
export {};