@arcgis/map-components
Version:
ArcGIS Map Components
86 lines (84 loc) • 4 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 ElevationProfile } from '@arcgis/core/widgets/ElevationProfile.js';
import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
import { ArcgisReferenceElement } from '../../utils/component-utils';
declare const useElevationProfileWidget: (component: import('@arcgis/components-controllers').StencilLifecycles & {
manager: import('@arcgis/components-controllers').ControllerManager;
el: HTMLElement;
autoDestroyDisabled?: boolean;
destroy?: () => Promise<void>;
} & Pick<ElevationProfile, never> & {
reactiveUtils?: typeof __esri.reactiveUtils;
state?: unknown;
viewModel?: __esri.ElevationProfileViewModel | 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.ElevationProfileProperties | undefined): __esri.ElevationProfileProperties | Promise<__esri.ElevationProfileProperties | undefined> | undefined;
} | undefined) => ElevationProfile;
/** The Elevation Profile component is used to generate and display an elevation profile from an [input line graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input).
*/
export declare class ArcgisElevationProfile 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\` method when you are done to prevent
* memory leaks.
*/
autoDestroyDisabled: boolean;
readonly effectiveUnits: __esri.EffectiveUnits;
hideChart: boolean;
hideClearButton: boolean;
hideLegend: boolean;
hideSelectButton: boolean;
hideSettingsButton: boolean;
hideSketchButton: boolean;
hideUniformChartScalingToggle: boolean;
hideUnitSelector: boolean;
highlightEnabled: boolean;
hoveredChartPosition: number | nullish;
/**
* 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;
input: nullish | __esri.Graphic;
/** The component's default label. */
label: string;
position: __esri.UIPosition;
profiles: __esri.Collection<__esri.ElevationProfileLineGround | __esri.ElevationProfileLineInput | __esri.ElevationProfileLineQuery | __esri.ElevationProfileLineView>;
readonly progress: number;
referenceElement: ArcgisReferenceElement | Nil | string;
readonly state: "ready" | "selected" | "disabled" | "creating" | "created" | "selecting";
uniformChartScaling: boolean;
unit: __esri.SystemOrLengthUnit;
unitOptions: __esri.SystemOrLengthUnit[];
/** Permanently destroy the component */
destroy(): Promise<void>;
start(): Promise<void>;
stop(): Promise<void>;
readonly arcgisPropertyChange: TargetedEvent<this, {
name: "input" | "state" | "progress" | "effectiveUnits";
}>;
readonly arcgisReady: TargetedEvent<this, undefined>;
}
export {};