@arcgis/map-components
Version:
ArcGIS Map Components
87 lines (85 loc) • 3.97 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 TimeSlider } from '@arcgis/core/widgets/TimeSlider.js';
import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
import { ArcgisReferenceElement } from '../../utils/component-utils';
declare const useTimeSliderWidget: (component: import('@arcgis/components-controllers').StencilLifecycles & {
manager: import('@arcgis/components-controllers').ControllerManager;
el: HTMLElement;
autoDestroyDisabled?: boolean;
destroy?: () => Promise<void>;
} & Pick<TimeSlider, never> & {
reactiveUtils?: typeof __esri.reactiveUtils;
state?: unknown;
viewModel?: __esri.TimeSliderViewModel | 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.widgetsTimeSliderProperties | undefined): __esri.widgetsTimeSliderProperties | Promise<__esri.widgetsTimeSliderProperties | undefined> | undefined;
} | undefined) => TimeSlider;
/** The Time Slider component simplifies visualization of temporal data in your application.
*/
export declare class ArcgisTimeSlider extends LitElement {
actions: __esri.Collection<__esri.Action>;
/**
* 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;
disabled: boolean;
readonly effectiveStops: nullish | Date[];
fullTimeExtent: nullish | __esri.TimeExtent;
/**
* 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;
layout: "auto" | "compact" | "wide";
loop: boolean;
mode: "instant" | "time-window" | "cumulative-from-start" | "cumulative-from-end";
playRate: number;
position: __esri.UIPosition;
referenceElement: ArcgisReferenceElement | Nil | string;
readonly state: "ready" | "disabled" | "playing";
stops: nullish | __esri.StopsByDates | __esri.StopsByCount | __esri.StopsByInterval;
tickConfigs: nullish | __esri.TickConfig[];
timeExtent: nullish | __esri.TimeExtent;
timeVisible: boolean;
timeZone: string;
applyTimeSliderSettings(settings: Pick<__esri.TimeSliderProperties, "fullTimeExtent" | "loop" | "stops">): Promise<void>;
/** Permanently destroy the component */
destroy(): Promise<void>;
next(): Promise<void>;
play(): Promise<void>;
previous(): Promise<void>;
stop(): Promise<void>;
updateWebDocument(webmap: __esri.WebMap): Promise<void>;
readonly arcgisPropertyChange: TargetedEvent<this, {
name: "timeExtent" | "state" | "effectiveStops" | "fullTimeExtent";
}>;
readonly arcgisReady: TargetedEvent<this, undefined>;
readonly arcgisTriggerAction: TargetedEvent<this, __esri.TimeSliderTriggerActionEvent>;
}
export {};