type HashMap = Record; type GroupKey = Exclude; interface IHandle { remove(): void; } interface __esriImplementsIteration { [Symbol.iterator](): IterableIterator; } declare namespace __esri { export class Accessor { destroyed: boolean; initialized: boolean; declaredClass: string; constructor(obj?: any); destroy(): void; get(propertyName: string): T; get(propertyName: string): any; set(propertyName: string, value: T): this; set(props: HashMap): this; watch(path: string | string[], callback: WatchCallback, sync?: boolean): WatchHandle; addHandles(handles: IHandle | IHandle[], groupKey?: GroupKey): void; removeHandles(groupKey?: GroupKey): void; hasHandles(groupKey?: GroupKey): boolean; protected notifyChange(propertyName: string): void; protected _get(propertyName: string): any; protected _get(propertyName: string): T; protected _set(propertyName: string, value: T): this; } export interface AnonymousAccessor { get?(propertyName: string): T; get?(propertyName: string): any; set?(propertyName: string, value: T): this; set?(props: HashMap): this; watch?(path: string | string[], callback: WatchCallback, sync?: boolean): WatchHandle; } export type ItemCallback = (item: T, index: number) => void; export type ItemCompareCallback = (firstItem: T, secondItem: T) => number; export type ItemMapCallback = (item: T, index: number) => R; export type ItemReduceCallback = (previousValue: R, currentValue: T, index: number) => R; export type ItemTestCallback = (item: T, index: number) => boolean; export type CollectionAfterAddEventHandler = (event: CollectionAfterItemEvent) => void; export type CollectionAfterChangesEventHandler = (event: CollectionAfterEvent) => void; export type CollectionAfterRemoveEventHandler = (event: CollectionAfterItemEvent) => void; export type CollectionChangeEventHandler = (event: CollectionChangeEvent) => void; export type CollectionBeforeAddEventHandler = (event: CollectionItemEvent) => void; export type CollectionBeforeChangesEventHandler = (event: CollectionEvent) => void; export type CollectionBeforeRemoveEventHandler = (event: CollectionItemEvent) => void; export interface CollectionEvent { defaultPrevented: boolean; cancellable: boolean; preventDefault(): void; } export interface CollectionItemEvent extends CollectionEvent { item: T; } export interface CollectionAfterEvent { } export interface CollectionAfterItemEvent { item: T; } export interface CollectionChangeEvent { added: T[]; removed: T[]; moved: T[]; } interface Collection extends Evented, __esriImplementsIteration { on(type: "after-add", listener: CollectionAfterAddEventHandler): IHandle; on(type: "after-changes", listener: CollectionAfterChangesEventHandler): IHandle; on(type: "after-remove", listener: CollectionAfterRemoveEventHandler): IHandle; on(type: "before-add", listener: CollectionBeforeAddEventHandler): IHandle; on(type: "before-changes", listener: CollectionBeforeChangesEventHandler): IHandle; on(type: "before-remove", listener: CollectionBeforeRemoveEventHandler): IHandle; on(type: "change", listener: CollectionChangeEventHandler): IHandle; on(type: string, listener: (event: any) => void): IHandle; } type Constructor = new (...params: any[]) => T; interface Types { key: string | ((obj: any) => string); base: Constructor | Function; typeMap: HashMap>; } export class Collection extends Accessor { readonly length: number; constructor(values?: any[] | Collection | CollectionPropertiesBase); at(index: number): T; add(item: T, index?: number): this; addMany(items: T[] | Collection, index?: number): this; clone(): Collection; concat(value: T[] | Collection): Collection; every(callback: ItemTestCallback): boolean; filter(callback: ItemTestCallback): Collection; filter(callback: (item: T, index: number) => item is S): Collection; find(callback: ItemTestCallback): T; findIndex(callback: ItemTestCallback): number; flatten(callback: (item: T, index: number) => T[] | Collection): Collection; flatten(callback: (item: U, index: number) => U[] | Collection): Collection; forEach(callback: ItemCallback): void; getItemAt(index: number): T; includes(searchElement: T): boolean; indexOf(searchElement: T, fromIndex?: number): number; join(separator?: string): string; lastIndexOf(searchElement: T, fromIndex?: number): number; map(callback: ItemMapCallback): Collection; pop(): T; push(item: T): number; reduce(callback: ItemReduceCallback, initialValue?: R): R; reduceRight(callback: ItemReduceCallback, initialValue?: R): R; remove(item: T): void; removeAll(): void; removeAt(index: number): any; removeMany(items: T[] | Collection): T[]; reorder(item: T, index: number): T; reverse(): this; shift(): T; slice(begin?: number, end?: number): Collection; some(callback: ItemCallback): boolean; sort(compareFunction?: ItemCompareCallback): this; splice(start: number, deleteCount: number, ...items: T[]): T[]; toArray(): T[]; unshift(...items: T[]): number; static isCollection(value: any | Collection): value is Collection; static ofType(type: Constructor | Types): new (items?: (T[] | Collection) | { items?: T[] | Collection }) => Collection; } type CollectionProperties = T[] | Collection; interface CollectionPropertiesBase { items?: T[]; } type DateProperties = number | string | Date; interface ReactiveWatchOptions { readonly initial?: boolean; readonly sync?: boolean; readonly once?: boolean; readonly equals?: (newValue: any, oldValue: any) => boolean; } interface ReactiveListenerOptions { sync?: boolean; once?: boolean; onListenerAdd?: (target: Target) => void; onListenerRemove?: (target: Target) => void; } interface reactiveUtils { watch(getValue: () => T, callback: (newValue: T, oldValue: T) => void, options?: ReactiveWatchOptions): IHandle; when(getValue: () => T | null | undefined, callback: (newValue: T, oldValue: T | null) => void, options?: ReactiveWatchOptions): IHandle; on(getTarget: () => T | null | undefined, eventName: string, callback: (value: any) => void, options?: ReactiveListenerOptions): IHandle; once(getValue: () => T, signal?: AbortSignal | { signal?: AbortSignal } | null): Promise; whenOnce(getValue: () => T | null | undefined, signal?: AbortSignal | { signal?: AbortSignal } | null): Promise; } export const reactiveUtils: reactiveUtils; export type BaseDynamicLayerLayerviewCreateErrorEventHandler = ( event: BaseDynamicLayerLayerviewCreateErrorEvent, ) => void; export type BaseDynamicLayerLayerviewCreateEventHandler = (event: BaseDynamicLayerLayerviewCreateEvent) => void; export type BaseDynamicLayerLayerviewDestroyEventHandler = (event: BaseDynamicLayerLayerviewDestroyEvent) => void; export type BaseDynamicLayerRefreshEventHandler = (event: BaseDynamicLayerRefreshEvent) => void; export type BasemapLayerListTriggerActionEventHandler = (event: BasemapLayerListTriggerActionEvent) => void; export type BaseTileLayerLayerviewCreateErrorEventHandler = (event: BaseTileLayerLayerviewCreateErrorEvent) => void; export type BaseTileLayerLayerviewCreateEventHandler = (event: BaseTileLayerLayerviewCreateEvent) => void; export type BaseTileLayerLayerviewDestroyEventHandler = (event: BaseTileLayerLayerviewDestroyEvent) => void; export type BaseTileLayerRefreshEventHandler = (event: BaseTileLayerRefreshEvent) => void; export type BingMapsLayerLayerviewCreateErrorEventHandler = (event: BingMapsLayerLayerviewCreateErrorEvent) => void; export type BingMapsLayerLayerviewCreateEventHandler = (event: BingMapsLayerLayerviewCreateEvent) => void; export type BingMapsLayerLayerviewDestroyEventHandler = (event: BingMapsLayerLayerviewDestroyEvent) => void; export type BingMapsLayerRefreshEventHandler = (event: BingMapsLayerRefreshEvent) => void; export type BookmarksBookmarkEditEventHandler = (event: BookmarksBookmarkEditEvent) => void; export type BookmarksBookmarkSelectEventHandler = (event: BookmarksBookmarkSelectEvent) => void; export type CredentialDestroyEventHandler = (event: CredentialDestroyEvent) => void; export type CredentialTokenChangeEventHandler = (event: CredentialTokenChangeEvent) => void; export type CSVLayerLayerviewCreateErrorEventHandler = (event: CSVLayerLayerviewCreateErrorEvent) => void; export type CSVLayerLayerviewCreateEventHandler = (event: CSVLayerLayerviewCreateEvent) => void; export type CSVLayerLayerviewDestroyEventHandler = (event: CSVLayerLayerviewDestroyEvent) => void; export type CSVLayerRefreshEventHandler = (event: CSVLayerRefreshEvent) => void; export type EditorSketchCreateEventHandler = (event: EditorSketchCreateEvent) => void; export type EditorSketchUpdateEventHandler = (event: EditorSketchUpdateEvent) => void; export type EditorViewModelSketchCreateEventHandler = (event: EditorViewModelSketchCreateEvent) => void; export type EditorViewModelSketchUpdateEventHandler = (event: EditorViewModelSketchUpdateEvent) => void; export type ElevationSamplerChangedEventHandler = (event: ElevationSamplerChangedEvent) => void; export type FeatureFormSubmitEventHandler = (event: FeatureFormSubmitEvent) => void; export type FeatureFormValueChangeEventHandler = (event: FeatureFormValueChangeEvent) => void; export type FeatureFormViewModelSubmitEventHandler = (event: FeatureFormViewModelSubmitEvent) => void; export type FeatureFormViewModelValueChangeEventHandler = (event: FeatureFormViewModelValueChangeEvent) => void; export type FeatureLayerEditsEventHandler = (event: FeatureLayerEditsEvent) => void; export type FeatureLayerLayerviewCreateErrorEventHandler = (event: FeatureLayerLayerviewCreateErrorEvent) => void; export type FeatureLayerLayerviewCreateEventHandler = (event: FeatureLayerLayerviewCreateEvent) => void; export type FeatureLayerLayerviewDestroyEventHandler = (event: FeatureLayerLayerviewDestroyEvent) => void; export type FeatureLayerRefreshEventHandler = (event: FeatureLayerRefreshEvent) => void; export type FeaturesTriggerActionEventHandler = (event: FeaturesTriggerActionEvent) => void; export type FeaturesViewModelTriggerActionEventHandler = (event: FeaturesViewModelTriggerActionEvent) => void; export type FeatureTableSelectionChangeEventHandler = (event: FeatureTableSelectionChangeEvent) => void; export type FeatureTemplatesSelectEventHandler = (event: FeatureTemplatesSelectEvent) => void; export type FeatureTemplatesViewModelSelectEventHandler = (event: FeatureTemplatesViewModelSelectEvent) => void; export type GeoJSONLayerEditsEventHandler = (event: GeoJSONLayerEditsEvent) => void; export type GeoJSONLayerLayerviewCreateErrorEventHandler = (event: GeoJSONLayerLayerviewCreateErrorEvent) => void; export type GeoJSONLayerLayerviewCreateEventHandler = (event: GeoJSONLayerLayerviewCreateEvent) => void; export type GeoJSONLayerLayerviewDestroyEventHandler = (event: GeoJSONLayerLayerviewDestroyEvent) => void; export type GeoJSONLayerRefreshEventHandler = (event: GeoJSONLayerRefreshEvent) => void; export type GeoRSSLayerLayerviewCreateErrorEventHandler = (event: GeoRSSLayerLayerviewCreateErrorEvent) => void; export type GeoRSSLayerLayerviewCreateEventHandler = (event: GeoRSSLayerLayerviewCreateEvent) => void; export type GeoRSSLayerLayerviewDestroyEventHandler = (event: GeoRSSLayerLayerviewDestroyEvent) => void; export type GeoRSSLayerRefreshEventHandler = (event: GeoRSSLayerRefreshEvent) => void; export type HeatmapSliderThumbChangeEventHandler = (event: HeatmapSliderThumbChangeEvent) => void; export type HeatmapSliderThumbDragEventHandler = (event: HeatmapSliderThumbDragEvent) => void; export type HistogramRangeSliderMaxChangeEventHandler = (event: HistogramRangeSliderMaxChangeEvent) => void; export type HistogramRangeSliderMinChangeEventHandler = (event: HistogramRangeSliderMinChangeEvent) => void; export type HistogramRangeSliderSegmentDragEventHandler = (event: HistogramRangeSliderSegmentDragEvent) => void; export type HistogramRangeSliderThumbChangeEventHandler = (event: HistogramRangeSliderThumbChangeEvent) => void; export type HistogramRangeSliderThumbDragEventHandler = (event: HistogramRangeSliderThumbDragEvent) => void; export type HomeGoEventHandler = (event: HomeGoEvent) => void; export type HomeViewModelGoEventHandler = (event: HomeViewModelGoEvent) => void; export type IdentityManagerCredentialCreateEventHandler = (event: IdentityManagerCredentialCreateEvent) => void; export type IdentityManagerDialogCreateEventHandler = (event: IdentityManagerDialogCreateEvent) => void; export type ImageryLayerLayerviewCreateErrorEventHandler = (event: ImageryLayerLayerviewCreateErrorEvent) => void; export type ImageryLayerLayerviewCreateEventHandler = (event: ImageryLayerLayerviewCreateEvent) => void; export type ImageryLayerLayerviewDestroyEventHandler = (event: ImageryLayerLayerviewDestroyEvent) => void; export type ImageryLayerRefreshEventHandler = (event: ImageryLayerRefreshEvent) => void; export type LayerLayerviewCreateErrorEventHandler = (event: LayerLayerviewCreateErrorEvent) => void; export type LayerLayerviewCreateEventHandler = (event: LayerLayerviewCreateEvent) => void; export type LayerLayerviewDestroyEventHandler = (event: LayerLayerviewDestroyEvent) => void; export type LayerListTriggerActionEventHandler = (event: LayerListTriggerActionEvent) => void; export type LayerListViewModelTriggerActionEventHandler = (event: LayerListViewModelTriggerActionEvent) => void; export type LocateLocateErrorEventHandler = (event: LocateLocateErrorEvent) => void; export type LocateLocateEventHandler = (event: LocateLocateEvent) => void; export type LocateViewModelLocateErrorEventHandler = (event: LocateViewModelLocateErrorEvent) => void; export type MapImageLayerLayerviewCreateErrorEventHandler = (event: MapImageLayerLayerviewCreateErrorEvent) => void; export type MapImageLayerLayerviewCreateEventHandler = (event: MapImageLayerLayerviewCreateEvent) => void; export type MapImageLayerLayerviewDestroyEventHandler = (event: MapImageLayerLayerviewDestroyEvent) => void; export type MapImageLayerRefreshEventHandler = (event: MapImageLayerRefreshEvent) => void; export interface AreaMeasurementAnalysis extends Accessor, Clonable { } export class AreaMeasurementAnalysis { /** * Polygon whose area is to be computed and displayed in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-AreaMeasurementAnalysis.html#geometry) */ geometry: Polygon; /** * Unit system (imperial, metric) or specific unit used for displaying the computed area in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-AreaMeasurementAnalysis.html#unit) */ unit: SystemOrAreaUnit; /** * AreaMeasurementAnalysis computes the area of a polygonal region and displays the measurement in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-AreaMeasurementAnalysis.html) */ constructor(properties?: AreaMeasurementAnalysisProperties); } interface AreaMeasurementAnalysisProperties { /** * Polygon whose area is to be computed and displayed in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-AreaMeasurementAnalysis.html#geometry) */ geometry?: PolygonProperties; /** * Unit system (imperial, metric) or specific unit used for displaying the computed area in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-AreaMeasurementAnalysis.html#unit) */ unit?: | "imperial" | "metric" | "square-millimeters" | "square-centimeters" | "square-decimeters" | "square-meters" | "square-kilometers" | "square-inches" | "square-feet" | "square-yards" | "square-miles" | "square-us-feet" | "acres" | "ares" | "hectares"; } export interface DimensionAnalysis extends Accessor, Clonable { } export class DimensionAnalysis { /** * A list of dimensions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DimensionAnalysis.html#dimensions) */ dimensions: Collection; /** * The style defines how the dimension objects of this analysis are displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DimensionAnalysis.html#style) */ style: DimensionSimpleStyle; /** * DimensionAnalysis enables the creation and display of measurement annotations for lengths and distances in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DimensionAnalysis.html) */ constructor(properties?: DimensionAnalysisProperties); } interface DimensionAnalysisProperties { /** * A list of dimensions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DimensionAnalysis.html#dimensions) */ dimensions?: CollectionProperties; /** * The style defines how the dimension objects of this analysis are displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DimensionAnalysis.html#style) */ style?: DimensionSimpleStyleProperties; } export interface DimensionSimpleStyle extends Accessor, Clonable { } export class DimensionSimpleStyle { /** * Color of dimension lines. * * @default black * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DimensionSimpleStyle.html#color) */ color: Color; /** * Size of text in dimension labels in points. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DimensionSimpleStyle.html#fontSize) */ fontSize: number; /** * Width of dimension lines in points. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DimensionSimpleStyle.html#lineSize) */ lineSize: number; /** * Background color of dimension labels. * * @default [255, 255, 255, 0.6] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DimensionSimpleStyle.html#textBackgroundColor) */ textBackgroundColor: Color; /** * Color of text in dimension labels. * * @default black * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DimensionSimpleStyle.html#textColor) */ textColor: Color; readonly type: "simple"; /** * Style that specifies how dimensions and their labels are displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DimensionSimpleStyle.html) */ constructor(properties?: DimensionSimpleStyleProperties); } interface DimensionSimpleStyleProperties { /** * Color of dimension lines. * * @default black * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DimensionSimpleStyle.html#color) */ color?: Color | number[] | string; /** * Size of text in dimension labels in points. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DimensionSimpleStyle.html#fontSize) */ fontSize?: number | string; /** * Width of dimension lines in points. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DimensionSimpleStyle.html#lineSize) */ lineSize?: number | string; /** * Background color of dimension labels. * * @default [255, 255, 255, 0.6] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DimensionSimpleStyle.html#textBackgroundColor) */ textBackgroundColor?: Color | number[] | string; /** * Color of text in dimension labels. * * @default black * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DimensionSimpleStyle.html#textColor) */ textColor?: Color | number[] | string; } export interface DirectLineMeasurementAnalysis extends Accessor, Clonable { } export class DirectLineMeasurementAnalysis { /** * Ending point for the measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html#endPoint) */ endPoint: Point; /** * Starting point for the measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html#startPoint) */ startPoint: Point; /** * Unit system (imperial, metric) or specific unit used for computing the distance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html#unit) */ unit: SystemOrLengthUnit; /** * DirectLineMeasurementAnalysis computes the distance between two points and displays the measurement in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html) */ constructor(properties?: DirectLineMeasurementAnalysisProperties); } interface DirectLineMeasurementAnalysisProperties { /** * Ending point for the measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html#endPoint) */ endPoint?: PointProperties; /** * Starting point for the measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html#startPoint) */ startPoint?: PointProperties; /** * Unit system (imperial, metric) or specific unit used for computing the distance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html#unit) */ unit?: | "imperial" | "metric" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"; } export interface LengthDimension extends Accessor, Clonable { } export class LengthDimension { /** * Ending point for the dimension. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html#endPoint) */ endPoint: Point; /** * The type of length that should be measured between the [startPoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html#startPoint) and [endPoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html#endPoint). * * @default "direct" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html#measureType) */ measureType: "direct" | "horizontal" | "vertical"; /** * Styling option that controls the shortest distance from the [startPoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html#startPoint) or [endPoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html#endPoint) to the dimension line in meters. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html#offset) */ offset: number; /** * The orientation determines the relative direction the dimension line is extended to. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html#orientation) */ orientation: number; /** * Starting point for the dimension. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html#startPoint) */ startPoint: Point; /** * LengthDimension enables the measurement of linear distances between the specified [start](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html#startPoint) and [end](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html#endPoint) points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html) */ constructor(properties?: LengthDimensionProperties); } interface LengthDimensionProperties { /** * Ending point for the dimension. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html#endPoint) */ endPoint?: PointProperties; /** * The type of length that should be measured between the [startPoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html#startPoint) and [endPoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html#endPoint). * * @default "direct" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html#measureType) */ measureType?: "direct" | "horizontal" | "vertical"; /** * Styling option that controls the shortest distance from the [startPoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html#startPoint) or [endPoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html#endPoint) to the dimension line in meters. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html#offset) */ offset?: number; /** * The orientation determines the relative direction the dimension line is extended to. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html#orientation) */ orientation?: number; /** * Starting point for the dimension. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html#startPoint) */ startPoint?: PointProperties; } export interface LineOfSightAnalysis extends Accessor, Clonable { } export class LineOfSightAnalysis { /** * Observer location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html#observer) */ observer: LineOfSightAnalysisObserver; /** * Target locations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html#targets) */ targets: Collection; /** * LineOfSightAnalysis computes the line of sight from a single observer position towards a set of targets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html) */ constructor(properties?: LineOfSightAnalysisProperties); } interface LineOfSightAnalysisProperties { /** * Observer location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html#observer) */ observer?: LineOfSightAnalysisObserverProperties; /** * Target locations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html#targets) */ targets?: CollectionProperties; } export interface LineOfSightAnalysisObserver extends Accessor, Clonable { } export class LineOfSightAnalysisObserver { /** * Specifies how the observer is placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisObserver.html#elevationInfo) */ elevationInfo: LineOfSightAnalysisObserverElevationInfo; /** * Specifies a feature which shall be excluded from intersection testing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisObserver.html#feature) */ feature: Graphic; /** * A [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing the position of the observer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisObserver.html#position) */ position: Point; /** * The LineOfSightAnalysisObserver represents an observer of a [LineOfSightAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisObserver.html) */ constructor(properties?: LineOfSightAnalysisObserverProperties); } interface LineOfSightAnalysisObserverProperties { /** * Specifies how the observer is placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisObserver.html#elevationInfo) */ elevationInfo?: LineOfSightAnalysisObserverElevationInfo; /** * Specifies a feature which shall be excluded from intersection testing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisObserver.html#feature) */ feature?: GraphicProperties; /** * A [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing the position of the observer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisObserver.html#position) */ position?: PointProperties; } export interface LineOfSightAnalysisObserverElevationInfo { /** * Defines how the observer is placed with respect to the terrain surface or 3D objects in the scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisObserver.html#elevationInfo) */ mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; /** * An elevation offset, which is added to the vertical position of the observer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisObserver.html#elevationInfo) */ offset?: number; } export interface LineOfSightAnalysisTarget extends Accessor, Clonable { } export class LineOfSightAnalysisTarget { /** * Specifies how the target is placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisTarget.html#elevationInfo) */ elevationInfo: LineOfSightAnalysisTargetElevationInfo; /** * Specifies a feature which shall be excluded from intersection testing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisTarget.html#feature) */ feature: Graphic; /** * A [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing the position of the target. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisTarget.html#position) */ position: Point; /** * The LineOfSightAnalysisTarget represents a target of a [LineOfSightAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisTarget.html) */ constructor(properties?: LineOfSightAnalysisTargetProperties); } interface LineOfSightAnalysisTargetProperties { /** * Specifies how the target is placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisTarget.html#elevationInfo) */ elevationInfo?: LineOfSightAnalysisTargetElevationInfo; /** * Specifies a feature which shall be excluded from intersection testing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisTarget.html#feature) */ feature?: GraphicProperties; /** * A [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing the position of the target. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisTarget.html#position) */ position?: PointProperties; } export interface LineOfSightAnalysisTargetElevationInfo { /** * Defines how the target is placed with respect to the terrain surface or 3D objects in the scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisTarget.html#elevationInfo) */ mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; /** * An elevation offset, which is added to the vertical position of the target. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisTarget.html#elevationInfo) */ offset?: number; } export interface SliceAnalysis extends Accessor, Clonable { } export class SliceAnalysis { /** * The shape used to slice elements in a 3D scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html#shape) */ shape: SlicePlane; /** * Whether the [shape](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html#shape) supports a tilt angle or not. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html#tiltEnabled) */ tiltEnabled: boolean; readonly type: "slice"; /** * SliceAnalysis can be used to programmatically create a plane that slices through 3D features in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html) */ constructor(properties?: SliceAnalysisProperties); } interface SliceAnalysisProperties { /** * The shape used to slice elements in a 3D scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html#shape) */ shape?: SlicePlaneProperties; /** * Whether the [shape](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html#shape) supports a tilt angle or not. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html#tiltEnabled) */ tiltEnabled?: boolean; } export interface SlicePlane extends Accessor, JSONSupport, Clonable { } export class SlicePlane { /** * The heading angle (in degrees) of the slice plane. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html#heading) */ heading: number; /** * The height of the slice plane. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html#height) */ height: number; /** * A point specifying the position of the center of the plane. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html#position) */ position: Point; /** * The tilt angle (in degrees) of the slice plane. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html#tilt) */ tilt: number; /** * The string value representing the type of the slice shape. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html#type) */ readonly type: "plane"; /** * The width of the slice plane. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html#width) */ width: number; /** * Provides the shape definition of a slice plane for a [Slice](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice.html) widget or [SliceAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html) */ constructor(properties?: SlicePlaneProperties); static fromJSON(json: any): SlicePlane; } interface SlicePlaneProperties { /** * The heading angle (in degrees) of the slice plane. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html#heading) */ heading?: number; /** * The height of the slice plane. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html#height) */ height?: number; /** * A point specifying the position of the center of the plane. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html#position) */ position?: PointProperties; /** * The tilt angle (in degrees) of the slice plane. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html#tilt) */ tilt?: number; /** * The width of the slice plane. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html#width) */ width?: number; } /** * Note: reserved for internal use only, this is not part of the stable public API. * * Media layer utilities for the map viewer application. */ interface mediaUtils { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Creates a georeference for a media element and a view extent. */ createDefaultControlPointsGeoreference(mediaElement: ImageElement | VideoElement, extent: Extent): Promise; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Creates a georeference to be used in a MapView when authoring the source points of the element's georeference. */ createLocalModeControlPointsGeoreference(mediaElement: ImageElement | VideoElement): ControlPointsGeoreference | null; } export const mediaUtils: mediaUtils; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Color utilities for the Scene Viewer application. */ interface SceneViewerColorUtils { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Return true if a color is bright. */ isBright(color: Color): boolean; } export const SceneViewerColorUtils: SceneViewerColorUtils; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Development environment utilities used in the SceneViewer. */ interface devEnvironmentUtils { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Check if we are running in a dev environment. */ isDevEnvironment(hostname: string): boolean; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Checks whether for telemetry logging purposes, we are running in a development environment. */ isTelemetryDevEnvironment(hostname: string): boolean; } export const devEnvironmentUtils: devEnvironmentUtils; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Various utilities for the Scene Viewer application. */ interface sceneViewerUtils { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Checks for relative urls and returns whether or not this webscene allows the `saveAs()` operation. */ canSaveAs(webscene: WebScene): boolean; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Create a new TilingScheme based on the tileInfo */ createTilingScheme(tileInfo: TileInfo): any; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Gets whether the editor still has any pending edits which should/could prevent the widget being discarded/destroyed (e.g. */ editorHasPendingEdits(viewModel: EditorViewModel): boolean; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Navigates back to the previous page of the `Editor` widget. */ editorNavigateBack(viewModel: EditorViewModel): Promise; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Generates if necessary an equivalent tileinfo but with a different pixel size (256 or 512). */ getOrCreateCompatibleTileInfo(tileInfo: TileInfo, expectedTileSize: number, resolutionModifier: number): any; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Initializes all the schema validators so that validation is performed when saving web scenes or layers. */ initializeSchemaValidators(): void; isHostedAgolServiceUrl(url: string): boolean; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Check if the error is a schema validation error. */ isSchemaValidationError(saveError: void): boolean; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Checks whether the provided spatial reference is supported in the provided viewing mode. */ isSpatialReferenceSupported(spatialReference: SpatialReference, viewingMode: "global" | "local"): boolean; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Check if a given TileInfo is supported. */ isSupportedTileInfo(tileInfo: TileInfo): boolean; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Render svg vnode for elements provided in the descriptor */ renderSVG(swatch: any[][], width: number, height: number, options?: any): any; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Warn about problem when trying to display message about the save state. */ saveStateWarning(warningMessage: string, error: any): void; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Returns the start position of the cross hair while dragging to zoom. */ zoomDragBeginPoint(view: SceneView): number[] | null; } export const sceneViewerUtils: sceneViewerUtils; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Symbol utilities for the Scene Viewer application. */ interface SceneViewerSymbolUtils { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Returns a promise resolving to an array containing the width, height and depth of the object symbol layer resource. */ computeObjectLayerSize(symbolLayer: ObjectSymbol3DLayer): Promise; } export const SceneViewerSymbolUtils: SceneViewerSymbolUtils; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Sketch utilities for the WebEditor application. */ interface sketchUtils { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Shows a tooltip and focuses on a specific field on it. */ showTooltipAndFocusField(sketchViewModel: SketchViewModel, fieldName: | "area" | "distance" | "direction" | "elevation" | "orientation" | "radius" | "rotation" | "scale" | "size" | "totalLength", signal?: AbortSignal): void; } export const sketchUtils: sketchUtils; /** * This module allows you to evaluate [Arcade expressions](https://developers.arcgis.com/javascript/latest/arcade/) outside traditional ArcGIS Arcade [profiles](https://developers.arcgis.com/javascript/latest/arcade/#where-can-i-use-arcade). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html) */ interface arcade { /** * Compiles an Arcade expression and its profile into an executor. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#createArcadeExecutor) */ createArcadeExecutor(script: string, profile: Profile): Promise; /** * Creates a [Profile](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#Profile) definition for an Arcade profile implemented in the ArcGIS Maps SDK for JavaScript. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#createArcadeProfile) */ createArcadeProfile(profileName: | "form-constraint" | "feature-z" | "field-calculation" | "form-calculation" | "labeling" | "popup" | "popup-element" | "feature-reduction-popup" | "feature-reduction-popup-element" | "visualization"): Profile; } export const arcade: arcade; /** * An executor provides a synchronous (if applicable) and asynchronous function used to evaluate the compiled Arcade expression with the inputs of the declared profile variables. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#ArcadeExecutor) */ export interface ArcadeExecutor { /** * A function that can be invoked to evaluate the compiled expression for a set of profile variables. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#ArcadeExecutor) */ execute: ExecuteFunction; /** * Asynchronous function that evaluates the compiled expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#ArcadeExecutor) */ executeAsync: ExecuteFunctionAsync; /** * References the names of fields used in the compiled expression when working with the `$feature` profile variable or functions that expect field names, such as `Expects`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#ArcadeExecutor) */ fieldsUsed: string[]; /** * Indicates whether the expression accesses or uses a feature's geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#ArcadeExecutor) */ geometryUsed: boolean; /** * Indicates whether the compiled expression accesses data using a FeatureSet function and therefore must be executed using the `executeAsync` function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#ArcadeExecutor) */ isAsync: boolean; } /** * The type definition of a profile variable of type `array`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#ArrayElementType) */ export interface ArrayElementType { /** * The Arcade data type of the variable. * * [Read more...](global.html#type) */ type: | "array" | "dictionary" | "feature" | "featureSet" | "featureSetCollection" | "geometry" | "number" | "text" | "date" | "dateOnly" | "time" | "boolean" | "knowledgeGraph"; /** * Only applicable when `type` is `dictionary`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#ArrayElementType) */ properties?: ProfileVariable[]; /** * Only applicable when `type` is `array`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#ArrayElementType) */ elementType?: ArrayElementType; } /** * The type definition for an Arcade array profile variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#ArrayVariable) */ export interface ArrayVariable { /** * The name of the profile variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#ArrayVariable) */ name: string; /** * The Arcade data type of the variable. * * [Read more...](global.html#type) */ type: "array"; /** * The type definition of the Array's items. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#ArrayVariable) */ elementType?: ArrayElementType; } /** * The type definition for an Arcade dictionary profile variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#DictionaryVariable) */ export interface DictionaryVariable { /** * The name of the profile variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#DictionaryVariable) */ name: string; /** * The Arcade data type of the variable. * * [Read more...](global.html#type) */ type: "dictionary"; /** * The type definitions of the dictionary's properties. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#DictionaryVariable) */ properties?: ProfileVariable[]; } /** * The execution context of the Arcade expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#ExecuteContext) */ export interface ExecuteContext { /** * The expected spatial reference of input geometries in geometry functions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#ExecuteContext) */ spatialReference?: SpatialReference; /** * _Since 4.28_ Defines the default time zone in which to create and display Arcade date types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#ExecuteContext) */ timeZone?: string; } export type ExecuteFunction = (profileVariableInstances: any, context?: ExecuteContext) => ResultType; export type ExecuteFunctionAsync = (profileVariableInstances: any, context?: ExecuteContext) => Promise; /** * Defines the definitions of a profile's input variables. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#Profile) */ export interface Profile { /** * The Arcade type definitions for profile variables used as input to the compiled expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#Profile) */ variables: ProfileVariable[]; } /** * The type definition of a profile variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#ProfileVariable) */ export type ProfileVariable = SimpleVariable | DictionaryVariable | ArrayVariable; /** * The JavaScript types that may be used as inputs to profile variables when evaluating compiled expressions with [ExecuteFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#ExecuteFunction) or [ExecuteFunctionAsync](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#ExecuteFunctionAsync). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#ProfileVariableInstanceType) */ export type ProfileVariableInstanceType = | Graphic | Geometry | FeatureSet | FeatureLayer | Map | Geometry | KnowledgeGraph | string | number | boolean | Date | any | any[]; /** * The JavaScript type of the result returned from the Arcade expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#ResultType) */ export type ResultType = number | string | Date | boolean | Graphic | Geometry | any | ResultType[]; /** * The type definition for a simple Arcade profile variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#SimpleVariable) */ export interface SimpleVariable { /** * The name of the profile variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#SimpleVariable) */ name: string; /** * The Arcade data type of the variable. * * [Read more...](global.html#type) */ type: | "feature" | "featureSet" | "featureSetCollection" | "geometry" | "number" | "text" | "date" | "dateOnly" | "time" | "boolean" | "knowledgeGraph"; } export interface Basemap extends Accessor, Loadable, JSONSupport { } export class Basemap { /** * A collection of tile layers that make up the basemap's features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#baseLayers) */ baseLayers: Collection; /** * An identifier used to refer to the basemap when referencing it elsewhere. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#id) */ id: string; /** * Indicates whether the basemap instance has loaded. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#loaded) */ readonly loaded: boolean; /** * The portal item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#portalItem) */ portalItem: PortalItem; /** * A collection of reference layers which are displayed over the [base layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#baseLayers) and can be used to display labels on top of terrain or streets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#referenceLayers) */ referenceLayers: Collection; /** * The spatial reference of the Basemap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#spatialReference) */ spatialReference: SpatialReference; /** * The style of the basemap from the [basemap styles service (v2)](https://developers.arcgis.com/rest/basemap-styles/). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#style) */ style: BasemapStyle; /** * The URL pointing to an image that represents the basemap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#thumbnailUrl) */ thumbnailUrl: string; /** * The title of the basemap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#title) */ title: string; /** * A basemap is a collection of layers that provide geographic context to a map or scene with data such as topographic features, road networks, buildings, and labels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) */ constructor(properties?: BasemapProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#clone) */ clone(): Basemap; /** * Destroys the basemap, and any associated resources, including its [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#layers) and [portalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#portalItem). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#destroy) */ destroy(): void; /** * Loads all the externally loadable resources associated with the basemap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#loadAll) */ loadAll(): Promise; /** * Creates a new basemap instance from a [basemap id](esri-Map.html#basemap-id). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#fromId) */ static fromId(id: string): Basemap; static fromJSON(json: any): Basemap; } interface BasemapProperties extends LoadableProperties { /** * A collection of tile layers that make up the basemap's features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#baseLayers) */ baseLayers?: CollectionProperties; /** * An identifier used to refer to the basemap when referencing it elsewhere. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#id) */ id?: string; /** * The portal item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#portalItem) */ portalItem?: PortalItemProperties; /** * A collection of reference layers which are displayed over the [base layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#baseLayers) and can be used to display labels on top of terrain or streets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#referenceLayers) */ referenceLayers?: CollectionProperties; /** * The spatial reference of the Basemap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * The style of the basemap from the [basemap styles service (v2)](https://developers.arcgis.com/rest/basemap-styles/). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#style) */ style?: BasemapStyleProperties; /** * The URL pointing to an image that represents the basemap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#thumbnailUrl) */ thumbnailUrl?: string; /** * The title of the basemap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#title) */ title?: string; } export interface Camera extends Accessor, JSONSupport, Clonable { } export class Camera { /** * The diagonal field of view (fov) angle for the camera. * * @default 55 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#fov) */ fov: number; /** * The compass heading of the camera in degrees. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading) */ heading: number; /** * The layout defines which sub-region of the camera is rendered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#layout) */ layout: CameraLayout; /** * The position of the camera defined by a map point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#position) */ position: Point; /** * The tilt of the camera in degrees with respect to the surface as projected down from the camera position. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#tilt) */ tilt: number; /** * The camera defines the [position](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#position), [tilt](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#tilt), and [heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading) of the point from which the [SceneView's](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) visible extent is observed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html) */ constructor(properties?: CameraProperties); static fromJSON(json: any): Camera; } interface CameraProperties { /** * The diagonal field of view (fov) angle for the camera. * * @default 55 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#fov) */ fov?: number; /** * The compass heading of the camera in degrees. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading) */ heading?: number; /** * The layout defines which sub-region of the camera is rendered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#layout) */ layout?: CameraLayoutProperties; /** * The position of the camera defined by a map point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#position) */ position?: PointProperties; /** * The tilt of the camera in degrees with respect to the surface as projected down from the camera position. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#tilt) */ tilt?: number; } export interface CameraLayout extends Accessor, Clonable { } export class CameraLayout { /** * The active column a display client renders to in a tiled display setup. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-CameraLayout.html#column) */ column: number; /** * The number of columns to decompose the camera in a tiled display setup. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-CameraLayout.html#columns) */ columns: number; /** * The active row a display client renders to in a tiled display setup. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-CameraLayout.html#row) */ row: number; /** * The number of rows to decompose the camera in a tiled display setup. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-CameraLayout.html#rows) */ rows: number; /** * The camera layout defines the position of the current view in a distributed larger view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-CameraLayout.html) */ constructor(properties?: CameraLayoutProperties); } interface CameraLayoutProperties { /** * The active column a display client renders to in a tiled display setup. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-CameraLayout.html#column) */ column?: number; /** * The number of columns to decompose the camera in a tiled display setup. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-CameraLayout.html#columns) */ columns?: number; /** * The active row a display client renders to in a tiled display setup. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-CameraLayout.html#row) */ row?: number; /** * The number of rows to decompose the camera in a tiled display setup. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-CameraLayout.html#rows) */ rows?: number; } export class Color { /** * The alpha value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#a) */ a: number; /** * The blue value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#b) */ b: number; /** * The green value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#g) */ g: number; /** * The red value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#r) */ r: number; constructor(color: string | number[] | any); /** * Creates a deep clone of the Color instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#clone) */ clone(): Color; /** * Takes an array of rgb(a) values, named string, hex string or an hsl(a) string, an object with `r`, `g`, `b`, and `a` properties, or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object and sets this color instance to the input value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#setColor) */ setColor(color: string | number[] | any): Color; /** * Returns a CSS color string in rgba form representing the Color instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#toCss) */ toCss(includeAlpha?: boolean): string; /** * Returns the color in hexadecimal format. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#toHex) */ toHex(options?: ColorToHexOptions): string; /** * Returns a JSON object with all the values from a Color instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#toJSON) */ toJSON(): any; /** * Returns a 3-component array of rgb values that represent the Color instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#toRgb) */ toRgb(): number[]; /** * Returns a 4-component array of rgba values that represent the Color instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#toRgba) */ toRgba(): number[]; /** * Creates a Color instance by blending two colors using a weight factor. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#blendColors) */ static blendColors(start: Color, end: Color, weight: number, out?: Color): Color; /** * Creates a Color instance using a 3 or 4 element array, mapping each element in sequence to the rgb(a) values of the color. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#fromArray) */ static fromArray(a: number[], t?: Color): Color; /** * Creates a Color from hexadecimal string. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#fromHex) */ static fromHex(hex: string, color?: Color): Color; /** * Creates a new Color instance, and initializes it with values from a JSON object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#fromJSON) */ static fromJSON(json: any): Color; /** * Creates a Color instance from a string of the form "rgb()" or "rgba()". * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#fromRgb) */ static fromRgb(color: string, out?: Color): Color; /** * Creates a Color instance by parsing a generic string. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#fromString) */ static fromString(str: string, obj?: Color): Color; } export interface ColorToHexOptions { /** * When `true`, the hexadecimal number will be capitalized. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#toHex) */ capitalize?: boolean; /** * The intended size of the output hexadecimal number. * * @default 6 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#toHex) */ digits?: number; } /** * Configure global properties of the library. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html) */ interface config { /** * An authorization string used to access a resource or service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#apiKey) */ apiKey: string; /** * The name of the application using the API. * * @default "" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#applicationName) */ applicationName: string; /** * Overrides the URL for loading the API assets when using local builds of the `@arcgis/core` and `arcgis-js-api` NPM packages. * * @default "https://js.arcgis.com/[4.x]/@arcgis/core/assets" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#assetsPath) */ assetsPath: string; /** * The URL for font resources used by the [Font](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#family) class in non-MapImageLayer labels for both 2D MapViews and 3D SceneViews. * * @default "https://static.arcgis.com/fonts" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#fontsUrl) */ fontsUrl: string; /** * The default [geometryService](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html) used by widgets and other operations, such as on-the-fly projections. * * @default "https://utility.arcgisonline.com/arcgis/rest/services/Geometry/GeometryServer" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#geometryServiceUrl) */ geometryServiceUrl: string; /** * The URL for the utility service used by [GeoRSSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html) to convert GeoRSS documents. * * @default "https://utility.arcgis.com/sharing/rss" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#geoRSSServiceUrl) */ geoRSSServiceUrl: string; /** * The URL for the utility service used by [KMLLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html) to convert KML documents. * * @default "https://utility.arcgis.com/sharing/kml" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#kmlServiceUrl) */ kmlServiceUrl: string; /** * An object with properties that control various aspects of log messages. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#log) */ log: configLog; /** * The default URL of new portal instances. * * @default "https://www.arcgis.com" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) */ portalUrl: string; /** * An object with properties that control various aspects of communication between the library and web servers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request) */ request: configRequest; /** * The default routing service used by the [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html) and the [Directions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html) widget. * * @default "https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#routeServiceUrl) */ routeServiceUrl: string; /** * Indicates whether layers should apply privileges of the authenticated user to their capabilities. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#userPrivilegesApplied) */ userPrivilegesApplied: boolean; /** * An object with properties that control various aspects of [the workers framework](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#workers) */ workers: configWorkers; } export const config: config; export type AfterInterceptorCallback = (response: RequestResponse) => void; export type BeforeInterceptorCallback = (params: any) => any; export interface configLog { /** * An array of custom interceptor functions that can be used to intercept log messages. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#log) */ interceptors: LogInterceptor[]; /** * The level of messages to log. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#log) */ level: "none" | "error" | "warn" | "info"; } export interface configRequest { /** * List of domain suffixes known to support https. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request) */ httpsDomains?: string[]; /** * **Since:** 4.8 Allows developers to modify requests before or after they are sent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request) */ interceptors?: RequestInterceptor[]; /** * Maximum number of characters allowed in the URL for HTTP GET requests made by [request](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html). * * @default 2000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request) */ maxUrlLength?: number; /** * **Since:** 4.24 The fetch and image network request priority. * * @default high * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request) */ priority?: "auto" | "high" | "low"; /** * A proxy rule defines a proxy for a set of resources with an identical URL prefix. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request) */ proxyRules?: configRequestProxyRules[]; /** * Resource proxy for your application. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request) */ proxyUrl?: string; /** * Number of milliseconds [request](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html) will wait for response from a server. * * @default 60000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request) */ timeout?: number; /** * **Since:** 4.9 Indicates whether cross-origin requests made to the associated server should include credentials such as cookies and authorization headers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request) */ trustedServers?: string[]; /** * **Since:** 4.5 Indicates whether `esri/request` will request a credential from `IdentityManager`. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request) */ useIdentity?: boolean; } export interface configRequestProxyRules { /** * The URL of the proxy. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request) */ proxyUrl?: string; /** * URL prefix for resources that need to be accessed through a specific proxy. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request) */ urlPrefix?: string; } export interface configWorkers { /** * The absolute url to the AMD or SystemJS loader used in the worker. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#workers) */ loaderUrl?: any; /** * This is used by the `@arcgis/core` and `arcgis-js-api` NPM packages to control where to load a custom build of the `RemoteClient` from. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#workers) */ workerPath?: string; /** * The AMD configuration object that is set in each worker. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#workers) */ loaderConfig?: configWorkersLoaderConfig; } export interface configWorkersLoaderConfig { /** * The AMD loader loads all code relative to the baseUrl. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#workers) */ baseUrl?: string; /** * Determines if the specified feature capabilities are supported. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#workers) */ has?: any; /** * Map of module id fragments to file paths. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#workers) */ paths?: any; /** * Map paths in module identifiers to different paths. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#workers) */ map?: any; /** * An array of objects which provide the package name and its location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#workers) */ packages?: any[]; } export type ErrorCallback = (error: Error) => void; export type LogInterceptor = (level: "error" | "warn" | "info", module: string, ...args: any[]) => boolean; /** * Specifies the object used for intercepting and modifying requests made via [esriRequest](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#RequestInterceptor) */ export interface RequestInterceptor { /** * Makes changes to the response after the request is sent, but before it's returned to the caller. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#RequestInterceptor) */ after?: AfterInterceptorCallback; /** * Make changes to the request URL or options before the request is sent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#RequestInterceptor) */ before?: BeforeInterceptorCallback; /** * When an error occurs during the request processing, this function is called with an [Error](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html) object giving the details about what happened. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#RequestInterceptor) */ error?: ErrorCallback; /** * Sets or adds headers into `requestOptions.headers`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#RequestInterceptor) */ headers?: any; /** * Sets or adds query parameters into `requestOptions.query`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#RequestInterceptor) */ query?: any; /** * Hardcodes the [response](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestResponse). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#RequestInterceptor) */ responseData?: any; /** * Specifies the URL(s) to apply to the interceptors. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#RequestInterceptor) */ urls?: string | RegExp | (string | RegExp)[]; } export type WatchCallback = (newValue: any, oldValue: any, propertyName: string, target: Accessor) => void; /** * Represents a watch or event handler which can be removed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#WatchHandle) */ export interface WatchHandle { /** * Removes the watch handle. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#WatchHandle) */ remove(): void; } /** * This module contains Accessor [TypeScript](https://www.typescriptlang.org/docs/handbook/decorators.html) decorators. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html) */ interface decorators { /** * A property decorator that creates a two-way binding between the property it decorates and an inner property of one of its members. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#aliasOf) */ aliasOf(propertyName: string): Function; /** * This method decorator is used to define the method that will cast a property from a class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#cast) */ cast(propertyName: string): Function; /** * This property decorator is used to define the function or class for a property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#cast) */ cast(functionOrClass: Function): Function; /** * This convenience decorator is used to define an [Accessor](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#property) */ property(propertyMetadata?: decoratorsPropertyPropertyMetadata): Function; /** * This decorator is used to define an [Accessor](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html) subclass. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#subclass) */ subclass(declaredClass?: string): Function; } export const decorators: decorators; export interface decoratorsPropertyPropertyMetadata { /** * Property names of dependencies. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#property) */ dependsOn?: string[]; /** * The constructor used to [autocast](../programming-patterns/#autocasting) the property. * * [Read more...](global.html#type) */ type?: Function; /** * The function to use to [autocast](https://developers.arcgis.com/javascript/latest/programming-patterns/#autocasting) the property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#property) */ cast?: Function; /** * Indicates whether the property is read-only. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#property) */ readOnly?: boolean; /** * Indicates whether the property can be set during construction but is otherwise read-only. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#property) */ constructOnly?: boolean; /** * The property decorator that creates a two-way binding between the property it decorates and an inner property of one of its members. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#property) */ aliasOf?: string; /** * The default value for the property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#property) */ value?: any; } export class Clonable { /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Clonable.html#clone) */ clone(): this; } export interface CollectionAfterAddEvent { item: any; } export interface CollectionAfterChangesEvent { } export interface CollectionAfterRemoveEvent { item: any; } export interface CollectionBeforeAddEvent { cancellable: boolean; defaultPrevented: boolean; item: any; preventDefault: Function; } export interface CollectionBeforeChangesEvent { cancellable: boolean; defaultPrevented: boolean; item: any; preventDefault: Function; } export interface CollectionBeforeRemoveEvent { cancellable: boolean; defaultPrevented: boolean; item: any; preventDefault: Function; } export class Error { /** * The details object provides additional details specific to the error, giving more information about why the error was raised. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html#details) */ details: any; /** * A message describing the details of the error. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html#message) */ message: string; /** * A unique error name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html#name) */ name: string; constructor(name: string, message?: string, details?: any); } export class Evented { /** * Emits an event on the instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Evented.html#emit) */ emit(type: string, event?: any): boolean; /** * Indicates whether there is an event listener on the instance that matches the provided event name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Evented.html#hasEventListener) */ hasEventListener(type: string): boolean; /** * Registers an event handler on the instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Evented.html#on) */ on(type: string | string[], listener: EventHandler): IHandle; } export type EventHandler = (event: any) => void; export class HandleOwner extends Accessor { /** * Handle registry to help manage `handles`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-HandleOwner.html#handles) */ handles: Handles; /** * Provides a single [handles](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-HandleOwner.html#handles) property to be shared with all subclasses. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-HandleOwner.html) */ constructor(properties?: HandleOwnerProperties); } interface HandleOwnerProperties { /** * Handle registry to help manage `handles`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-HandleOwner.html#handles) */ handles?: Handles; } export class Handles { constructor(); /** * Adds a group of handles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Handles.html#add) */ add(handles: WatchHandle | WatchHandle[] | Collection, groupKey?: any): void; /** * Destroys the object, removing all the handles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Handles.html#destroy) */ destroy(): void; /** * Returns true if a group exists for the provided group key, false otherwise. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Handles.html#has) */ has(groupKey: any): boolean; /** * Removes a group of handles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Handles.html#remove) */ remove(groupKey?: any): void; /** * Removes all handles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Handles.html#removeAll) */ removeAll(): void; } /** * A handle to a [highlight](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html#highlight) call result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Handles.html#Handle) */ export interface Handle { /** * Removes the handle. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Handles.html#Handle) */ remove(): void; } export class Identifiable { } export class JSONSupport { /** * Converts an instance of this class to its [ArcGIS portal JSON](https://developers.arcgis.com/documentation/common-data-types/geometry-objects.htm) representation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-JSONSupport.html#toJSON) */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-JSONSupport.html#fromJSON) */ static fromJSON(json: any): any; } /** * Provides a utility method for deeply cloning objects with properties that are computed or have their own `clone()` method, such as [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-lang.html) */ interface lang { /** * Use this method to deeply clone objects with properties that are computed or have their own `clone()` method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-lang.html#clone) */ clone(elem: any): any; } export const lang: lang; export class Loadable { /** * The Error object returned if an error occurred while loading. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#loadError) */ readonly loadError: Error; /** * Represents the status of a [load](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#load) operation. * * @default not-loaded * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#loadStatus) */ readonly loadStatus: "not-loaded" | "loading" | "failed" | "loaded"; /** * A list of warnings which occurred while loading. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#loadWarnings) */ readonly loadWarnings: any[]; /** * Cancels a [load()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#load) operation if it is already in progress. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#cancelLoad) */ cancelLoad(): void; /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#isFulfilled) */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#isRejected) */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#isResolved) */ isResolved(): boolean; /** * Loads the resources referenced by this class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#load) */ load(signal?: AbortSignal): Promise; /** * `when()` may be leveraged once an instance of the class is created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#when) */ when(callback?: Function, errback?: Function): Promise; } interface LoadableProperties { } export class corePromise { /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Promise.html#isFulfilled) */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Promise.html#isRejected) */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Promise.html#isResolved) */ isResolved(): boolean; /** * `when()` may be leveraged once an instance of the class is created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Promise.html#when) */ when(callback?: Function, errback?: Function): Promise; } /** * Various utilities and convenience functions for working with promises. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-promiseUtils.html) */ interface promiseUtils { /** * Creates a special error object which is used to signal aborted requests in promise chains. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-promiseUtils.html#createAbortError) */ createAbortError(): Error; /** * A utility for ensuring an input function is not simultaneously invoked more than once at a time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-promiseUtils.html#debounce) */ debounce(callback: T): T; /** * Convenience utility method to wait for a number of promises to either resolve or reject. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-promiseUtils.html#eachAlways) */ eachAlways(promises: Promise[] | any): Promise | any; /** * A convenience utility method for filtering an array of values using an asynchronous predicate function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-promiseUtils.html#filter) */ filter(input: T[], predicate: FilterPredicateCallback): Promise; /** * Check if the provided error object is the special kind of error with which promises are rejected when they are aborted. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-promiseUtils.html#isAbortError) */ isAbortError(error: Error): boolean; } export const promiseUtils: promiseUtils; /** * The result object for a promise passed to [promiseUtils.eachAlways](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-promiseUtils.html#eachAlways). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-promiseUtils.html#EachAlwaysResult) */ export interface EachAlwaysResult { /** * The promise that has been fulfilled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-promiseUtils.html#EachAlwaysResult) */ promise: Promise; /** * The value with which the promise resolved. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-promiseUtils.html#EachAlwaysResult) */ value?: any; /** * The error with which the promise rejected. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-promiseUtils.html#EachAlwaysResult) */ error?: any; } export type Executor = (resolve: ResolveCallback, reject: RejectCallback) => void; export type FilterPredicateCallback = (value: any, index: number) => Promise; export type RejectCallback = (error?: any) => void; export type ResolveCallback = (value?: any | Promise) => void; /** * Quantity type used to represent measurements across the JS API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-quantity.html) */ interface quantity { } export const quantity: quantity; export interface Angle { /** * Scalar value representing a angle. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-quantity.html#Angle) */ value: number; /** * Any unit which represents an angle. * * [Read more...](global.html#unit) */ unit: AngleUnit; /** * Unit type. * * [Read more...](global.html#type) */ type: "angle"; } export interface Area { /** * Scalar value representing a area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-quantity.html#Area) */ value: number; /** * Any unit which represents area. * * [Read more...](global.html#unit) */ unit: AreaUnit; /** * Unit type. * * [Read more...](global.html#type) */ type: "area"; } export interface Length { /** * Scalar value representing a length. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-quantity.html#Length) */ value: number; /** * Any unit which represents length. * * [Read more...](global.html#unit) */ unit: LengthUnit; /** * Unit type. * * [Read more...](global.html#type) */ type: "length"; } /** * Various utilities and convenience functions for executing code at various phases of browser frames. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html) */ interface scheduling { /** * Registers a frame task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#addFrameTask) */ addFrameTask(phases: PhaseCallbacks): FrameTaskHandle; /** * Schedules the execution of a `callback` function at the next web browser tick. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#schedule) */ schedule(callback: Function): any; } export const scheduling: scheduling; /** * An object to remove or pause a frame task registered with [addFrameTask()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#addFrameTask). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#FrameTaskHandle) */ export interface FrameTaskHandle { /** * Pause the execution the frame task at every frame. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#FrameTaskHandle) */ pause(): void; /** * Resumes the execution the frame task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#FrameTaskHandle) */ resume(): void; /** * Removes the frame task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#FrameTaskHandle) */ remove(): void; } export type PhaseCallback = (event?: PhaseEvent) => void; /** * A set of [callbacks](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#PhaseCallback) that will be called at specific phases of the animation frame. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#PhaseCallbacks) */ export interface PhaseCallbacks { /** * A callback called before rendering. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#PhaseCallbacks) */ prepare?: PhaseCallback; /** * A callback to execute rendering logic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#PhaseCallbacks) */ render?: PhaseCallback; /** * A callback to execute state update logic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#PhaseCallbacks) */ update?: PhaseCallback; } /** * An object with timing information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#PhaseEvent) */ export interface PhaseEvent { /** * The absolute time at the start of the current animation frame. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#PhaseEvent) */ time: number; /** * The elapsed time since the last animation frame. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#PhaseEvent) */ deltaTime: number; /** * The amount of time spent within the current animation frame. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#PhaseEvent) */ elapsedFrameTime: number; } export type MutateFunction = (value: any) => void; /** * Signal which contains a single reactive value and methods to modify it and notify any other signals, Accessor properties or reactive contexts (i.e. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-signal.html#Signal) */ export interface Signal { /** * The current value of the signal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-signal.html#Signal) */ value?: boolean; /** * Calls a mutate function which can modify the value of the signal in place. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-signal.html#Signal) */ mutate?: MutateFunction; } /** * Creates a [WhereClause](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html) expression that adheres to standardized SQL expressions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql.html) */ interface sql { /** * Parses the given where clause string and returns an instance of [WhereClause](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html) when resolved. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql.html#parseWhereClause) */ parseWhereClause(clause: string, fieldsIndex: FieldsIndex, timeZone?: string): Promise; } export const sql: sql; /** * The WhereClause is used to extract the features that meet a specified condition by parsing the provided results in to a value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html) */ interface WhereClause { /** * An array of the field names used in the where clause. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#fieldNames) */ fieldNames: string[]; /** * Returns `true` if the parsed where clause meets the requirements of standardized sql. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#isStandardized) */ readonly isStandardized: boolean; /** * A parse tree is a data structure for representing a parsed sql statement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#parseTree) */ parseTree: SQLNode; /** * Executes the where clause against a feature to generate a value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#calculateValue) */ calculateValue(feature: any): any; /** * Tests the attributes of a feature against the `whereClause`, and returns `true` if the test passes, `false` otherwise. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#testFeature) */ testFeature(feature: any): boolean; } export const WhereClause: WhereClause; /** * A binary expression node. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#BinaryNode) */ export interface BinaryNode { type: "binary-expression"; /** * Defines the way two expressions are combined to yield a single result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#BinaryNode) */ operator: | "AND" | "OR" | "IS" | "ISNOT" | "IN" | "NOT IN" | "BETWEEN" | "NOTBETWEEN" | "LIKE" | "NOT LIKE" | "<>" | "<" | ">" | ">=" | "<=" | "=" | "*" | "-" | "+" | "/"; /** * SQL node to the left of the binary node. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#BinaryNode) */ left: SQLNode; /** * SQL node to the right of the binary node. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#BinaryNode) */ right: SQLNode; /** * Escape string. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#BinaryNode) */ escape?: string; } /** * A node that contains a boolean expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#BoolNode) */ export interface BoolNode { type: "boolean"; /** * Values are `true` or `false`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#BoolNode) */ value: boolean; } /** * A node that contains column name of a layer or table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#ColumnNode) */ export interface ColumnNode { type: "column-reference"; /** * Column or field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#ColumnNode) */ column: "string"; } /** * A node that contains `CURRENT_TIME` or `CURRENT_DATE` functions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#CurrentTimeNode) */ export interface CurrentTimeNode { type: "current-time"; /** * The current time node mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#CurrentTimeNode) */ mode: "timestamp" | "date"; } /** * A node that contains date. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#DateNode) */ export interface DateNode { type: "date"; /** * The date value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#DateNode) */ value: string; } /** * A nodes that contains SQL function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#FunctionNode) */ export interface FunctionNode { type: "function"; /** * Name of the SQL function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#FunctionNode) */ name: string; /** * Function arguments. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#FunctionNode) */ args: ListNode; } /** * Interval node indicates that the character literal is an interval. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#IntervalNode) */ export interface IntervalNode { type: "interval"; /** * Interval node value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#IntervalNode) */ value: StringNode; /** * Interval node sign. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#IntervalNode) */ op: "+" | "-" | ""; /** * The interval qualifier can either be a single datetime field or be composed of two datetime fields, in the form: TO . * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#IntervalNode) */ qualifier: IntervalQualifierNode | IntervalPeriodNode; } /** * Interval period node. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#IntervalPeriodNode) */ export interface IntervalPeriodNode { type: "interval-period"; /** * Interval node periods. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#IntervalPeriodNode) */ period: "day" | "month" | "hour" | "second" | "year" | "minute"; precision: number; secondary: "number"; } /** * Node that contains interval qualifier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#IntervalQualifierNode) */ export interface IntervalQualifierNode { type: "interval-qualifier"; /** * Interval node periods. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#IntervalQualifierNode) */ period: "day" | "month" | "hour" | "second" | "year" | "minute"; /** * Precision for an interval data type includes interval leading precision, interval precision, and seconds precision. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#IntervalQualifierNode) */ precision: number; /** * Seconds precision. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#IntervalQualifierNode) */ secondary: "number"; } /** * A node that contains a list. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#ListNode) */ export interface ListNode { type: "expression-list"; /** * SQL expression for the list. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#ListNode) */ expr: SQLNode; } /** * A node that contains `NULL` value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#NullNode) */ export interface NullNode { type: "null"; /** * Null value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#NullNode) */ value: null; } /** * A node that contains number. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#NumberNode) */ export interface NumberNode { type: "number"; /** * Numeric value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#NumberNode) */ value: number; } /** * Node that contains case expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#SearchedCaseNode) */ export interface SearchedCaseNode { type: "case-expression"; /** * Case expression format. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#SearchedCaseNode) */ format: "searched"; /** * When clauses. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#SearchedCaseNode) */ clauses: WhenNode[]; /** * Else SQL node. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#SearchedCaseNode) */ else: SQLNode; } /** * Simple case expression node. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#SimpleCaseNode) */ export interface SimpleCaseNode { type: "case_expression"; format: "simple"; /** * When nodes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#SimpleCaseNode) */ clauses: WhenNode[]; /** * SQL node. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#SimpleCaseNode) */ operand: SQLNode; /** * else sql node. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#SimpleCaseNode) */ else: SQLNode; } /** * SQL parse tree is composed of SqlNodes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#SQLNode) */ export type SQLNode = | BinaryNode | BoolNode | ColumnNode | CurrentTimeNode | DateNode | FunctionNode | IntervalNode | IntervalPeriodNode | IntervalQualifierNode | NullNode | StringNode | ListNode | NumberNode | SimpleCaseNode | SearchedCaseNode | TimeStampNode | TimeNode | UnaryNode | WhenNode; /** * A node that contains string. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#StringNode) */ export interface StringNode { type: "string"; /** * The string value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#StringNode) */ value: string; } /** * A node that contains time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#TimeNode) */ export interface TimeNode { type: "date"; /** * The time value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#TimeNode) */ value: string; } /** * A node that contains date. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#TimeStampNode) */ export interface TimeStampNode { type: "timestamp"; /** * String date value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#TimeStampNode) */ value: string; } /** * A node that contains unary operator. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#UnaryNode) */ export interface UnaryNode { type: "unary-expression"; /** * The sql node. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#UnaryNode) */ expr: SQLNode; } /** * Node that contains when clause. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#WhenNode) */ export interface WhenNode { type: "when-clause"; /** * operand. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#WhenNode) */ operand: SQLNode; /** * value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html#WhenNode) */ value: SQLNode; } /** * Types of units used across the JS API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-units.html) */ namespace units { /** * Units for lengths. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-units.html#LengthUnit) */ export type LengthUnit = | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"; /** * Units for areas. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-units.html#AreaUnit) */ export type AreaUnit = | "square-millimeters" | "square-centimeters" | "square-decimeters" | "square-meters" | "square-kilometers" | "square-inches" | "square-feet" | "square-yards" | "square-miles" | "square-us-feet" | "acres" | "ares" | "hectares"; /** * Units for volumes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-units.html#VolumeUnit) */ export type VolumeUnit = | "liters" | "cubic-millimeters" | "cubic-centimeters" | "cubic-decimeters" | "cubic-meters" | "cubic-kilometers" | "cubic-inches" | "cubic-feet" | "cubic-yards" | "cubic-miles"; /** * Units for angles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-units.html#AngleUnit) */ export type AngleUnit = "degrees" | "radians"; /** * Units for angles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-units.html#Unit) */ export type Unit = __esri.LengthUnit | __esri.AreaUnit | __esri.VolumeUnit | __esri.AngleUnit; /** * Measurement systems. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-units.html#MeasurementSystem) */ export type MeasurementSystem = "imperial" | "metric"; /** * Measurement systems or an area units. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-units.html#SystemOrAreaUnit) */ export type SystemOrAreaUnit = __esri.MeasurementSystem | __esri.AreaUnit; /** * Measurement system or an length unit. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-units.html#SystemOrLengthUnit) */ export type SystemOrLengthUnit = __esri.MeasurementSystem | __esri.LengthUnit; } /** * Units for angles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-units.html#AngleUnit) */ export type AngleUnit = "degrees" | "radians"; /** * Units for areas. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-units.html#AreaUnit) */ export type AreaUnit = | "square-millimeters" | "square-centimeters" | "square-decimeters" | "square-meters" | "square-kilometers" | "square-inches" | "square-feet" | "square-yards" | "square-miles" | "square-us-feet" | "acres" | "ares" | "hectares"; /** * Units for lengths. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-units.html#LengthUnit) */ export type LengthUnit = | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"; /** * Measurement systems. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-units.html#MeasurementSystem) */ export type MeasurementSystem = "imperial" | "metric"; /** * Measurement systems or an area units. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-units.html#SystemOrAreaUnit) */ export type SystemOrAreaUnit = MeasurementSystem | AreaUnit; /** * Measurement system or an length unit. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-units.html#SystemOrLengthUnit) */ export type SystemOrLengthUnit = MeasurementSystem | LengthUnit; /** * Units for angles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-units.html#Unit) */ export type Unit = LengthUnit | AreaUnit | VolumeUnit | AngleUnit; /** * Units for volumes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-units.html#VolumeUnit) */ export type VolumeUnit = | "liters" | "cubic-millimeters" | "cubic-centimeters" | "cubic-decimeters" | "cubic-meters" | "cubic-kilometers" | "cubic-inches" | "cubic-feet" | "cubic-yards" | "cubic-miles"; /** * Utility methods for working with URLs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-urlUtils.html) */ interface urlUtils { /** * Adds the given proxy rule to the proxy rules list: `esriConfig.request.proxyRules`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-urlUtils.html#addProxyRule) */ addProxyRule(rule: urlUtilsAddProxyRuleRule): number; /** * Returns the proxy rule that matches the given URL. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-urlUtils.html#getProxyRule) */ getProxyRule(url: string): any; /** * Converts the URL arguments to an object representation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-urlUtils.html#urlToObject) */ urlToObject(url: string): any; } export const urlUtils: urlUtils; export interface urlUtilsAddProxyRuleRule { /** * The URL of the proxy. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-urlUtils.html#addProxyRule) */ proxyUrl: string; /** * The URL prefix of the resources that should be accessed through the given proxy. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-urlUtils.html#addProxyRule) */ urlPrefix: string; } /** * This module is a utility framework that simplifies the use of [Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers) in the ArcGIS Maps SDK for JavaScript. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers.html) */ interface workers { /** * Opens a connection to workers and loads a script with the workers framework. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers.html#open) */ open(modulePath: string, options?: workersOpenOptions): Promise; } export const workers: workers; export class Connection { constructor(); /** * A convenient method that invokes a method on each worker. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers-Connection.html#broadcast) */ broadcast(methodName: string, data?: any, options?: ConnectionBroadcastOptions): Promise[]; /** * Closes the existing connection instance to workers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers-Connection.html#close) */ close(): void; /** * Invokes a [method](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers-Connection.html#basic-invocation) on the remote module loaded with the worker. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers-Connection.html#invoke) */ invoke(methodName: string, data?: any, options?: ConnectionInvokeOptions): Promise; } export interface ConnectionBroadcastOptions { /** * An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to abort the executions of the remote method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers-Connection.html#broadcast) */ signal?: AbortSignal; } export interface ConnectionInvokeOptions { /** * An array of Transferable objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers-Connection.html#invoke) */ transferList?: any[]; /** * An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to abort the execution of the remote method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers-Connection.html#invoke) */ signal?: AbortSignal; } export interface workersOpenOptions { /** * The objects defining the API accessible from the module. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers.html#open) */ client?: any; /** * Indicates how to load the module. * * @default distributed * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers.html#open) */ strategy?: "distributed" | "dedicated" | "local"; /** * [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) allows for cancelable asynchronous job. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers.html#open) */ signal?: AbortSignal; } export interface Element extends Accessor, JSONSupport { } export class Element { /** * The element's description providing the purpose behind it. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-Element.html#description) */ description: string; /** * A string value containing the field alias. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-Element.html#label) */ label: string; /** * The type of form element to display. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-Element.html#type) */ readonly type: "field" | "group" | "relationship" | "text"; /** * A reference to the [name](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html#name) of an [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression defined in the [expressionInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#expressionInfos) of the [FormTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-Element.html#visibilityExpression) */ visibilityExpression: string; /** * Form elements define what should display within the [FormTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html) elements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-Element.html) */ constructor(properties?: ElementProperties); static fromJSON(json: any): Element; } interface ElementProperties { /** * The element's description providing the purpose behind it. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-Element.html#description) */ description?: string; /** * A string value containing the field alias. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-Element.html#label) */ label?: string; /** * A reference to the [name](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html#name) of an [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression defined in the [expressionInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#expressionInfos) of the [FormTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-Element.html#visibilityExpression) */ visibilityExpression?: string; } export class FieldElement extends Element { /** * The [coded value domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CodedValueDomain.html) or [range domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RangeDomain.html) of the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#domain) */ domain: CodedValueDomain | RangeDomain; /** * A reference to the [name](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html#name) of an [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression defined in the [expressionInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#expressionInfos) of the FormTemplate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#editableExpression) */ editableExpression: string; /** * The field name as defined by the feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#fieldName) */ fieldName: string; /** * Contains a hint used to help editors while editing fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#hint) */ hint: string; /** * The module:esri/form/elements/inputs/Input to use for the element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#input) */ input: | BarcodeScannerInput | ComboBoxInput | DatePickerInput | DateTimeOffsetPickerInput | DateTimePickerInput | TextAreaInput | TextBoxInput | RadioButtonsInput | SwitchInput | TimePickerInput; /** * A reference to the [name](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html#name) of an [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression defined in the [expressionInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#expressionInfos) of the [FormTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#requiredExpression) */ requiredExpression: string; /** * Indicates the type of form [element](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-Element.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#type) */ readonly type: "field"; /** * A reference to the [name](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html#name) of an [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression defined in the [expressionInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#expressionInfos) of the [FormTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#valueExpression) */ valueExpression: string; /** * A `FieldElement` form element defines how a feature layer's [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) participates in the [FeatureForm](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html) */ constructor(properties?: FieldElementProperties); /** * Creates a deep clone of the FieldElement class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#clone) */ clone(): FieldElement; static fromJSON(json: any): FieldElement; } interface FieldElementProperties extends ElementProperties { /** * The [coded value domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CodedValueDomain.html) or [range domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RangeDomain.html) of the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#domain) */ domain?: (CodedValueDomainProperties & { type: "coded-value" }) | (RangeDomainProperties & { type: "range" }); /** * A reference to the [name](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html#name) of an [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression defined in the [expressionInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#expressionInfos) of the FormTemplate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#editableExpression) */ editableExpression?: string; /** * The field name as defined by the feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#fieldName) */ fieldName?: string; /** * Contains a hint used to help editors while editing fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#hint) */ hint?: string; /** * The module:esri/form/elements/inputs/Input to use for the element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#input) */ input?: | (BarcodeScannerInputProperties & { type: "barcode-scanner" }) | (ComboBoxInputProperties & { type: "combo-box" }) | (DatePickerInputProperties & { type: "date-picker" }) | (DateTimeOffsetPickerInputProperties & { type: "datetimeoffset-picker" }) | (DateTimePickerInputProperties & { type: "datetime-picker" }) | (TextAreaInputProperties & { type: "text-area" }) | (TextBoxInputProperties & { type: "text-box" }) | (RadioButtonsInputProperties & { type: "radio-buttons" }) | (SwitchInputProperties & { type: "switch" }) | (TimePickerInputProperties & { type: "time-picker" }); /** * A reference to the [name](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html#name) of an [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression defined in the [expressionInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#expressionInfos) of the [FormTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#requiredExpression) */ requiredExpression?: string; /** * A reference to the [name](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html#name) of an [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression defined in the [expressionInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#expressionInfos) of the [FormTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#valueExpression) */ valueExpression?: string; } export class GroupElement extends Element { /** * An array of [field elements](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html) to display as grouped. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-GroupElement.html#elements) */ elements: FieldElement[]; /** * Defines if the group should be expanded or collapsed when the form is initially displayed. * * @default expanded * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-GroupElement.html#initialState) */ initialState: "collapsed" | "expanded"; /** * The type of the [element](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-Element.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-GroupElement.html#type) */ readonly type: "group"; /** * A `GroupElement` form element defines a container that holds a set of [form elements](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#elements) that can be expanded, collapsed, or displayed together. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-GroupElement.html) */ constructor(properties?: GroupElementProperties); /** * Creates a deep clone of the GroupElement class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-GroupElement.html#clone) */ clone(): GroupElement; static fromJSON(json: any): GroupElement; } interface GroupElementProperties extends ElementProperties { /** * An array of [field elements](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html) to display as grouped. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-GroupElement.html#elements) */ elements?: FieldElementProperties[]; /** * Defines if the group should be expanded or collapsed when the form is initially displayed. * * @default expanded * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-GroupElement.html#initialState) */ initialState?: "collapsed" | "expanded"; } export interface BarcodeScannerInput extends Accessor, TextInput, JSONSupport { } export class BarcodeScannerInput { /** * The type of form element input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-BarcodeScannerInput.html#type) */ readonly type: "barcode-scanner"; /** * The `BarcodeScannerInput` class defines the desired user interface for a barcode or QR code scanner. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-BarcodeScannerInput.html) */ constructor(properties?: BarcodeScannerInputProperties); static fromJSON(json: any): BarcodeScannerInput; } interface BarcodeScannerInputProperties extends TextInputProperties { } export interface ComboBoxInput extends Accessor, JSONSupport { } export class ComboBoxInput { /** * The text used to represent a null value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-ComboBoxInput.html#noValueOptionLabel) */ noValueOptionLabel: string; /** * Determines whether a null value option is displayed. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-ComboBoxInput.html#showNoValueOption) */ showNoValueOption: boolean; /** * The type of form element input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-ComboBoxInput.html#type) */ readonly type: "combo-box"; /** * The `ComboBoxInput` class defines the desired user interface for a combo box group input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-ComboBoxInput.html) */ constructor(properties?: ComboBoxInputProperties); static fromJSON(json: any): ComboBoxInput; } interface ComboBoxInputProperties { /** * The text used to represent a null value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-ComboBoxInput.html#noValueOptionLabel) */ noValueOptionLabel?: string; /** * Determines whether a null value option is displayed. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-ComboBoxInput.html#showNoValueOption) */ showNoValueOption?: boolean; } export interface DatePickerInput extends Accessor, JSONSupport { } export class DatePickerInput { /** * The maximum date to allow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DatePickerInput.html#max) */ max: string; /** * The minimum date to allow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DatePickerInput.html#min) */ min: string; /** * The type of form element input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DatePickerInput.html#type) */ readonly type: "date-picker"; /** * The `DatePickerInput` class defines the desired user interface for editing `date-only` field [type](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#type) input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DatePickerInput.html) */ constructor(properties?: DatePickerInputProperties); /** * Creates a deep clone of the `DatePickerInput` class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DatePickerInput.html#clone) */ clone(): DatePickerInput; static fromJSON(json: any): DatePickerInput; } interface DatePickerInputProperties { /** * The maximum date to allow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DatePickerInput.html#max) */ max?: string; /** * The minimum date to allow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DatePickerInput.html#min) */ min?: string; } export interface DateTimeOffsetPickerInput extends Accessor, JSONSupport { } export class DateTimeOffsetPickerInput { /** * Indicates if the input should provide an option to select the time offset. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DateTimeOffsetPickerInput.html#includeTimeOffset) */ includeTimeOffset: boolean; /** * The maximum date/time offset to allow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DateTimeOffsetPickerInput.html#max) */ max: string; /** * The minimum date/time offset to allow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DateTimeOffsetPickerInput.html#min) */ min: string; /** * The level of detail used to represent time. * * @default "minutes" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DateTimeOffsetPickerInput.html#timeResolution) */ timeResolution: "minutes" | "seconds" | "milliseconds"; /** * The type of form element input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DateTimeOffsetPickerInput.html#type) */ readonly type: "datetimeoffset-picker"; /** * The `DateTimeOffsetPickerInput` class defines the desired user interface for editing `timestamp-offset` field [type](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#type) input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DateTimeOffsetPickerInput.html) */ constructor(properties?: DateTimeOffsetPickerInputProperties); /** * Creates a deep clone of the `DateTimeOffsetPickerInput` class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DateTimeOffsetPickerInput.html#clone) */ clone(): DateTimeOffsetPickerInput; static fromJSON(json: any): DateTimeOffsetPickerInput; } interface DateTimeOffsetPickerInputProperties { /** * Indicates if the input should provide an option to select the time offset. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DateTimeOffsetPickerInput.html#includeTimeOffset) */ includeTimeOffset?: boolean; /** * The maximum date/time offset to allow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DateTimeOffsetPickerInput.html#max) */ max?: string; /** * The minimum date/time offset to allow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DateTimeOffsetPickerInput.html#min) */ min?: string; /** * The level of detail used to represent time. * * @default "minutes" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DateTimeOffsetPickerInput.html#timeResolution) */ timeResolution?: "minutes" | "seconds" | "milliseconds"; } export interface DateTimePickerInput extends Accessor, JSONSupport { } export class DateTimePickerInput { /** * Indicates if the input should provide an option to select the time. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DateTimePickerInput.html#includeTime) */ includeTime: boolean; /** * The maximum date to allow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DateTimePickerInput.html#max) */ max: number; /** * The minimum date to allow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DateTimePickerInput.html#min) */ min: number; /** * The type of form element input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DateTimePickerInput.html#type) */ readonly type: "datetime-picker"; /** * The `DateTimePickerInput` class defines the desired user interface for editing `date` field [type](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#type) input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DateTimePickerInput.html) */ constructor(properties?: DateTimePickerInputProperties); /** * Creates a deep clone of the `DateTimePickerInput` class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DateTimePickerInput.html#clone) */ clone(): DateTimePickerInput; static fromJSON(json: any): DateTimePickerInput; } interface DateTimePickerInputProperties { /** * Indicates if the input should provide an option to select the time. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DateTimePickerInput.html#includeTime) */ includeTime?: boolean; /** * The maximum date to allow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DateTimePickerInput.html#max) */ max?: number; /** * The minimum date to allow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DateTimePickerInput.html#min) */ min?: number; } export interface RadioButtonsInput extends Accessor, JSONSupport { } export class RadioButtonsInput { /** * The text used to represent a null value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-RadioButtonsInput.html#noValueOptionLabel) */ noValueOptionLabel: string; /** * Determines whether a null value option is displayed. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-RadioButtonsInput.html#showNoValueOption) */ showNoValueOption: boolean; /** * The type of form element input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-RadioButtonsInput.html#type) */ readonly type: "radio-buttons"; /** * The `RadioButtonsInput` class defines the desired user interface for a radio button group input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-RadioButtonsInput.html) */ constructor(properties?: RadioButtonsInputProperties); static fromJSON(json: any): RadioButtonsInput; } interface RadioButtonsInputProperties { /** * The text used to represent a null value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-RadioButtonsInput.html#noValueOptionLabel) */ noValueOptionLabel?: string; /** * Determines whether a null value option is displayed. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-RadioButtonsInput.html#showNoValueOption) */ showNoValueOption?: boolean; } export interface SwitchInput extends Accessor, JSONSupport { } export class SwitchInput { /** * Coded value used when the switch state is turned off. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-SwitchInput.html#offValue) */ offValue: string | number; /** * Coded value used when the switch state is turned on. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-SwitchInput.html#onValue) */ onValue: string | number; /** * The type of form element input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-SwitchInput.html#type) */ readonly type: "switch"; /** * The `SwitchInput` class defines the desired user interface for a binary switch or toggle. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-SwitchInput.html) */ constructor(properties?: SwitchInputProperties); static fromJSON(json: any): SwitchInput; } interface SwitchInputProperties { /** * Coded value used when the switch state is turned off. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-SwitchInput.html#offValue) */ offValue?: string | number; /** * Coded value used when the switch state is turned on. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-SwitchInput.html#onValue) */ onValue?: string | number; } export interface TextAreaInput extends JSONSupport, TextInput { } export class TextAreaInput { /** * The type of form element input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TextAreaInput.html#type) */ readonly type: "text-area"; /** * The `TextAreaInput` class defines the desired user interface as a multi-line text area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TextAreaInput.html) */ constructor(properties?: TextAreaInputProperties); /** * Creates a deep clone of the `TextAreaInput` class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TextAreaInput.html#clone) */ clone(): TextAreaInput; static fromJSON(json: any): TextAreaInput; } interface TextAreaInputProperties extends TextInputProperties { } export interface TextBoxInput extends Accessor, JSONSupport, TextInput { } export class TextBoxInput { /** * The type of form element input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TextBoxInput.html#type) */ readonly type: "text-box"; /** * The `TextBoxInput` class defines the desired user interface as a single-line text box. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TextBoxInput.html) */ constructor(properties?: TextBoxInputProperties); /** * Creates a deep clone of the `TextBoxInput` class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TextBoxInput.html#clone) */ clone(): TextBoxInput; static fromJSON(json: any): TextBoxInput; } interface TextBoxInputProperties extends TextInputProperties { } export class TextInput { /** * When set, defines the text input's maximum length. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TextInput.html#maxLength) */ maxLength: number; /** * When set, defines the text input's minimum length. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TextInput.html#minLength) */ minLength: number; } interface TextInputProperties { /** * When set, defines the text input's maximum length. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TextInput.html#maxLength) */ maxLength?: number; /** * When set, defines the text input's minimum length. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TextInput.html#minLength) */ minLength?: number; } export interface TimePickerInput extends Accessor, JSONSupport { } export class TimePickerInput { /** * The maximum time to allow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TimePickerInput.html#max) */ max: string; /** * The minimum time to allow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TimePickerInput.html#min) */ min: string; /** * The level of detail used to represent time. * * @default "minutes" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TimePickerInput.html#timeResolution) */ timeResolution: "minutes" | "seconds"; /** * The type of form element input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TimePickerInput.html#type) */ readonly type: "time-picker"; /** * The `TimePickerInput` class defines the desired user interface for editing `time-only` field [type](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#type) input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TimePickerInput.html) */ constructor(properties?: TimePickerInputProperties); /** * Creates a deep clone of the `TimePickerInput` class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TimePickerInput.html#clone) */ clone(): TimePickerInput; static fromJSON(json: any): TimePickerInput; } interface TimePickerInputProperties { /** * The maximum time to allow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TimePickerInput.html#max) */ max?: string; /** * The minimum time to allow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TimePickerInput.html#min) */ min?: string; /** * The level of detail used to represent time. * * @default "minutes" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TimePickerInput.html#timeResolution) */ timeResolution?: "minutes" | "seconds"; } /** * The `BarcodeScannerInput` class defines the desired user interface is a barcode or QR code scanner. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs.html#BarcodeScannerInput) */ export type inputsBarcodeScannerInput = BarcodeScannerInput; /** * The `ComboBoxInput` class defines the desired user interface for a combo box group. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs.html#ComboBoxInput) */ export type inputsComboBoxInput = ComboBoxInput; /** * The `DatePickerInput` class defines the desired user interface for working with date-only types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs.html#DatePickerInput) */ export type inputsDatePickerInput = DatePickerInput; /** * The `DateTimeOffsetPickerInput` class defines the desired user interface for editing date and time fields in a form that also requires the option to include an offset from Coordinated Universal Time (UTC). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs.html#DateTimeOffsetPickerInput) */ export type inputsDateTimeOffsetPickerInput = DateTimeOffsetPickerInput; /** * The `DateTimePickerInput` class defines the desired user interface for editing date (including time) fields in a form. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs.html#DateTimePickerInput) */ export type inputsDateTimePickerInput = DateTimePickerInput; /** * Form element input types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs.html#Input) */ export type inputsInput = | BarcodeScannerInput | ComboBoxInput | DatePickerInput | DateTimeOffsetPickerInput | DateTimePickerInput | RadioButtonsInput | SwitchInput | TextAreaInput | TextBoxInput | TimePickerInput; /** * The `RadioButtonsInput` class defines the desired user interface for a radio button group. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs.html#RadioButtonsInput) */ export type inputsRadioButtonsInput = RadioButtonsInput; /** * The `SwitchInput` class defines the desired user interface for a binary switch or toggle. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs.html#SwitchInput) */ export type inputsSwitchInput = SwitchInput; /** * `TextAreaInput` defines the desired user interface is a multi-line text area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs.html#TextAreaInput) */ export type inputsTextAreaInput = TextAreaInput; /** * `TextBoxInput` defines the desired user interface is a single-line text box. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs.html#TextBoxInput) */ export type inputsTextBoxInput = TextBoxInput; /** * The `TimePickerInput` class defines the desired user interface for working with time-only types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs.html#TimePickerInput) */ export type inputsTimePickerInput = TimePickerInput; export class RelationshipElement extends Element { /** * A numeric value indicating the maximum number of related features to display in the list of related records. * * @default 3 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html#displayCount) */ displayCount: number; /** * A string value indicating how to display related records within the relationship content. * * @default list * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html#displayType) */ displayType: "list"; /** * A reference to the [name](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html#name) of an [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression defined in the [expressionInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#expressionInfos) of the FormTemplate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html#editableExpression) */ editableExpression: string; /** * An array of [RelatedRecordsInfoFieldOrder](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-RelatedRecordsInfoFieldOrder.html) objects indicating the field display order for the related records and whether they should be sorted in ascending `asc` or descending `desc` order. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html#orderByFields) */ orderByFields: RelatedRecordsInfoFieldOrder[]; /** * The numeric id value for the defined relationship. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html#relationshipId) */ relationshipId: number; /** * Indicates the type of form [element](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-Element.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html#type) */ readonly type: "relationship"; /** * A `RelationshipElement` form element defines how a relationship between [feature layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) and [tables](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#tables) participates in the [FeatureForm](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html) */ constructor(properties?: RelationshipElementProperties); /** * Creates a deep clone of the RelationshipElement class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html#clone) */ clone(): RelationshipElement; static fromJSON(json: any): RelationshipElement; } interface RelationshipElementProperties extends ElementProperties { /** * A numeric value indicating the maximum number of related features to display in the list of related records. * * @default 3 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html#displayCount) */ displayCount?: number; /** * A string value indicating how to display related records within the relationship content. * * @default list * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html#displayType) */ displayType?: "list"; /** * A reference to the [name](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html#name) of an [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression defined in the [expressionInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#expressionInfos) of the FormTemplate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html#editableExpression) */ editableExpression?: string; /** * An array of [RelatedRecordsInfoFieldOrder](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-RelatedRecordsInfoFieldOrder.html) objects indicating the field display order for the related records and whether they should be sorted in ascending `asc` or descending `desc` order. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html#orderByFields) */ orderByFields?: RelatedRecordsInfoFieldOrderProperties[]; /** * The numeric id value for the defined relationship. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html#relationshipId) */ relationshipId?: number; } /** * A convenience module for importing module:esri/form/elements/inputs/Input classes when developing with [TypeScript](https://developers.arcgis.com/javascript/latest/typescript-setup/). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-support-inputs.html) */ interface inputs { } export const inputs: inputs; export class TextElement extends Element { /** * The formatted string content to display. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-TextElement.html#text) */ text: string; /** * Defines the format of the `text` property. * * @default plain-text * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-TextElement.html#textFormat) */ textFormat: "plain-text" | "markdown"; /** * The type of form element displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-TextElement.html#type) */ readonly type: "text"; /** * This class is not yet fully supported within the SDK and is not intended for use in development. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-TextElement.html) */ constructor(properties?: TextElementProperties); /** * Creates a deep clone of the TextElement class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-TextElement.html#clone) */ clone(): TextElement; static fromJSON(json: any): TextElement; } interface TextElementProperties extends ElementProperties { /** * The formatted string content to display. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-TextElement.html#text) */ text?: string; /** * Defines the format of the `text` property. * * @default plain-text * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-TextElement.html#textFormat) */ textFormat?: "plain-text" | "markdown"; } export interface ExpressionInfo extends Accessor, JSONSupport { } export class ExpressionInfo { /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Form Constraint](https://developers.arcgis.com/javascript/latest/arcade/#forms) or [Form Calculation](https://developers.arcgis.com/javascript/latest/arcade/#form-calculation) profiles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html#expression) */ expression: string; /** * The name of the expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html#name) */ name: string; /** * Indicates the return type of the Arcade expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html#returnType) */ returnType: "boolean" | "date" | "number" | "string"; /** * The title used to describe the value returned by the expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html#title) */ title: string; /** * The `ExpressionInfo` class defines the makeup of [visibility expressions](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#visibilityExpression), [required expressions](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#requiredExpression), [editable expressions](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#editableExpression), and [value expressions](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#valueExpression). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html) */ constructor(properties?: ExpressionInfoProperties); /** * Creates a deep clone of the ExpressionInfo class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html#clone) */ clone(): ExpressionInfo; static fromJSON(json: any): ExpressionInfo; } interface ExpressionInfoProperties { /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Form Constraint](https://developers.arcgis.com/javascript/latest/arcade/#forms) or [Form Calculation](https://developers.arcgis.com/javascript/latest/arcade/#form-calculation) profiles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html#expression) */ expression?: string; /** * The name of the expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html#name) */ name?: string; /** * Indicates the return type of the Arcade expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html#returnType) */ returnType?: "boolean" | "date" | "number" | "string"; /** * The title used to describe the value returned by the expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html#title) */ title?: string; } export interface FormTemplate extends Accessor, JSONSupport { } export class FormTemplate { /** * The description of the form. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#description) */ description: string; /** * An array of [form element](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-Element.html) objects that represent an ordered list of form elements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#elements) */ elements: Element[]; /** * An array of objects or [ExpressionInfo[]](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html) that reference [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expressions following the specification defined by the [Form Constraint Profile](https://developers.arcgis.com/javascript/latest/arcade/#constraint) or the [Form Calculation Profile](https://developers.arcgis.com/javascript/latest/arcade/#form-calculation). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#expressionInfos) */ expressionInfos: ExpressionInfo[]; /** * Indicates whether to retain or clear a [form's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html) [field element](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html) values. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#preserveFieldValuesWhenHidden) */ preserveFieldValuesWhenHidden: boolean; /** * The string template for defining how to format the title displayed at the top of a form. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#title) */ title: string; /** * A FormTemplate formats and defines the content of a [FeatureForm](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html) for a specific [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) or [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html) */ constructor(properties?: FormTemplateProperties); /** * Creates a deep clone of the FormTemplate class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#clone) */ clone(): FormTemplate; static fromJSON(json: any): FormTemplate; } interface FormTemplateProperties { /** * The description of the form. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#description) */ description?: string; /** * An array of [form element](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-Element.html) objects that represent an ordered list of form elements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#elements) */ elements?: ElementProperties[]; /** * An array of objects or [ExpressionInfo[]](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html) that reference [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expressions following the specification defined by the [Form Constraint Profile](https://developers.arcgis.com/javascript/latest/arcade/#constraint) or the [Form Calculation Profile](https://developers.arcgis.com/javascript/latest/arcade/#form-calculation). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#expressionInfos) */ expressionInfos?: ExpressionInfoProperties[]; /** * Indicates whether to retain or clear a [form's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html) [field element](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html) values. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#preserveFieldValuesWhenHidden) */ preserveFieldValuesWhenHidden?: boolean; /** * The string template for defining how to format the title displayed at the top of a form. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#title) */ title?: string; } /** * A convenience module for importing [Element](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-Element.html) classes when developing with [TypeScript](https://developers.arcgis.com/javascript/latest/typescript-setup/). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-support-elements.html) */ interface elements { } export const elements: elements; /** * A convenience module for importing [Geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html) classes when developing with [TypeScript](https://developers.arcgis.com/javascript/latest/typescript-setup/). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry.html) */ namespace geometry { /** * Spatial Reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry.html#SpatialReference) */ export type SpatialReference = __esri.SpatialReference; export const SpatialReference: typeof __esri.SpatialReference; /** * Geometry types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry.html#Geometry) */ export type Geometry = | __esri.Extent | __esri.Multipoint | __esri.Point | __esri.Polygon | __esri.Polyline | __esri.Mesh; /** * Extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry.html#Extent) */ export type Extent = __esri.Extent; export const Extent: typeof __esri.Extent; /** * Multipoint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry.html#Multipoint) */ export type Multipoint = __esri.Multipoint; export const Multipoint: typeof __esri.Multipoint; /** * Point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry.html#Point) */ export type Point = __esri.Point; export const Point: typeof __esri.Point; /** * Polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry.html#Polygon) */ export type Polygon = __esri.Polygon; export const Polygon: typeof __esri.Polygon; /** * Polyline. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry.html#Polyline) */ export type Polyline = __esri.Polyline; export const Polyline: typeof __esri.Polyline; /** * Mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry.html#Mesh) */ export type Mesh = __esri.Mesh; export const Mesh: typeof __esri.Mesh; } export class Circle extends Polygon { /** * The center point of the circle. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#center) */ center: Point; /** * Applicable when the spatial reference of the center point is either set to Web Mercator (wkid: 3857) or geographic/geodesic (wkid: 4326). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#geodesic) */ geodesic: boolean; /** * This value defines the number of points along the curve of the circle. * * @default 60 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#numberOfPoints) */ numberOfPoints: number; /** * The radius of the circle. * * @default 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#radius) */ radius: number; /** * Unit of the radius. * * @default meters * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#radiusUnit) */ radiusUnit: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards"; /** * A circle is a [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) created by specifying a [center point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#center) and a [radius](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#radius). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html) */ constructor(properties?: CircleProperties); /** * Creates a deep clone of Circle. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#clone) */ clone(): Circle; static fromJSON(json: any): Circle; } interface CircleProperties extends PolygonProperties { /** * The center point of the circle. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#center) */ center?: PointProperties; /** * Applicable when the spatial reference of the center point is either set to Web Mercator (wkid: 3857) or geographic/geodesic (wkid: 4326). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#geodesic) */ geodesic?: boolean; /** * This value defines the number of points along the curve of the circle. * * @default 60 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#numberOfPoints) */ numberOfPoints?: number; /** * The radius of the circle. * * @default 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#radius) */ radius?: number; /** * Unit of the radius. * * @default meters * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#radiusUnit) */ radiusUnit?: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards"; } /** * Converts between [points](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) and formatted coordinates notation strings such as: * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html) */ interface coordinateFormatter { /** * Parses coordinates in latitude/longitude notation, and returns a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing that location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#fromLatitudeLongitude) */ fromLatitudeLongitude(coordinates: string, spatialReference?: SpatialReference): Point; /** * Parses coordinates in Military Grid Reference System (MGRS) notation, and returns a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing that location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#fromMgrs) */ fromMgrs(coordinates: string, spatialReference: SpatialReference, conversionMode: | "automatic" | "new-180-in-zone-01" | "new-180-in-zone-60" | "old-180-in-zone-01" | "old-180-in-zone-60"): Point; /** * Parses coordinates in United States National Grid (USNG) notation, and returns a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing that location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#fromUsng) */ fromUsng(coordinates: string, spatialReference?: SpatialReference): Point; /** * Parses coordinates in Universal Transverse Mercator (UTM) notation, and returns a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing that location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#fromUtm) */ fromUtm(coordinates: string, spatialReference: SpatialReference, conversionMode: "latitude-band-indicators" | "north-south-indicators"): Point; /** * Indicates if all dependencies of this module have been loaded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#isLoaded) */ isLoaded(): boolean; /** * Indicates if this module is supported in the current browser. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#isSupported) */ isSupported(): boolean; /** * Load this module's dependencies. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#load) */ load(): Promise; /** * Returns formatted coordinates in latitude/longitude notation representing the given point's location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#toLatitudeLongitude) */ toLatitudeLongitude(point: Point, format: "dd" | "ddm" | "dms", decimalPlaces?: number): string; /** * Returns formatted coordinates in Military Grid Reference System (MGRS) notation representing the given point's location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#toMgrs) */ toMgrs(point: Point, conversionMode: | "automatic" | "new-180-in-zone-01" | "new-180-in-zone-60" | "old-180-in-zone-01" | "old-180-in-zone-60", precision?: number, addSpaces?: boolean): string; /** * Returns formatted coordinates in United States National Grid (USNG) notation representing the given point's location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#toUsng) */ toUsng(point: Point, precision?: number, addSpaces?: boolean): string; /** * Returns formatted coordinates in Universal Transverse Mercator (UTM) notation representing the given point's location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#toUtm) */ toUtm(point: Point, conversionMode: "latitude-band-indicators" | "north-south-indicators", addSpaces?: boolean): string; } export const coordinateFormatter: coordinateFormatter; export class Extent extends Geometry { /** * The center point of the extent in map units. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#center) */ readonly center: Point; /** * The height of the extent in map units (the distance between [ymin](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#ymin) and [ymax](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#ymax)). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#height) */ readonly height: number; /** * The maximum possible `m` value in an extent envelope. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#mmax) */ mmax: number; /** * The minimum possible `m` value of an extent envelope. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#mmin) */ mmin: number; readonly type: "extent"; /** * The width of the extent in map units (the distance between [xmin](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#xmin) and [xmax](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#xmax)). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#width) */ readonly width: number; /** * The maximum X-coordinate of an extent envelope. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#xmax) */ xmax: number; /** * The minimum X-coordinate of an extent envelope. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#xmin) */ xmin: number; /** * The maximum Y-coordinate of an extent envelope. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#ymax) */ ymax: number; /** * The minimum Y-coordinate of an extent envelope. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#ymin) */ ymin: number; /** * The maximum possible `z`, or elevation, value in an extent envelope. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#zmax) */ zmax: number; /** * The minimum possible `z`, or elevation, value of an extent envelope. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#zmin) */ zmin: number; /** * The minimum and maximum X and Y coordinates of a bounding box. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) */ constructor(properties?: ExtentProperties); /** * Centers the extent to the specified [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#centerAt) */ centerAt(point: Point): Extent; /** * Creates a deep clone of Extent object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#clone) */ clone(): Extent; /** * Checks if the input geometry is contained within the extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#contains) */ contains(geometry: Point | Extent): boolean; /** * Indicates if the input extent is equal to the testing extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#equals) */ equals(extent: Extent): boolean; /** * Expands the extent by the given factor. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#expand) */ expand(factor: number): Extent; /** * Shrinks the original extent to the intersection with the input extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#intersection) */ intersection(extent: Extent): Extent; /** * Tests to validate if the input geometry intersects the extent and returns a Boolean value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#intersects) */ intersects(geometry: Geometry): boolean; /** * Returns an array with either one Extent that's been shifted to within +/- 180 or two Extents if the original extent intersects the International Dateline. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#normalize) */ normalize(): Extent[]; /** * Modifies the extent geometry in-place with X and Y offsets in map units. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#offset) */ offset(dx: number, dy: number, dz: number): Extent; /** * Expands the original extent to include the extent of the input Extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#union) */ union(extent: Extent): Extent; static fromJSON(json: any): Extent; } interface ExtentProperties extends GeometryProperties { /** * The maximum possible `m` value in an extent envelope. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#mmax) */ mmax?: number; /** * The minimum possible `m` value of an extent envelope. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#mmin) */ mmin?: number; /** * The maximum X-coordinate of an extent envelope. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#xmax) */ xmax?: number; /** * The minimum X-coordinate of an extent envelope. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#xmin) */ xmin?: number; /** * The maximum Y-coordinate of an extent envelope. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#ymax) */ ymax?: number; /** * The minimum Y-coordinate of an extent envelope. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#ymin) */ ymin?: number; /** * The maximum possible `z`, or elevation, value in an extent envelope. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#zmax) */ zmax?: number; /** * The minimum possible `z`, or elevation, value of an extent envelope. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#zmin) */ zmin?: number; } export interface Geometry extends Accessor, JSONSupport { } export class Geometry { /** * The cache is used to store values computed from geometries that need to be cleared or recomputed upon mutation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#cache) */ readonly cache: any; /** * The extent of the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#extent) */ readonly extent: Extent; /** * Indicates if the geometry has M values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#hasM) */ hasM: boolean; /** * Indicates if the geometry has z-values (elevation). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#hasZ) */ hasZ: boolean; /** * The spatial reference of the geometry. * * @default WGS84 (wkid: 4326) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#spatialReference) */ spatialReference: SpatialReference; /** * The geometry type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#type) */ readonly type: "point" | "multipoint" | "polyline" | "polygon" | "extent" | "mesh"; /** * The base class for geometry objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html) */ constructor(properties?: GeometryProperties); /** * Creates a deep clone of the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#clone) */ clone(): Geometry; static fromJSON(json: any): Geometry; } interface GeometryProperties { /** * Indicates if the geometry has M values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#hasM) */ hasM?: boolean; /** * Indicates if the geometry has z-values (elevation). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#hasZ) */ hasZ?: boolean; /** * The spatial reference of the geometry. * * @default WGS84 (wkid: 4326) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; } /** * A client-side geometry engine for testing, measuring, and analyzing the spatial relationship between two or more 2D geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html) */ interface geometryEngine { /** * Creates planar (or Euclidean) buffer polygons at a specified distance around the input geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#buffer) */ buffer(geometry: Geometry | Geometry[], distance: number | number[], unit?: LinearUnits, unionResults?: boolean): Polygon | Polygon[]; /** * Calculates the clipped geometry from a target geometry by an envelope. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#clip) */ clip(geometry: Geometry, envelope: Extent): Geometry; /** * Indicates if one geometry contains another geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#contains) */ contains(containerGeometry: Geometry, insideGeometry: Geometry): boolean; /** * Calculates the convex hull of one or more geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#convexHull) */ convexHull(geometry: Geometry | Geometry[], merge?: boolean): Geometry | Geometry[]; /** * Indicates if one geometry crosses another geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#crosses) */ crosses(geometry1: Geometry, geometry2: Geometry): boolean; /** * Splits the input Polyline or Polygon where it crosses a cutting Polyline. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#cut) */ cut(geometry: Geometry, cutter: Polyline): Geometry[]; /** * Densify geometries by plotting points between existing vertices. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#densify) */ densify(geometry: Geometry, maxSegmentLength: number, maxSegmentLengthUnit?: LinearUnits): Geometry; /** * Creates the difference of two geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#difference) */ difference(inputGeometry: Geometry | Geometry[], subtractor: Geometry): Geometry | Geometry[]; /** * Indicates if one geometry is disjoint (doesn't intersect in any way) with another geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#disjoint) */ disjoint(geometry1: Geometry, geometry2: Geometry): boolean; /** * Calculates the shortest planar distance between two geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#distance) */ distance(geometry1: Geometry, geometry2: Geometry, distanceUnit?: LinearUnits): number; /** * Indicates if two geometries are equal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#equals) */ equals(geometry1: Geometry, geometry2: Geometry): boolean; /** * Returns an object containing additional information about the input spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#extendedSpatialReferenceInfo) */ extendedSpatialReferenceInfo(spatialReference: SpatialReference): SpatialReferenceInfo; /** * Flips a geometry on the horizontal axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#flipHorizontal) */ flipHorizontal(geometry: Geometry, flipOrigin?: Point): Geometry; /** * Flips a geometry on the vertical axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#flipVertical) */ flipVertical(geometry: Geometry, flipOrigin?: Point): Geometry; /** * Performs the generalize operation on the geometries in the cursor. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#generalize) */ generalize(geometry: Geometry, maxDeviation: number, removeDegenerateParts?: boolean, maxDeviationUnit?: LinearUnits): Geometry; /** * Calculates the area of the input geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#geodesicArea) */ geodesicArea(geometry: Polygon, unit?: AreaUnits): number; /** * Creates geodesic buffer polygons at a specified distance around the input geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#geodesicBuffer) */ geodesicBuffer(geometry: Geometry | Geometry[], distance: number | number[], unit?: LinearUnits, unionResults?: boolean): Polygon | Polygon[]; /** * Returns a geodetically densified version of the input geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#geodesicDensify) */ geodesicDensify(geometry: Polyline | Polygon, maxSegmentLength: number, maxSegmentLengthUnit?: LinearUnits): Geometry; /** * Calculates the length of the input geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#geodesicLength) */ geodesicLength(geometry: Geometry, unit?: LinearUnits): number; /** * Creates new geometries from the intersections between two geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#intersect) */ intersect(geometry1: Geometry | Geometry[], geometry2: Geometry): Geometry | Geometry[]; /** * Returns an array of points at the intersecting locations of two input polylines. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#intersectLinesToPoints) */ intersectLinesToPoints(line1: Polyline, line2: Polyline): Point[]; /** * Indicates if one geometry intersects another geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#intersects) */ intersects(geometry1: Geometry, geometry2: Geometry): boolean; /** * Indicates if the given geometry is topologically simple. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#isSimple) */ isSimple(geometry: Geometry): boolean; /** * Finds the coordinate of the geometry that is closest to the specified point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#nearestCoordinate) */ nearestCoordinate(geometry: Geometry, inputPoint: Point): NearestPointResult; /** * Finds the vertex on the geometry nearest to the specified point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#nearestVertex) */ nearestVertex(geometry: Geometry, inputPoint: Point): NearestPointResult; /** * Finds all vertices in the given distance from the specified point, sorted from the closest to the furthest and returns them as an array of Objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#nearestVertices) */ nearestVertices(geometry: Geometry, inputPoint: Point, searchRadius: number, maxVertexCountToReturn: number): NearestPointResult[]; /** * The offset operation creates a geometry that is a constant planar distance from an input polyline or polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#offset) */ offset(geometry: Geometry | Geometry[], offsetDistance: number, offsetUnit?: LinearUnits, joinType?: "round" | "bevel" | "miter" | "square", bevelRatio?: number, flattenError?: number): Geometry | Geometry[]; /** * Indicates if one geometry overlaps another geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#overlaps) */ overlaps(geometry1: Geometry, geometry2: Geometry): boolean; /** * Calculates the area of the input geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#planarArea) */ planarArea(geometry: Polygon, unit?: AreaUnits): number; /** * Calculates the length of the input geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#planarLength) */ planarLength(geometry: Geometry, unit?: LinearUnits): number; /** * Indicates if the given DE-9IM relation is true for the two geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#relate) */ relate(geometry1: Geometry, geometry2: Geometry, relation: string): boolean; /** * Rotates a geometry counterclockwise by the specified number of degrees. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#rotate) */ rotate(geometry: Geometry, angle: number, rotationOrigin?: Point): Geometry; /** * Performs the simplify operation on the geometry, which alters the given geometries to make their definitions topologically legal with respect to their geometry type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#simplify) */ simplify(geometry: Geometry): Geometry; /** * Creates the symmetric difference of two geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#symmetricDifference) */ symmetricDifference(leftGeometry: Geometry | Geometry[], rightGeometry: Geometry): Geometry | Geometry[]; /** * Indicates if one geometry touches another geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#touches) */ touches(geometry1: Geometry, geometry2: Geometry): boolean; /** * All inputs must be of the same type of geometries and share one spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#union) */ union(geometries: Geometry[]): Geometry; /** * Indicates if one geometry is within another geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#within) */ within(innerGeometry: Geometry, outerGeometry: Geometry): boolean; } export const geometryEngine: geometryEngine; /** * Units for area measurements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#AreaUnits) */ export type AreaUnits = | "acres" | "ares" | "hectares" | "square-feet" | "square-meters" | "square-yards" | "square-kilometers" | "square-miles" | number; /** * Units for linear measurements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#LinearUnits) */ export type LinearUnits = "meters" | "feet" | "kilometers" | "miles" | "nautical-miles" | "yards" | number; /** * Object returned from the [nearestCoordinate()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#nearestCoordinate), [nearestVertex()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#nearestVertex), and [nearestVertices()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#nearestVertices) methods. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#NearestPointResult) */ export interface NearestPointResult { /** * A vertex within the specified distance of the search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#NearestPointResult) */ coordinate: Point; /** * The distance from the `inputPoint` in the units of the view's spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#NearestPointResult) */ distance: number; /** * The index of the vertex within the geometry's rings or paths. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#NearestPointResult) */ vertexIndex: number; /** * Indicates if it is an empty geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#NearestPointResult) */ isEmpty: boolean; } /** * The return object of the [extendedSpatialReferenceInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#extendedSpatialReferenceInfo) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#SpatialReferenceInfo) */ export interface SpatialReferenceInfo { /** * The XY tolerance of the spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#SpatialReferenceInfo) */ tolerance: number; /** * Base factor. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#SpatialReferenceInfo) */ unitBaseFactor: number; /** * Unit ID. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#SpatialReferenceInfo) */ unitID: number; /** * Square derivative. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#SpatialReferenceInfo) */ unitSquareDerivative: number; /** * Unit type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#SpatialReferenceInfo) */ unitType: number; } /** * An asynchronous client-side geometry engine for testing, measuring, and analyzing the spatial relationship between two or more 2D geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html) */ interface geometryEngineAsync { /** * Creates planar (or Euclidean) buffer polygons at a specified distance around the input geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#buffer) */ buffer(geometry: Geometry | Geometry[], distance: number | number[], unit?: LinearUnits, unionResults?: boolean): Promise; /** * Calculates the clipped geometry from a target geometry by an envelope. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#clip) */ clip(geometry: Geometry, envelope: Extent): Promise; /** * Indicates if one geometry contains another geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#contains) */ contains(containerGeometry: Geometry, insideGeometry: Geometry): Promise; /** * Calculates the convex hull of one or more geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#convexHull) */ convexHull(geometry: Geometry | Geometry[], merge?: boolean): Promise; /** * Indicates if one geometry crosses another geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#crosses) */ crosses(geometry1: Geometry, geometry2: Geometry): Promise; /** * Split the input Polyline or Polygon where it crosses a cutting Polyline. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#cut) */ cut(geometry: Geometry, cutter: Polyline): Promise; /** * Densify geometries by plotting points between existing vertices. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#densify) */ densify(geometry: Geometry, maxSegmentLength: number, maxSegmentLengthUnit?: LinearUnits): Promise; /** * Creates the difference of two geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#difference) */ difference(inputGeometry: Geometry | Geometry[], subtractor: Geometry): Promise; /** * Indicates if one geometry is disjoint (doesn't intersect in any way) with another geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#disjoint) */ disjoint(geometry1: Geometry, geometry2: Geometry): Promise; /** * Calculates the shortest planar distance between two geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#distance) */ distance(geometry1: Geometry, geometry2: Geometry, distanceUnit?: LinearUnits): Promise; /** * Indicates if two geometries are equal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#equals) */ equals(geometry1: Geometry, geometry2: Geometry): Promise; /** * Returns an object containing additional information about the input spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#extendedSpatialReferenceInfo) */ extendedSpatialReferenceInfo(spatialReference: SpatialReference): Promise; /** * Flips a geometry on the horizontal axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#flipHorizontal) */ flipHorizontal(geometry: Geometry, flipOrigin?: Point): Promise; /** * Flips a geometry on the vertical axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#flipVertical) */ flipVertical(geometry: Geometry, flipOrigin?: Point): Promise; /** * Performs the generalize operation on the geometries in the cursor. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#generalize) */ generalize(geometry: Geometry, maxDeviation: number, removeDegenerateParts?: boolean, maxDeviationUnit?: LinearUnits): Promise; /** * Calculates the area of the input geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#geodesicArea) */ geodesicArea(geometry: Polygon, unit?: AreaUnits): Promise; /** * Creates geodesic buffer polygons at a specified distance around the input geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#geodesicBuffer) */ geodesicBuffer(geometry: Geometry | Geometry[], distance: number | number[], unit?: LinearUnits, unionResults?: boolean): Promise; /** * Returns a geodetically densified version of the input geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#geodesicDensify) */ geodesicDensify(geometry: Polyline | Polygon, maxSegmentLength: number, maxSegmentLengthUnit?: LinearUnits): Promise; /** * Calculates the length of the input geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#geodesicLength) */ geodesicLength(geometry: Geometry, unit?: LinearUnits): Promise; /** * Creates new geometries from the intersections between two geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#intersect) */ intersect(geometry1: Geometry | Geometry[], geometry2: Geometry): Promise; /** * Resolves to an array of points at the intersecting locations of two input polylines. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#intersectLinesToPoints) */ intersectLinesToPoints(line1: Polyline, line2: Polyline): Promise; /** * Indicates if one geometry intersects another geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#intersects) */ intersects(geometry1: Geometry, geometry2: Geometry): Promise; /** * Indicates if the given geometry is topologically simple. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#isSimple) */ isSimple(geometry: Geometry): Promise; /** * Finds the coordinate of the geometry that is closest to the specified point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#nearestCoordinate) */ nearestCoordinate(geometry: Geometry, inputPoint: Point): Promise; /** * Finds vertex on the geometry nearest to the specified point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#nearestVertex) */ nearestVertex(geometry: Geometry, inputPoint: Point): Promise; /** * Finds all vertices in the given distance from the specified point, sorted from the closest to the furthest and returns them as an array of Objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#nearestVertices) */ nearestVertices(geometry: Geometry, inputPoint: Point, searchRadius: number, maxVertexCountToReturn: number): Promise; /** * The offset operation creates a geometry that is a constant planar distance from an input polyline or polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#offset) */ offset(geometry: Geometry | Geometry[], offsetDistance: number, offsetUnit?: LinearUnits, joinType?: "round" | "bevel" | "miter" | "square", bevelRatio?: number, flattenError?: number): Promise; /** * Indicates if one geometry overlaps another geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#overlaps) */ overlaps(geometry1: Geometry, geometry2: Geometry): Promise; /** * Calculates the area of the input geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#planarArea) */ planarArea(geometry: Polygon, unit?: AreaUnits): Promise; /** * Calculates the length of the input geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#planarLength) */ planarLength(geometry: Geometry, unit?: LinearUnits): Promise; /** * Indicates if the given DE-9IM relation holds for the two geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#relate) */ relate(geometry1: Geometry, geometry2: Geometry, relation: string): Promise; /** * Rotates a geometry counterclockwise by the specified number of degrees. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#rotate) */ rotate(geometry: Geometry, angle: number, rotationOrigin?: Point): Promise; /** * Performs the simplify operation on the geometry, which alters the given geometries to make their definitions topologically legal with respect to their geometry type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#simplify) */ simplify(geometry: Geometry): Promise; /** * Creates the symmetric difference of two geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#symmetricDifference) */ symmetricDifference(leftGeometry: Geometry | Geometry[], rightGeometry: Geometry): Promise; /** * Indicates if one geometry touches another geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#touches) */ touches(geometry1: Geometry, geometry2: Geometry): Promise; /** * All inputs must be of the same type of geometries and share one spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#union) */ union(geometries: Geometry[]): Promise; /** * Indicates if one geometry is within another geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#within) */ within(innerGeometry: Geometry, outerGeometry: Geometry): Promise; } export const geometryEngineAsync: geometryEngineAsync; /** * The return object of the [extendedSpatialReferenceInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#extendedSpatialReferenceInfo) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#SpatialReferenceInfo) */ export interface geometryEngineAsyncSpatialReferenceInfo { /** * The XY tolerance of the spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#SpatialReferenceInfo) */ tolerance: number; /** * Base factor. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#SpatialReferenceInfo) */ unitBaseFactor: number; /** * Unit ID. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#SpatialReferenceInfo) */ unitID: number; /** * Square derivative. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#SpatialReferenceInfo) */ unitSquareDerivative: number; /** * Unit type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#SpatialReferenceInfo) */ unitType: number; } export interface HeightModelInfo extends Accessor, JSONSupport { } export class HeightModelInfo { /** * The surface type or height model of the vertical coordinate system (VCS). * * @default "gravity-related-height" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-HeightModelInfo.html#heightModel) */ readonly heightModel: "gravity-related-height" | "ellipsoidal"; /** * The unit of the vertical coordinate system. * * @default "meters" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-HeightModelInfo.html#heightUnit) */ readonly heightUnit: | "meters" | "feet" | "us-feet" | "clarke-feet" | "clarke-yards" | "clarke-links" | "sears-yards" | "sears-feet" | "sears-chains" | "benoit-1895-b-chains" | "indian-yards" | "indian-1937-yards" | "gold-coast-feet" | "sears-1922-truncated-chains" | "50-kilometers" | "150-kilometers"; /** * The datum realization of the vertical coordinate system. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-HeightModelInfo.html#vertCRS) */ readonly vertCRS: string; /** * The height model info defines the characteristics of a vertical coordinate system. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-HeightModelInfo.html) */ constructor(properties?: HeightModelInfoProperties); static fromJSON(json: any): HeightModelInfo; } interface HeightModelInfoProperties { /** * The surface type or height model of the vertical coordinate system (VCS). * * @default "gravity-related-height" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-HeightModelInfo.html#heightModel) */ heightModel?: "gravity-related-height" | "ellipsoidal"; /** * The unit of the vertical coordinate system. * * @default "meters" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-HeightModelInfo.html#heightUnit) */ heightUnit?: | "meters" | "feet" | "us-feet" | "clarke-feet" | "clarke-yards" | "clarke-links" | "sears-yards" | "sears-feet" | "sears-chains" | "benoit-1895-b-chains" | "indian-yards" | "indian-1937-yards" | "gold-coast-feet" | "sears-1922-truncated-chains" | "50-kilometers" | "150-kilometers"; /** * The datum realization of the vertical coordinate system. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-HeightModelInfo.html#vertCRS) */ vertCRS?: string; } export interface Mesh extends Geometry, Loadable { } export class Mesh { /** * An array of mesh components that can be used to apply materials to different regions of the same mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#components) */ components: MeshComponent[]; /** * Additional local transformation of the mesh vertices. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#transform) */ transform: MeshTransform; /** * The string value representing the type of geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#type) */ readonly type: "mesh"; /** * Object describing the attributes of each vertex of the mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) */ vertexAttributes: MeshVertexAttributes; /** * The vertex space of the mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexSpace) */ vertexSpace: MeshGeoreferencedVertexSpace | MeshLocalVertexSpace; /** * A mesh is a general, client-side 3D [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html) type composed of [vertices with attributes](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html) */ constructor(properties?: MeshProperties); /** * Adds a component to the mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#addComponent) */ addComponent(component: MeshComponent | MeshComponentProperties): void; /** * Centers the mesh at the specified location without changing its scale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#centerAt) */ centerAt(location: Point, params?: MeshCenterAtParams): Mesh; /** * Creates a deep clone of the Mesh object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#clone) */ clone(): Mesh; /** * Offsets the mesh geometry by the specified distance in x, y, and z. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#offset) */ offset(dx: number, dy: number, dz: number): Mesh; /** * Removes a component from the mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#removeComponent) */ removeComponent(component: MeshComponent): void; /** * Rotates the mesh geometry around its x, y and z axis (in that order). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#rotate) */ rotate(angleX: number, angleY: number, angleZ: number, params?: MeshRotateParams): Mesh; /** * Scales the mesh geometry by the specified factor. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#scale) */ scale(factor: number, params?: MeshScaleParams): Mesh; /** * Notifies that any cached values that depend on vertex attributes need to be recalculated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributesChanged) */ vertexAttributesChanged(): void; /** * Creates a mesh representing a box. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createBox) */ static createBox(location: Point, params?: CreateBoxParameters): Mesh; /** * Creates a mesh representing a cylinder. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createCylinder) */ static createCylinder(location: Point, params?: CreateCylinderParameters): Mesh; /** * Creates a mesh geometry from a file or list of files and which is ready to be displayed in the view. * * @deprecated Use {@link module:module:esri/layers/SceneLayer~convertMesh convertMesh} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createFromFiles) */ static createFromFiles(location: Point, files: any[], params?: MeshCreateFromFilesParams): Promise; /** * Creates a new mesh geometry from a glTF model referenced by the `url` parameter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createFromGLTF) */ static createFromGLTF(location: Point, url: string, params?: CreateFromGLTFParameters): Promise; /** * Creates a new mesh geometry from a polygon geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createFromPolygon) */ static createFromPolygon(polygon: Polygon, params?: MeshCreateFromPolygonParams): Mesh; /** * Creates a mesh representing a plane. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createPlane) */ static createPlane(location: Point, params?: CreatePlaneParameters): Mesh; /** * Creates a mesh representing a sphere. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createSphere) */ static createSphere(location: Point, params?: CreateSphereParameters): Mesh; static fromJSON(json: any): Mesh; } interface MeshProperties extends GeometryProperties, LoadableProperties { /** * An array of mesh components that can be used to apply materials to different regions of the same mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#components) */ components?: MeshComponentProperties[]; /** * Additional local transformation of the mesh vertices. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#transform) */ transform?: MeshTransformProperties; /** * Object describing the attributes of each vertex of the mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) */ vertexAttributes?: MeshVertexAttributesProperties; /** * The vertex space of the mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexSpace) */ vertexSpace?: | (MeshGeoreferencedVertexSpaceProperties & { type: "georeferenced" }) | (MeshLocalVertexSpaceProperties & { type: "local" }); } /** * Options used to configure box mesh creation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateBoxParameters) */ export interface CreateBoxParameters { /** * A uniform size value or an object containing individual values width, height and depth. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateBoxParameters) */ size?: number | CreateBoxParametersSize; /** * DEPRECATED: Use vertexSpace option instead - Whether to georeference relative to the globe or the projected coordinate system (PCS). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateBoxParameters) */ geographic?: boolean; /** * The unit of the size (defaults to the unit of the location's spatial reference). * * [Read more...](global.html#unit) */ unit?: | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"; /** * Specifies the vertex space of the created mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateBoxParameters) */ vertexSpace?: "local" | "georeferenced"; /** * The material to be used for the mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateBoxParameters) */ material?: MeshMaterial; /** * The face for generating image uv coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateBoxParameters) */ imageFace?: string; } /** * Options used to configure cylinder mesh creation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateCylinderParameters) */ export interface CreateCylinderParameters { /** * A uniform size value or an object containing individual values width, height and depth. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateCylinderParameters) */ size?: number | any; /** * The width of the created mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateCylinderParameters) */ width?: number; /** * The depth of the created mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateCylinderParameters) */ depth?: number; /** * The height of the created mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateCylinderParameters) */ height?: number; /** * DEPRECATED: Use vertexSpace option instead - Whether to georeference relative to the globe or the projected coordinate system (PCS). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateCylinderParameters) */ geographic?: boolean; /** * The additional number of subdivisions for generating the mesh representing a sphere. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateCylinderParameters) */ densificationFactor?: number; /** * Specifies the vertex space of the created mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateCylinderParameters) */ vertexSpace?: "local" | "georeferenced"; /** * The material to be used for the mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateCylinderParameters) */ material?: MeshMaterial; } /** * Options used to configure gltf mesh creation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateFromGLTFParameters) */ export interface CreateFromGLTFParameters { /** * DEPRECATED: Use vertexSpace option instead - Whether to georeference relative to the globe or the projected coordinate system (PCS). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateFromGLTFParameters) */ geographic?: boolean; /** * An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to abort the loading process. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateFromGLTFParameters) */ signal?: AbortSignal; /** * Specifies the vertex space of the created mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateFromGLTFParameters) */ vertexSpace?: "local" | "georeferenced"; /** * The material to be used for the mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateFromGLTFParameters) */ material?: MeshMaterial; } /** * Options used to configure plane mesh creation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreatePlaneParameters) */ export interface CreatePlaneParameters { /** * A uniform size value or an object containing individual values width, height and depth. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreatePlaneParameters) */ size?: number | any; /** * The width of the created mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreatePlaneParameters) */ width?: number; /** * The depth of the created mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreatePlaneParameters) */ depth?: number; /** * The height of the created mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreatePlaneParameters) */ height?: number; /** * DEPRECATED: Use vertexSpace option instead - Whether to georeference relative to the globe or the projected coordinate system (PCS). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreatePlaneParameters) */ geographic?: boolean; /** * The additional number of subdivisions for generating the mesh representing a sphere. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreatePlaneParameters) */ densificationFactor?: number; /** * Specifies the vertex space of the created mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreatePlaneParameters) */ vertexSpace?: "local" | "georeferenced"; /** * The material to be used for the mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreatePlaneParameters) */ material?: MeshMaterial; } /** * Options used to configure sphere mesh creation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateSphereParameters) */ export interface CreateSphereParameters { /** * A uniform size value or an object containing individual values width, height and depth. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateSphereParameters) */ size?: number | any; /** * The width of the created mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateSphereParameters) */ width?: number; /** * The depth of the created mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateSphereParameters) */ depth?: number; /** * The height of the created mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateSphereParameters) */ height?: number; /** * DEPRECATED: Use vertexSpace option instead - Whether to georeference relative to the globe or the projected coordinate system (PCS). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateSphereParameters) */ geographic?: boolean; /** * The additional number of subdivisions for generating the mesh representing a sphere. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateSphereParameters) */ densificationFactor?: number; /** * Specifies the vertex space of the created mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateSphereParameters) */ vertexSpace?: "local" | "georeferenced"; /** * The material to be used for the mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateSphereParameters) */ material?: MeshMaterial; } export interface MeshCenterAtParams { /** * Whether to georeference relative to the globe or the projected coordinate system (PCS). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#centerAt) */ geographic?: boolean; /** * The origin at which to center. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#centerAt) */ origin?: Point; } export interface MeshCreateFromFilesParams { /** * The layer to which the files are to be uploaded and which will perform any necessary conversions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createFromFiles) */ layer?: SceneLayer; /** * An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to abort the loading process. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createFromFiles) */ signal?: AbortSignal; } export interface MeshCreateFromPolygonParams { /** * The material to be used for the mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createFromPolygon) */ material?: MeshMaterial; } export interface MeshRotateParams { /** * Whether to georeference relative to the globe or the projected coordinate system (PCS). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#rotate) */ geographic?: boolean; /** * The origin around which to rotate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#rotate) */ origin?: Point; } export interface MeshScaleParams { /** * Whether to georeference relative to the globe or the projected coordinate system (PCS). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#scale) */ geographic?: boolean; /** * The origin point for scaling. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#scale) */ origin?: Point; } export interface MeshVertexAttributesProperties { /** * A flat array of vertex positions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) */ position?: Float64Array | number[] | Float32Array; /** * A flat array of vertex uv coordinates (2 elements per vertex). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) */ uv?: Float32Array | number[] | Float64Array; /** * A flat array of the vertex normals (3 elements per vertex ranging from -1 to 1). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) */ normal?: Float32Array | number[] | Float64Array; /** * **Since: 4.9** A flat array of the vertex colors (4 elements per vertex ranging from 0 to 255). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) */ color?: Uint8Array | number[] | Uint8ClampedArray; /** * **Since: 4.11** A flat array of the vertex tangents (4 elements per vertex ranging from -1 to 1. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) */ tangent?: Float32Array | number[] | Float64Array; } export interface MeshVertexAttributes extends AnonymousAccessor { /** * A flat array of vertex positions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) */ position: Float64Array; /** * A flat array of vertex uv coordinates (2 elements per vertex). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) */ uv?: Float32Array; /** * A flat array of the vertex normals (3 elements per vertex ranging from -1 to 1). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) */ normal?: Float32Array; /** * **Since: 4.9** A flat array of the vertex colors (4 elements per vertex ranging from 0 to 255). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) */ color?: Uint8Array; /** * **Since: 4.11** A flat array of the vertex tangents (4 elements per vertex ranging from -1 to 1. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) */ tangent?: Float32Array; } export interface CreateBoxParametersSize { /** * The width of the created mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateBoxParameters) */ width?: number; /** * The depth of the created mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateBoxParameters) */ depth?: number; /** * The height of the created mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#CreateBoxParameters) */ height?: number; } export class Multipoint extends Geometry { /** * An array of points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html#points) */ points: number[][]; /** * The string value representing the type of geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html#type) */ readonly type: "multipoint"; /** * An ordered collection of points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html) */ constructor(properties?: MultipointProperties); /** * Adds a point to the Multipoint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html#addPoint) */ addPoint(point: Point | number[]): Multipoint; /** * Creates a deep clone of Multipoint object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html#clone) */ clone(): Multipoint; /** * Returns the point at the specified index. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html#getPoint) */ getPoint(index: number): Point; /** * Removes a point from the Multipoint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html#removePoint) */ removePoint(index: number): Point; /** * Updates the point at the specified index. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html#setPoint) */ setPoint(index: number, point: Point | number[]): Multipoint; static fromJSON(json: any): Multipoint; } interface MultipointProperties extends GeometryProperties { /** * An array of points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html#points) */ points?: number[][]; } export class Point extends Geometry { /** * The latitude of the point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#latitude) */ latitude: number; /** * The longitude of the point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#longitude) */ longitude: number; /** * The m-coordinate of the point in map units. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#m) */ m: number; /** * The string value representing the type of geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#type) */ readonly type: "point"; /** * The x-coordinate (easting) of the point in map units. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#x) */ x: number; /** * The y-coordinate (northing) of the point in map units. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#y) */ y: number; /** * The z-coordinate (or elevation) of the point in map units. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#z) */ z: number; /** * A location defined by X, Y, and Z coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) */ constructor(properties?: PointProperties); /** * Creates a deep clone of Point object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#clone) */ clone(): Point; /** * Copies all values from another Point instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#copy) */ copy(other: Point): void; /** * Computes the Euclidean distance between this Point and a given Point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#distance) */ distance(other: Point): number; /** * Determines if the input point is equal to the point calling the function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#equals) */ equals(point: Point): boolean; /** * Modifies the point geometry in-place by shifting the X-coordinate to within +/- 180 span in map units. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#normalize) */ normalize(): Point; static fromJSON(json: any): Point; } interface PointProperties extends GeometryProperties { /** * The latitude of the point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#latitude) */ latitude?: number; /** * The longitude of the point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#longitude) */ longitude?: number; /** * The m-coordinate of the point in map units. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#m) */ m?: number; /** * The x-coordinate (easting) of the point in map units. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#x) */ x?: number; /** * The y-coordinate (northing) of the point in map units. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#y) */ y?: number; /** * The z-coordinate (or elevation) of the point in map units. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#z) */ z?: number; } export class Polygon extends Geometry { /** * The centroid of the polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#centroid) */ centroid: Point; /** * Checks to see if polygon rings cross each other and indicates if the polygon is self-intersecting, which means the ring of the polygon crosses itself. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#isSelfIntersecting) */ isSelfIntersecting: boolean; /** * An array of rings. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#rings) */ rings: number[][][]; /** * The string value representing the type of geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#type) */ readonly type: "polygon"; /** * A polygon contains an array of [rings](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#rings) and a [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#spatialReference). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) */ constructor(properties?: PolygonProperties); /** * Adds a ring to the Polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#addRing) */ addRing(points: Point[] | number[][]): Polygon; /** * Creates a deep clone of Polygon object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#clone) */ clone(): Polygon; /** * Checks on the client if the input point is inside the polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#contains) */ contains(point: Point): boolean; /** * Returns a point specified by a ring and point in the path. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#getPoint) */ getPoint(ringIndex: number, pointIndex: number): Point; /** * Inserts a new point into the polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#insertPoint) */ insertPoint(ringIndex: number, pointIndex: number, point: Point | number[]): Polygon; /** * Checks if a Polygon ring is clockwise. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#isClockwise) */ isClockwise(ring: Point[] | number[][]): boolean; /** * Removes a point from the polygon at the given `pointIndex` within the ring identified by `ringIndex`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#removePoint) */ removePoint(ringIndex: number, pointIndex: number): Point[]; /** * Removes a ring from the Polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#removeRing) */ removeRing(index: number): Point[]; /** * Updates a point in the polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#setPoint) */ setPoint(ringIndex: number, pointIndex: number, point: Point | number[]): Polygon; /** * Converts the given Extent to a Polygon instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#fromExtent) */ static fromExtent(extent: Extent): Polygon; static fromJSON(json: any): Polygon; } interface PolygonProperties extends GeometryProperties { /** * The centroid of the polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#centroid) */ centroid?: PointProperties; /** * Checks to see if polygon rings cross each other and indicates if the polygon is self-intersecting, which means the ring of the polygon crosses itself. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#isSelfIntersecting) */ isSelfIntersecting?: boolean; /** * An array of rings. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#rings) */ rings?: number[][][]; } export class Polyline extends Geometry { /** * An array of paths, or line segments, that make up the polyline. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#paths) */ paths: number[][][]; readonly type: "polyline"; /** * A polyline contains an array of [paths](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#paths) and [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#spatialReference). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) */ constructor(properties?: PolylineProperties); /** * Adds a path, or line segment, to the polyline. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#addPath) */ addPath(points: Point[] | number[][]): Polyline; /** * Creates a deep clone of Polyline object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#clone) */ clone(): Polyline; /** * Returns a point specified by a path and point in the path. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#getPoint) */ getPoint(pathIndex: number, pointIndex: number): Point; /** * Inserts a new point into a polyline. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#insertPoint) */ insertPoint(pathIndex: number, pointIndex: number, point: Point | number[]): Polyline; /** * Removes a path from the Polyline. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#removePath) */ removePath(index: number): Point[]; /** * Removes a point from the polyline at the given `pointIndex` within the path identified by the given `pathIndex`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#removePoint) */ removePoint(pathIndex: number, pointIndex: number): Point; /** * Updates a point in a polyline. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#setPoint) */ setPoint(pathIndex: number, pointIndex: number, point: Point | number[]): Polyline; static fromJSON(json: any): Polyline; } interface PolylineProperties extends GeometryProperties { /** * An array of paths, or line segments, that make up the polyline. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#paths) */ paths?: number[][][]; } /** * A client-side projection engine for converting geometries from one [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) to another. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html) */ interface projection { /** * Returns the default geographic transformation used to convert the geometry from the input spatial reference to the output spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html#getTransformation) */ getTransformation(inSpatialReference: SpatialReference | SpatialReferenceProperties, outSpatialReference: SpatialReference | SpatialReferenceProperties, extent?: Extent): GeographicTransformation; /** * Returns a list of all geographic transformations suitable to convert geometries from the input spatial reference to the specified output spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html#getTransformations) */ getTransformations(inSpatialReference: SpatialReference | SpatialReferenceProperties, outSpatialReference: SpatialReference | SpatialReferenceProperties, extent?: Extent): GeographicTransformation[]; /** * Indicates if all dependencies of this module have been loaded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html#isLoaded) */ isLoaded(): boolean; /** * Loads this module's dependencies. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html#load) */ load(): Promise; /** * Projects a geometry or an array of geometries to the specified output spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html#project) */ project(geometry: Geometry | Geometry[], outSpatialReference: SpatialReference | SpatialReferenceProperties, geographicTransformation?: GeographicTransformation): Geometry | Geometry[]; } export const projection: projection; export interface SpatialReference extends Accessor, JSONSupport { } export class SpatialReference { /** * An [image coordinate system](https://developers.arcgis.com/rest/services-reference/raster-ics.htm) defines the spatial reference used to display the image in its original coordinates without distortion, map transformations or ortho-rectification. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#imageCoordinateSystem) */ imageCoordinateSystem: any; /** * Indicates if the spatial reference refers to a geographic coordinate system. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isGeographic) */ readonly isGeographic: boolean; /** * Indicates if the [wkid](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkid) of the spatial reference object is one of the following values: `102113`, `102100`, `3857`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isWebMercator) */ readonly isWebMercator: boolean; /** * Indicates if the [wkid](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkid) of the spatial reference object is `4326`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isWGS84) */ readonly isWGS84: boolean; /** * Indicates if the spatial reference of the map supports wrapping around the International Date Line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isWrappable) */ readonly isWrappable: boolean; /** * The factor to convert one unit value in the spatial reference's [unit](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#unit) to meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#metersPerUnit) */ readonly metersPerUnit: number; /** * The unit of the spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#unit) */ readonly unit: | null | "degrees" | "meters" | "feet" | "us-feet" | "clarke-feet" | "clarke-yards" | "clarke-links" | "sears-yards" | "sears-feet" | "sears-chains" | "benoit-1895-b-chains" | "indian-yards" | "indian-1937-yards" | "gold-coast-feet" | "sears-1922-truncated-chains" | "50-kilometers" | "150-kilometers"; /** * The well-known ID of a spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkid) */ wkid: number; /** * The well-known text that defines a spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkt) */ wkt: string; /** * The well-known text of the coordinate system as defined by OGC standard for well-known text strings. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkt2) */ wkt2: string; /** * A convenience spatial reference instance for Web Mercator. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#WebMercator) */ static WebMercator: SpatialReference; /** * A convenience spatial reference instance for WGS84. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#WGS84) */ static WGS84: SpatialReference; /** * Defines the spatial reference of a view, layer, or method parameters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) */ constructor(properties?: SpatialReferenceProperties); /** * Returns a deep clone of the spatial reference object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#clone) */ clone(): SpatialReference; /** * Checks if the specified spatial reference object has the same [wkid](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkid) or [wkt](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkt) as this spatial reference object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#equals) */ equals(spatialReference: SpatialReference): boolean; static fromJSON(json: any): SpatialReference; } interface SpatialReferenceProperties { /** * An [image coordinate system](https://developers.arcgis.com/rest/services-reference/raster-ics.htm) defines the spatial reference used to display the image in its original coordinates without distortion, map transformations or ortho-rectification. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#imageCoordinateSystem) */ imageCoordinateSystem?: any; /** * The well-known ID of a spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkid) */ wkid?: number; /** * The well-known text that defines a spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkt) */ wkt?: string; /** * The well-known text of the coordinate system as defined by OGC standard for well-known text strings. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkt2) */ wkt2?: string; } /** * This class performs geodetic computations for Earth and 70+ non-Earth spheroids. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-geodesicUtils.html) */ interface geodesicUtils { /** * Geodetically computes the area for one or more polygons. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-geodesicUtils.html#geodesicAreas) */ geodesicAreas(polygons: Polygon[], unit?: | "square-millimeters" | "square-centimeters" | "square-decimeters" | "square-meters" | "square-kilometers" | "square-inches" | "square-feet" | "square-yards" | "square-miles" | "square-us-feet" | "acres" | "ares" | "hectares"): number[]; /** * Computes and returns a densified polyline or polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-geodesicUtils.html#geodesicDensify) */ geodesicDensify(geometry: Polyline | Polygon, maxSegmentLength: number): Polyline | Polygon; /** * Geodetically computes the direction and distance between two known locations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-geodesicUtils.html#geodesicDistance) */ geodesicDistance(from: Point, to: Point, unit?: | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"): GeodesicDistanceResult; /** * Geodetically computes polygon perimeter or polyline length for one or more geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-geodesicUtils.html#geodesicLengths) */ geodesicLengths(geometries: Polyline[] | Polygon[], unit?: | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"): number[]; /** * Geodetically computes the location at a defined distance and direction from a known location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-geodesicUtils.html#pointFromDistance) */ pointFromDistance(point: Point, distance: number, azimuth: number): Point; } export const geodesicUtils: geodesicUtils; /** * Computed distance and direction between two known locations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-geodesicUtils.html#GeodesicDistanceResult) */ export interface GeodesicDistanceResult { /** * The distance between the two locations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-geodesicUtils.html#GeodesicDistanceResult) */ distance?: number; /** * The azimuth (or "bearing") in degrees. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-geodesicUtils.html#GeodesicDistanceResult) */ azimuth?: number; /** * The azimuth in degrees in the reverse direction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-geodesicUtils.html#GeodesicDistanceResult) */ reverseAzimuth?: number; } export class GeographicTransformation { /** * Geographic transformation steps. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-GeographicTransformation.html#steps) */ steps: GeographicTransformationStep[]; constructor(properties?: any); /** * Returns the inverse of the geographic transformation calling this method or `null` if the transformation is not invertible. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-GeographicTransformation.html#getInverse) */ getInverse(): GeographicTransformation; } export class GeographicTransformationStep { /** * Indicates with the geographic transformation is inverted. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-GeographicTransformationStep.html#isInverse) */ isInverse: boolean; /** * The well-known id (wkid) hat represents a known geographic transformation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-GeographicTransformationStep.html#wkid) */ wkid: number; /** * The well-known text (wkt) that represents a known geographic transformation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-GeographicTransformationStep.html#wkt) */ wkt: string; constructor(properties?: any); /** * Gets the inverse of the geographic transformation step used to call this method or `null` if the transformation step is not invertible. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-GeographicTransformationStep.html#getInverse) */ getInverse(): GeographicTransformationStep; } /** * Provides utility methods for working with ArcGIS JSON geometry objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-jsonUtils.html) */ interface jsonUtils { /** * Creates a new instance of an appropriate [Geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html) class and initializes it with values from a JSON object generated from an ArcGIS product. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-jsonUtils.html#fromJSON) */ fromJSON(json: any): Geometry; /** * Returns the type for a given geometry in the JSON format used by ArcGIS. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-jsonUtils.html#getJsonType) */ getJsonType(geometry: Geometry): string; } export const jsonUtils: jsonUtils; export class MeshComponent extends Accessor { /** * A flat array of indices that refer to vertices in the [vertexAttributes](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) of the mesh to which the component belongs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html#faces) */ faces: Uint32Array; /** * The material determines how the component is visualized. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html#material) */ material: MeshMaterial | MeshMaterialMetallicRoughness; /** * Specifies a name of the component. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html#name) */ name: string; /** * Specifies the type of normals used for lighting. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html#shading) */ shading: "source" | "flat" | "smooth"; /** * The MeshComponent class is used to apply one or more materials to a single [Mesh](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html) */ constructor(properties?: MeshComponentProperties); /** * Creates a deep clone. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html#clone) */ clone(): MeshComponent; } interface MeshComponentProperties { /** * A flat array of indices that refer to vertices in the [vertexAttributes](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) of the mesh to which the component belongs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html#faces) */ faces?: Uint32Array | number[] | Uint16Array; /** * The material determines how the component is visualized. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html#material) */ material?: MeshMaterialProperties | MeshMaterialMetallicRoughnessProperties; /** * Specifies a name of the component. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html#name) */ name?: string; /** * Specifies the type of normals used for lighting. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html#shading) */ shading?: "source" | "flat" | "smooth"; } export interface MeshGeoreferencedVertexSpace extends Accessor, JSONSupport { } export class MeshGeoreferencedVertexSpace { /** * Origin of the vertex space. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshGeoreferencedVertexSpace.html#origin) */ origin: number[]; /** * Type of the vertex space. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshGeoreferencedVertexSpace.html#type) */ readonly type: "georeferenced"; /** * A mesh vertex space that indicates mesh vertices to be either absolute georeferenced map coordinates or relative offsets in map space to a fully georeferenced origin. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshGeoreferencedVertexSpace.html) */ constructor(properties?: MeshGeoreferencedVertexSpaceProperties); static fromJSON(json: any): MeshGeoreferencedVertexSpace; } interface MeshGeoreferencedVertexSpaceProperties { /** * Origin of the vertex space. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshGeoreferencedVertexSpace.html#origin) */ origin?: number[]; } export interface MeshLocalVertexSpace extends Accessor, JSONSupport { } export class MeshLocalVertexSpace { /** * Origin of the vertex space. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshLocalVertexSpace.html#origin) */ origin: number[]; /** * Type of the vertex space. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshLocalVertexSpace.html#type) */ readonly type: "local"; /** * A mesh vertex space that indicates mesh vertices to be in a plain cartesian space as often encountered in 3D modeling and CAD applications. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshLocalVertexSpace.html) */ constructor(properties?: MeshLocalVertexSpaceProperties); static fromJSON(json: any): MeshLocalVertexSpace; } interface MeshLocalVertexSpaceProperties { /** * Origin of the vertex space. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshLocalVertexSpace.html#origin) */ origin?: number[]; } export class MeshMaterial extends Accessor { /** * Specifies how transparency on the object is handled. * * @default 0.5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterial.html#alphaCutoff) */ alphaCutoff: number; /** * Specifies how transparency on the object is handled. * * @default "auto" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterial.html#alphaMode) */ alphaMode: "auto" | "blend" | "opaque" | "mask"; /** * Specifies a single, uniform color for the mesh component. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterial.html#color) */ color: Color; /** * Specifies a texture from which to get color information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterial.html#colorTexture) */ colorTexture: MeshTexture; /** * A transformation of UV mesh coordinates used to sample the color texture. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterial.html#colorTextureTransform) */ colorTextureTransform: MeshTextureTransform; /** * Specifies whether both sides of each triangle are displayed, or only the front sides. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterial.html#doubleSided) */ doubleSided: boolean; /** * Specifies a texture from which to get normal information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterial.html#normalTexture) */ normalTexture: MeshTexture; /** * A transformation of UV mesh coordinates used to sample the normal texture. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterial.html#normalTextureTransform) */ normalTextureTransform: MeshTextureTransform; /** * The material determines how a [MeshComponent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html) is visualized. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterial.html) */ constructor(properties?: MeshMaterialProperties); } interface MeshMaterialProperties { /** * Specifies how transparency on the object is handled. * * @default 0.5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterial.html#alphaCutoff) */ alphaCutoff?: number; /** * Specifies how transparency on the object is handled. * * @default "auto" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterial.html#alphaMode) */ alphaMode?: "auto" | "blend" | "opaque" | "mask"; /** * Specifies a single, uniform color for the mesh component. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterial.html#color) */ color?: Color | number[] | string; /** * Specifies a texture from which to get color information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterial.html#colorTexture) */ colorTexture?: MeshTextureProperties | HTMLImageElement | HTMLCanvasElement | ImageData | string; /** * A transformation of UV mesh coordinates used to sample the color texture. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterial.html#colorTextureTransform) */ colorTextureTransform?: MeshTextureTransformProperties; /** * Specifies whether both sides of each triangle are displayed, or only the front sides. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterial.html#doubleSided) */ doubleSided?: boolean; /** * Specifies a texture from which to get normal information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterial.html#normalTexture) */ normalTexture?: MeshTextureProperties | HTMLImageElement | HTMLCanvasElement | ImageData | string; /** * A transformation of UV mesh coordinates used to sample the normal texture. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterial.html#normalTextureTransform) */ normalTextureTransform?: MeshTextureTransformProperties; } export class MeshMaterialMetallicRoughness extends MeshMaterial { /** * Specifies a single, uniform emissive color for the [MeshComponent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterialMetallicRoughness.html#emissiveColor) */ emissiveColor: Color; /** * Specifies a texture from which to get emissive color information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterialMetallicRoughness.html#emissiveTexture) */ emissiveTexture: MeshTexture; /** * A transformation of UV mesh coordinates used to sample the emissive texture. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterialMetallicRoughness.html#emissiveTextureTransform) */ emissiveTextureTransform: MeshTextureTransform; /** * Specifies how much the material behaves like a metal. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterialMetallicRoughness.html#metallic) */ metallic: number; /** * Specifies a texture from which to get the combined metallic/roughness information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterialMetallicRoughness.html#metallicRoughnessTexture) */ metallicRoughnessTexture: MeshTexture; /** * Allows to specify a texture to get the occlusion information from. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterialMetallicRoughness.html#occlusionTexture) */ occlusionTexture: MeshTexture; /** * A transformation of UV mesh coordinates used to sample the occlusion texture. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterialMetallicRoughness.html#occlusionTextureTransform) */ occlusionTextureTransform: MeshTextureTransform; /** * Indicates how rough the surface of the material is. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterialMetallicRoughness.html#roughness) */ roughness: number; /** * A material determines how a [MeshComponent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html) is visualized. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterialMetallicRoughness.html) */ constructor(properties?: MeshMaterialMetallicRoughnessProperties); } interface MeshMaterialMetallicRoughnessProperties extends MeshMaterialProperties { /** * Specifies a single, uniform emissive color for the [MeshComponent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterialMetallicRoughness.html#emissiveColor) */ emissiveColor?: Color | number[] | string; /** * Specifies a texture from which to get emissive color information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterialMetallicRoughness.html#emissiveTexture) */ emissiveTexture?: MeshTextureProperties | HTMLImageElement | HTMLCanvasElement | ImageData | string; /** * A transformation of UV mesh coordinates used to sample the emissive texture. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterialMetallicRoughness.html#emissiveTextureTransform) */ emissiveTextureTransform?: MeshTextureTransformProperties; /** * Specifies how much the material behaves like a metal. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterialMetallicRoughness.html#metallic) */ metallic?: number; /** * Specifies a texture from which to get the combined metallic/roughness information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterialMetallicRoughness.html#metallicRoughnessTexture) */ metallicRoughnessTexture?: MeshTextureProperties | HTMLImageElement | HTMLCanvasElement | ImageData | string; /** * Allows to specify a texture to get the occlusion information from. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterialMetallicRoughness.html#occlusionTexture) */ occlusionTexture?: MeshTextureProperties | HTMLImageElement | HTMLCanvasElement | ImageData | string; /** * A transformation of UV mesh coordinates used to sample the occlusion texture. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterialMetallicRoughness.html#occlusionTextureTransform) */ occlusionTextureTransform?: MeshTextureTransformProperties; /** * Indicates how rough the surface of the material is. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterialMetallicRoughness.html#roughness) */ roughness?: number; } export class MeshTexture extends Accessor { /** * A direct reference to the image or video data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTexture.html#data) */ data: HTMLImageElement | HTMLCanvasElement | any | ImageData; /** * Indicates whether the image data should be interpreted as being semi-transparent. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTexture.html#transparent) */ transparent: boolean; /** * The url to the image resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTexture.html#url) */ url: string; /** * Specifies how uv coordinates outside the [0, 1] range are handled. * * @default "repeat" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTexture.html#wrap) */ wrap: "clamp" | "repeat" | "mirror" | SeparableWrapModes; /** * MeshTexture represents image data to be used for [MeshMaterial](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterial.html) or [MeshMaterialMetallicRoughness](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterialMetallicRoughness.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTexture.html) */ constructor(properties?: MeshTextureProperties); /** * Creates a deep clone. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTexture.html#clone) */ clone(): MeshTexture; } interface MeshTextureProperties { /** * A direct reference to the image or video data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTexture.html#data) */ data?: HTMLImageElement | HTMLCanvasElement | any | ImageData; /** * Indicates whether the image data should be interpreted as being semi-transparent. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTexture.html#transparent) */ transparent?: boolean; /** * The url to the image resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTexture.html#url) */ url?: string; /** * Specifies how uv coordinates outside the [0, 1] range are handled. * * @default "repeat" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTexture.html#wrap) */ wrap?: "clamp" | "repeat" | "mirror" | SeparableWrapModes; } /** * A separable wrap configuration for horizontal and vertical wrapping modes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTexture.html#SeparableWrapModes) */ export interface SeparableWrapModes { /** * Horizontal wrapping mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTexture.html#SeparableWrapModes) */ horizontal: "clamp" | "repeat" | "mirror"; /** * Vertical wrapping mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTexture.html#SeparableWrapModes) */ vertical: "clamp" | "repeat" | "mirror"; } export class MeshTextureTransform extends Accessor { /** * The offset of the UV coordinate origin as a factor of the texture dimensions. * * @default [0, 0] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTextureTransform.html#offset) */ offset: number[]; /** * The rotation of the UV coordinates in degrees, counter-clockwise around the origin. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTextureTransform.html#rotation) */ rotation: number; /** * The scale factor applied to the components of the UV coordinates. * * @default [1, 1] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTextureTransform.html#scale) */ scale: number[]; /** * MeshTextureTransform represents a transformation of UV mesh coordinates used to sample a [MeshTexture](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTexture.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTextureTransform.html) */ constructor(properties?: MeshTextureTransformProperties); } interface MeshTextureTransformProperties { /** * The offset of the UV coordinate origin as a factor of the texture dimensions. * * @default [0, 0] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTextureTransform.html#offset) */ offset?: number[]; /** * The rotation of the UV coordinates in degrees, counter-clockwise around the origin. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTextureTransform.html#rotation) */ rotation?: number; /** * The scale factor applied to the components of the UV coordinates. * * @default [1, 1] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTextureTransform.html#scale) */ scale?: number[]; } export interface MeshTransform extends Accessor, JSONSupport { } export class MeshTransform { /** * Rotation angle in degrees. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTransform.html#rotationAngle) */ rotationAngle: number; /** * Axis of rotation. * * @default [0, 0, 1] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTransform.html#rotationAxis) */ rotationAxis: number[]; /** * Scale. * * @default [1, 1, 1] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTransform.html#scale) */ scale: number[]; /** * Translation. * * @default [0, 0, 0] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTransform.html#translation) */ translation: number[]; /** * A mesh transform. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTransform.html) */ constructor(properties?: MeshTransformProperties); /** * Creates a deep clone. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTransform.html#clone) */ clone(): MeshTransform; static fromJSON(json: any): MeshTransform; } interface MeshTransformProperties { /** * Rotation angle in degrees. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTransform.html#rotationAngle) */ rotationAngle?: number; /** * Axis of rotation. * * @default [0, 0, 1] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTransform.html#rotationAxis) */ rotationAxis?: number[]; /** * Scale. * * @default [1, 1, 1] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTransform.html#scale) */ scale?: number[]; /** * Translation. * * @default [0, 0, 0] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshTransform.html#translation) */ translation?: number[]; } /** * Various utilities and convenience functions for working with [Mesh](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html) objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html) */ interface meshUtils { /** * Creates an elevation sampler from a mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#createElevationSampler) */ createElevationSampler(mesh: Mesh, options?: meshUtilsCreateElevationSamplerOptions): Promise; /** * Creates a mesh geometry by sampling elevation data from an elevation service on a regular grid. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#createFromElevation) */ createFromElevation(source: ElevationLayer | Ground | ElevationSampler, extent: Extent, options?: meshUtilsCreateFromElevationOptions): Promise; /** * Georeferences vertices specified in a Cartesian coordinate system. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#georeference) */ georeference(vertexAttributes: VertexAttributes, location: Point, options?: meshUtilsGeoreferenceOptions): VertexAttributes; /** * Merges multiple meshes into a single mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#merge) */ merge(geometries: Mesh[]): Mesh; /** * Projects georeferenced vertices to a Cartesian coordinate system. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#ungeoreference) */ ungeoreference(vertexAttributes: VertexAttributes, location: Point, options?: meshUtilsUngeoreferenceOptions): VertexAttributes; } export const meshUtils: meshUtils; export interface meshUtilsCreateElevationSamplerOptions { /** * The value to use when there is no data available. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#createElevationSampler) */ noDataValue?: number; } export interface meshUtilsCreateFromElevationOptions { /** * Controls the horizontal resolution (cell size) in meters from which elevation data is sampled (defaults to `auto`). * * @default auto * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#createFromElevation) */ demResolution?: number | string; /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#createFromElevation) */ signal?: AbortSignal; } export interface meshUtilsGeoreferenceOptions { /** * Indicates whether to georeference relative to the globe or the projected coordinate system. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#georeference) */ geographic?: boolean; /** * Indicates the unit of the source data. * * [Read more...](global.html#unit) */ unit?: | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"; } export interface meshUtilsUngeoreferenceOptions { /** * Indicates whether the coordinates are georeferenced relative to the globe or the projected coordinate system. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#ungeoreference) */ geographic?: boolean; /** * Indicates the unit of the resulting data. * * [Read more...](global.html#unit) */ unit?: | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"; } /** * Represents the position and normal vertex attribute buffers of a mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#VertexAttributes) */ export interface VertexAttributes { /** * The position buffer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#VertexAttributes) */ position: Float64Array; /** * The normal buffer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#VertexAttributes) */ normal?: Float32Array; /** * The tangent buffer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#VertexAttributes) */ tangent?: Float32Array; } /** * Provides a utility method that normalizes geometries that intersect the central meridian or fall outside the world extent so they stay within the coordinate system of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-normalizeUtils.html) */ interface normalizeUtils { /** * Returns an [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) over the dateline that is smaller than the normalized width if it visually contains the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-normalizeUtils.html#getDenormalizedExtent) */ getDenormalizedExtent(geometry: Geometry): Extent; /** * Normalizes geometries that intersect the central meridian or fall outside the world extent so they stay within the coordinate system of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-normalizeUtils.html#normalizeCentralMeridian) */ normalizeCentralMeridian(geometries: Geometry[], url?: string, requestOptions?: any): Promise; } export const normalizeUtils: normalizeUtils; /** * Converts Web Mercator coordinates to geographic coordinates and vice versa. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-webMercatorUtils.html) */ interface webMercatorUtils { /** * Returns `true` if the `source` spatial reference can be projected to the `target` spatial reference with the [project()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-webMercatorUtils.html#project) function, or if the `source` and `target` are the same [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-webMercatorUtils.html#canProject) */ canProject(source: SpatialReference | any, target: SpatialReference | any): boolean; /** * Converts a geometry from geographic units (wkid: 4326) to Web Mercator units (wkid: 3857). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-webMercatorUtils.html#geographicToWebMercator) */ geographicToWebMercator(geometry: Geometry): Geometry; /** * Translates the given latitude and longitude (decimal degree) values to Web Mercator XY values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-webMercatorUtils.html#lngLatToXY) */ lngLatToXY(long: number, lat: number): number[]; /** * Projects the geometry clientside (if possible). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-webMercatorUtils.html#project) */ project(geometry: Geometry, spatialReference: SpatialReference | any): Geometry; /** * Converts a geometry from Web Mercator units (wkid: 3857) to geographic units (wkid: 4326). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-webMercatorUtils.html#webMercatorToGeographic) */ webMercatorToGeographic(geometry: Geometry, isLinear?: boolean): Geometry; /** * Translates the given Web Mercator coordinates to Longitude and Latitude values (decimal degrees). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-webMercatorUtils.html#xyToLngLat) */ xyToLngLat(x: number, y: number): number[]; } export const webMercatorUtils: webMercatorUtils; /** * Extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry.html#Extent) */ export type geometryExtent = Extent; /** * Geometry types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry.html#Geometry) */ export type geometryGeometry = Extent | Multipoint | Point | Polygon | Polyline | Mesh; /** * Mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry.html#Mesh) */ export type geometryMesh = Mesh; /** * Multipoint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry.html#Multipoint) */ export type geometryMultipoint = Multipoint; /** * Point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry.html#Point) */ export type geometryPoint = Point; /** * Polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry.html#Polygon) */ export type geometryPolygon = Polygon; /** * Polyline. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry.html#Polyline) */ export type geometryPolyline = Polyline; /** * Spatial Reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry.html#SpatialReference) */ export type geometrySpatialReference = SpatialReference; export interface Graphic extends Accessor, JSONSupport, Clonable { } export class Graphic { /** * The aggregateGeometries contains spatial aggregation geometries when [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-StatisticDefinition.html#statisticType) query is executed with `envelope-aggregate`, `centroid-aggregate` and/or `convex-hull-aggregate` statistics type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#aggregateGeometries) */ aggregateGeometries: any; /** * Name-value pairs of fields and field values associated with the graphic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#attributes) */ attributes: any; /** * The geometry that defines the graphic's location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#geometry) */ geometry: Geometry; /** * Indicates whether the graphic refers to an aggregate, or [cluster](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html) graphic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#isAggregate) */ readonly isAggregate: boolean; /** * If applicable, references the layer in which the graphic is stored. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#layer) */ layer: Layer; /** * Returns information about an origin of a graphic if applicable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#origin) */ origin: GraphicOrigin; /** * The template for displaying content in a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) when the graphic is selected. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * The [Symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol.html) for the graphic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#symbol) */ symbol: Symbol; /** * Indicates the visibility of the graphic. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#visible) */ visible: boolean; /** * A Graphic is a vector representation of real world geographic phenomena. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) */ constructor(properties?: GraphicProperties); /** * Returns the value of the specified attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#getAttribute) */ getAttribute(name: string): any; /** * Returns the popup template applicable for the graphic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#getEffectivePopupTemplate) */ getEffectivePopupTemplate(defaultPopupTemplateEnabled?: boolean): PopupTemplate; /** * Returns the Object ID of the feature associated with the graphic, if it exists. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#getObjectId) */ getObjectId(): number; /** * Sets a new value to the specified attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#setAttribute) */ setAttribute(name: string, newValue: any): void; static fromJSON(json: any): Graphic; } interface GraphicProperties { /** * The aggregateGeometries contains spatial aggregation geometries when [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-StatisticDefinition.html#statisticType) query is executed with `envelope-aggregate`, `centroid-aggregate` and/or `convex-hull-aggregate` statistics type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#aggregateGeometries) */ aggregateGeometries?: any; /** * Name-value pairs of fields and field values associated with the graphic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#attributes) */ attributes?: any; /** * The geometry that defines the graphic's location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#geometry) */ geometry?: GeometryProperties; /** * If applicable, references the layer in which the graphic is stored. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#layer) */ layer?: LayerProperties; /** * Returns information about an origin of a graphic if applicable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#origin) */ origin?: VectorTileOrigin; /** * The template for displaying content in a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) when the graphic is selected. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * The [Symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol.html) for the graphic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#symbol) */ symbol?: SymbolProperties; /** * Indicates the visibility of the graphic. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#visible) */ visible?: boolean; } /** * Information about an [origin](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#origin) of a graphic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#GraphicOrigin) */ export type GraphicOrigin = VectorTileOrigin; /** * Origin information about a graphic returned as a result of the [hitTest()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hitTest) method for [VectorTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#VectorTileOrigin) */ export interface VectorTileOrigin { type: "vector-tile"; /** * The [unique identifier](https://maplibre.org/maplibre-style-spec/layers/#id) of the style layer in the [vector tile style](https://maplibre.org/maplibre-style-spec). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#VectorTileOrigin) */ layerId: string; /** * The layer index of the style layer in the [vector tile style](https://maplibre.org/maplibre-style-spec). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#VectorTileOrigin) */ layerIndex: number; /** * VectorTileLayer where the graphic originates from. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#VectorTileOrigin) */ layer: VectorTileLayer; } export interface Ground extends Accessor, Loadable, JSONSupport { } export class Ground { /** * A collection of [ElevationLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html) that define the elevation or terrain that makes up the ground surface. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#layers) */ layers: Collection; /** * Indicates whether the instance has loaded. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#loaded) */ readonly loaded: boolean; /** * Specifies the user navigation constraints relative to the ground surface. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#navigationConstraint) */ navigationConstraint: GroundNavigationConstraint; /** * Opacity of the ground, including surface default color and the basemap (without reference layers). * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#opacity) */ opacity: number; /** * The color of the ground surface, displayed underneath the basemap. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#surfaceColor) */ surfaceColor: Color; /** * The Ground class contains properties that specify how the ground surface is displayed in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html) */ constructor(properties?: GroundProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#clone) */ clone(): Ground; /** * Creates an elevation sampler for the given extent by querying the ground layers for elevation data and caching it so values may be sampled quickly afterwards. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#createElevationSampler) */ createElevationSampler(extent: Extent, options?: GroundCreateElevationSamplerOptions): Promise; /** * Destroys the ground and its [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#layers). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#destroy) */ destroy(): void; /** * Loads all the externally loadable resources associated with the ground. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#loadAll) */ loadAll(): Promise; /** * Query the ground layer services for elevation values for the given geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#queryElevation) */ queryElevation(geometry: Point | Multipoint | Polyline, options?: GroundQueryElevationOptions): Promise; static fromJSON(json: any): Ground; } interface GroundProperties extends LoadableProperties { /** * A collection of [ElevationLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html) that define the elevation or terrain that makes up the ground surface. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#layers) */ layers?: CollectionProperties; /** * Specifies the user navigation constraints relative to the ground surface. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#navigationConstraint) */ navigationConstraint?: GroundNavigationConstraintProperties; /** * Opacity of the ground, including surface default color and the basemap (without reference layers). * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#opacity) */ opacity?: number; /** * The color of the ground surface, displayed underneath the basemap. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#surfaceColor) */ surfaceColor?: Color | number[] | string; } /** * Object returned when [queryElevation()](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#queryElevation) promise resolves: * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#ElevationQueryResult) */ export interface ElevationQueryResult { /** * The geometry with sampled z-values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#ElevationQueryResult) */ geometry: Point | Multipoint | Polyline; /** * Contains additional information about how the geometry was sampled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#ElevationQueryResult) */ sampleInfo?: ElevationQueryResultSampleInfo[]; /** * The value used when there is no data available. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#ElevationQueryResult) */ noDataValue: number; } export interface GroundCreateElevationSamplerOptions { /** * Controls the horizontal resolution (cell size) in meters from which elevation data is sampled (defaults to `auto`). * * @default auto * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#createElevationSampler) */ demResolution?: number | string; /** * The value to use when there is no data available. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#createElevationSampler) */ noDataValue?: number; /** * An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to abort the request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#createElevationSampler) */ signal?: AbortSignal; } export interface GroundNavigationConstraintProperties { /** * The type of the constraint. * * [Read more...](global.html#type) */ type?: "stay-above" | "none"; } export interface GroundNavigationConstraint extends AnonymousAccessor { /** * The type of the constraint. * * [Read more...](global.html#type) */ type: "stay-above" | "none"; } export interface GroundQueryElevationOptions { /** * Controls the horizontal resolution (cell size) in meters from which elevation data is sampled (defaults to `auto`). * * @default auto * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#queryElevation) */ demResolution?: number | string; /** * Indicates whether to return additional sample information for each sampled coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#queryElevation) */ returnSampleInfo?: boolean; /** * The value that appears in the resulting geometry when there is no data available. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#queryElevation) */ noDataValue?: number; /** * An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to abort the request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#queryElevation) */ signal?: AbortSignal; } export interface ElevationQueryResultSampleInfo { /** * The resolution at which the z-value was sampled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#ElevationQueryResult) */ demResolution: number; /** * The elevation source from which the data for the corresponding coordinate was sampled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#ElevationQueryResult) */ source: ElevationLayer; } export interface Credential extends Accessor, Evented { } export class Credential { /** * Token expiration time specified as number of milliseconds since 1 January 1970 00:00:00 UTC. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#expires) */ expires: number; /** * Indicates that this credential was created to access the [ArcGIS REST Admin service](https://developers.arcgis.com/rest/services-reference/enterprise/rest-api-admin.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#isAdmin) */ isAdmin: boolean; /** * The Identity Manager's [setOAuthRedirectionHandler](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#setOAuthRedirectionHandler) returns an object that contains a `state` property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#oAuthState) */ oAuthState: any; /** * The server url. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#server) */ server: string; /** * Indicates whether the resources accessed using this credential should be fetched over HTTPS protocol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#ssl) */ ssl: boolean; /** * Token generated by the token service using the specified userId and password. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#token) */ token: string; /** * User associated with the Credential object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#userId) */ userId: string; constructor(properties?: CredentialProperties); /** * Destroys the credential. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#destroy) */ destroy(): void; /** * Generates a new token and updates the Credential's [token](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#token) property with the newly acquired token. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#refreshToken) */ refreshToken(): void; on(name: "token-change", eventHandler: CredentialTokenChangeEventHandler): IHandle; on(name: "destroy", eventHandler: CredentialDestroyEventHandler): IHandle; } interface CredentialProperties { /** * Token expiration time specified as number of milliseconds since 1 January 1970 00:00:00 UTC. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#expires) */ expires?: number; /** * Indicates that this credential was created to access the [ArcGIS REST Admin service](https://developers.arcgis.com/rest/services-reference/enterprise/rest-api-admin.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#isAdmin) */ isAdmin?: boolean; /** * The Identity Manager's [setOAuthRedirectionHandler](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#setOAuthRedirectionHandler) returns an object that contains a `state` property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#oAuthState) */ oAuthState?: any; /** * The server url. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#server) */ server?: string; /** * Indicates whether the resources accessed using this credential should be fetched over HTTPS protocol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#ssl) */ ssl?: boolean; /** * Token generated by the token service using the specified userId and password. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#token) */ token?: string; /** * User associated with the Credential object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#userId) */ userId?: string; } export interface CredentialDestroyEvent { } export interface CredentialTokenChangeEvent { } export class IdentityManager extends Evented { /** * Dialog box widget used to challenge the user for their credentials when the application attempts to access a secure resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#dialog) */ dialog: Widget; /** * The suggested lifetime of the token in minutes. * * @default 60 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#tokenValidity) */ tokenValidity: number; /** * Returns a [credential](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html) if the user has already signed in to access the given resource and is allowed to do so when using the given application id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#checkAppAccess) */ checkAppAccess(resUrl: string, appId: string): Promise; /** * Returns the [Credential](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html) if the user has already signed in to access the given resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#checkSignInStatus) */ checkSignInStatus(resUrl: string): Promise; /** * Destroys all credentials. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#destroyCredentials) */ destroyCredentials(): void; /** * Disables the use of `window.postMessage` to serve authentication requests that were enabled by [enablePostMessageAuth](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#enablePostMessageAuth). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#disablePostMessageAuth) */ disablePostMessageAuth(): void; /** * Enables the IdentityManager to serve authentication requests for the given resource from apps running in child iframes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#enablePostMessageAuth) */ enablePostMessageAuth(resUrl?: string): void; /** * Returns the [Credential](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html) for the resource identified by the specified url. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#findCredential) */ findCredential(url: string, userId?: string): Credential; /** * Returns the [OAuthInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html) configuration for the passed in Portal server URL. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#findOAuthInfo) */ findOAuthInfo(url: string): OAuthInfo; /** * Returns information about the server that is hosting the specified URL. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#findServerInfo) */ findServerInfo(url: string): ServerInfo; /** * Returns an object containing a token and its expiration time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#generateToken) */ generateToken(serverInfo: ServerInfo, userInfo: any, options?: IdentityManagerGenerateTokenOptions): Promise; /** * Returns a [Credential](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html) object that can be used to access the secured resource identified by the input URL. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#getCredential) */ getCredential(url: string, options?: IdentityManagerGetCredentialOptions): Promise; /** * Call this method during application initialization with the JSON previously obtained from the [toJSON()](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#toJSON) method used to re-hydrate the state of IdentityManager. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#initialize) */ initialize(json: any): void; /** * Indicates if the IdentityManager is busy accepting user input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#isBusy) */ isBusy(): boolean; /** * Registers OAuth 2.0 configurations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#registerOAuthInfos) */ registerOAuthInfos(oAuthInfos: OAuthInfo[]): void; /** * Register secure servers and the token endpoints. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#registerServers) */ registerServers(serverInfos: ServerInfo[]): void; /** * Registers the given OAuth 2.0 access token or ArcGIS Server token with the IdentityManager. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#registerToken) */ registerToken(properties: IdentityManagerRegisterTokenProperties): void; /** * Once a user successfully logs in, they are redirected back to the application. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#setOAuthRedirectionHandler) */ setOAuthRedirectionHandler(handlerFunction: HandlerCallback): void; /** * Use this method in the popup callback page to pass the token and other values back to the IdentityManager. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#setOAuthResponseHash) */ setOAuthResponseHash(hash: string): void; /** * When accessing secured resources, the IdentityManager may prompt for username and password and send them to the server using a secure connection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#setProtocolErrorHandler) */ setProtocolErrorHandler(handlerFunction: IdentityManagerSetProtocolErrorHandlerHandlerFunction): void; /** * Return properties of this object in JSON format. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#toJSON) */ toJSON(): any; on(name: "dialog-create", eventHandler: IdentityManagerDialogCreateEventHandler): IHandle; on(name: "credential-create", eventHandler: IdentityManagerCredentialCreateEventHandler): IHandle; } export interface IdentityManagerCredentialCreateEvent { credential: Credential; } export interface IdentityManagerDialogCreateEvent { } export type HandlerCallback = ( authorizeParams: any, authorizeUrl: string, oAuthInfo: OAuthInfo, resourceUrl: string, serverInfo: ServerInfo, ) => void; export interface IdentityManagerGenerateTokenOptions { /** * The server URL. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#generateToken) */ serverUrl: string; /** * The server token. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#generateToken) */ token: string; /** * Indicates if the server requires SSL. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#generateToken) */ ssl: boolean; } export interface IdentityManagerGetCredentialOptions { /** * Error object returned by the server from a previous attempt to fetch the given URL. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#getCredential) */ error?: Error; /** * If set to *false*, the user will not be shown a dialog before the OAuth popup window is opened. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#getCredential) */ oAuthPopupConfirmation?: boolean; /** * Token used for a previous unsuccessful attempt to fetch the given URL. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#getCredential) */ token?: string; } export interface IdentityManagerRegisterTokenProperties { /** * Token expiration time specified as number of milliseconds since 1 January 1970 00:00:00 UTC. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#registerToken) */ expires?: number; /** * For ArcGIS Online or Portal, this is https://www.arcgis.com/sharing/rest or similar to https://www.example.com/portal/sharing/rest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#registerToken) */ server: string; /** * Set this to `true` if the user has an ArcGIS Online organizational account and the organization is configured to allow access to resources only through SSL. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#registerToken) */ ssl?: boolean; /** * The access token. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#registerToken) */ token: string; /** * The id of the user who owns the access token. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#registerToken) */ userId?: string; } export interface IdentityManagerSetProtocolErrorHandlerHandlerFunction { /** * The secure resource URL. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#setProtocolErrorHandler) */ resourceUrl: string; /** * ServerInfo object describing the server where the secure resource is hosted. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#setProtocolErrorHandler) */ serverInfo: ServerInfo; } export interface OAuthInfo extends Accessor, JSONSupport { } export class OAuthInfo { /** * The registered application id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#appId) */ appId: string; /** * Applications with the same value will share the stored token on the same host. * * @default / (forward slash) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#authNamespace) */ authNamespace: string; /** * The number of minutes that the token is valid. * * @default 20160 (two weeks) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#expiration) */ expiration: number; /** * Set this property to specify the type of authentication to use. * * @default auto * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#flowType) */ flowType: "auto" | "authorization-code" | "implicit"; /** * Set this property to `true` to force the user to sign in with the id in [userId](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#userId). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#forceUserId) */ forceUserId: boolean; /** * The locale for the OAuth sign-in page. * * @default Based on your browser/OS and the organization locale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#locale) */ locale: string; /** * The minimum time in minutes before a saved token is due to expire that should still be considered valid for use. * * @default 30 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#minTimeUntilExpiration) */ minTimeUntilExpiration: number; /** * Set to `true` to show the OAuth sign-in page in a popup window. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#popup) */ popup: boolean; /** * Applicable if working with the popup user-login workflow. * * @default "oauth-callback.html" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#popupCallbackUrl) */ popupCallbackUrl: string; /** * The window features passed to [window.open()](https://developer.mozilla.org/en-US/docs/Web/API/Window/open). * * @default height=490,width=800,resizable,scrollbars,status * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#popupWindowFeatures) */ popupWindowFeatures: string; /** * The ArcGIS Enterprise portal URL. * * @default "https://www.arcgis.com" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#portalUrl) */ portalUrl: string; /** * Set this property to `true` when [popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#popup) is `false` in order to have the window's location hash value restored after signing in. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#preserveUrlHash) */ preserveUrlHash: boolean; /** * The user id used when `forceUserId` is `true`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#userId) */ userId: string; /** * This class contains information about an OAuth 2.0 configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html) */ constructor(properties?: OAuthInfoProperties); /** * Creates a copy of the OAuthInfo object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#clone) */ clone(): OAuthInfo; static fromJSON(json: any): OAuthInfo; } interface OAuthInfoProperties { /** * The registered application id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#appId) */ appId?: string; /** * Applications with the same value will share the stored token on the same host. * * @default / (forward slash) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#authNamespace) */ authNamespace?: string; /** * The number of minutes that the token is valid. * * @default 20160 (two weeks) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#expiration) */ expiration?: number; /** * Set this property to specify the type of authentication to use. * * @default auto * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#flowType) */ flowType?: "auto" | "authorization-code" | "implicit"; /** * Set this property to `true` to force the user to sign in with the id in [userId](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#userId). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#forceUserId) */ forceUserId?: boolean; /** * The locale for the OAuth sign-in page. * * @default Based on your browser/OS and the organization locale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#locale) */ locale?: string; /** * The minimum time in minutes before a saved token is due to expire that should still be considered valid for use. * * @default 30 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#minTimeUntilExpiration) */ minTimeUntilExpiration?: number; /** * Set to `true` to show the OAuth sign-in page in a popup window. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#popup) */ popup?: boolean; /** * Applicable if working with the popup user-login workflow. * * @default "oauth-callback.html" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#popupCallbackUrl) */ popupCallbackUrl?: string; /** * The window features passed to [window.open()](https://developer.mozilla.org/en-US/docs/Web/API/Window/open). * * @default height=490,width=800,resizable,scrollbars,status * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#popupWindowFeatures) */ popupWindowFeatures?: string; /** * The ArcGIS Enterprise portal URL. * * @default "https://www.arcgis.com" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#portalUrl) */ portalUrl?: string; /** * Set this property to `true` when [popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#popup) is `false` in order to have the window's location hash value restored after signing in. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#preserveUrlHash) */ preserveUrlHash?: boolean; /** * The user id used when `forceUserId` is `true`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#userId) */ userId?: string; } export interface ServerInfo extends Accessor, JSONSupport { } export class ServerInfo { /** * The token service URL used to generate tokens for ArcGIS Server Admin resources. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#adminTokenServiceUrl) */ adminTokenServiceUrl: string; /** * Version of the ArcGIS Server or Portal deployed on the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#currentVersion) */ currentVersion: number; /** * Indicates whether the [server](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#server) is a [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html) instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#hasPortal) */ hasPortal: boolean; /** * Indicates whether the [server](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#server) is an [ArcGIS Server](https://enterprise.arcgis.com/en/server/latest/get-started/windows/what-is-arcgis-for-server-.htm) instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#hasServer) */ hasServer: boolean; /** * The server URL. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#server) */ server: string; /** * Validity of short-lived token in minutes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#shortLivedTokenValidity) */ shortLivedTokenValidity: number; /** * The token service URL used to generate tokens for the secured resources on the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#tokenServiceUrl) */ tokenServiceUrl: string; /** * Indicates whether the server is configured to work with web tier authentication. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#webTierAuth) */ webTierAuth: boolean; /** * This class contains information about an ArcGIS Server and its token endpoint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html) */ constructor(properties?: ServerInfoProperties); static fromJSON(json: any): ServerInfo; } interface ServerInfoProperties { /** * The token service URL used to generate tokens for ArcGIS Server Admin resources. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#adminTokenServiceUrl) */ adminTokenServiceUrl?: string; /** * Version of the ArcGIS Server or Portal deployed on the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#currentVersion) */ currentVersion?: number; /** * Indicates whether the [server](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#server) is a [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html) instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#hasPortal) */ hasPortal?: boolean; /** * Indicates whether the [server](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#server) is an [ArcGIS Server](https://enterprise.arcgis.com/en/server/latest/get-started/windows/what-is-arcgis-for-server-.htm) instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#hasServer) */ hasServer?: boolean; /** * The server URL. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#server) */ server?: string; /** * Validity of short-lived token in minutes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#shortLivedTokenValidity) */ shortLivedTokenValidity?: number; /** * The token service URL used to generate tokens for the secured resources on the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#tokenServiceUrl) */ tokenServiceUrl?: string; /** * Indicates whether the server is configured to work with web tier authentication. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#webTierAuth) */ webTierAuth?: boolean; } /** * This module provides the ability to set the app locale along with date and number formatting methods and supporting utilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html) */ interface intl { /** * Converts a [web map date format string](https://developers.arcgis.com/web-map-specification/objects/format/) to an [Intl.DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DateTimeFormat#Parameters) options object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#convertDateFormatToIntlOptions) */ convertDateFormatToIntlOptions(format?: | "short-date" | "short-date-short-time" | "short-date-short-time-24" | "short-date-long-time" | "short-date-long-time-24" | "long-month-day-year" | "long-month-day-year-short-time" | "long-month-day-year-short-time-24" | "long-month-day-year-long-time" | "long-month-day-year-long-time-24" | "day-short-month-year" | "day-short-month-year-short-time" | "day-short-month-year-short-time-24" | "day-short-month-year-long-time" | "day-short-month-year-long-time-24" | "long-date" | "long-date-short-time" | "long-date-short-time-24" | "long-date-long-time" | "long-date-long-time-24" | "long-month-year" | "short-month-year" | "year" | "short-time" | "long-time"): Intl.DateTimeFormatOptions; /** * Converts a [NumberFormat](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#NumberFormat) to an [Intl.NumberFormatOptions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NumberFormat#Parameters) object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#convertNumberFormatToIntlOptions) */ convertNumberFormatToIntlOptions(format?: NumberFormat): Intl.NumberFormatOptions; /** * Creates a message bundle loader specialized in loading translation files as JSON files. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#createJSONLoader) */ createJSONLoader(params: intlCreateJSONLoaderParams): MessageBundleLoader; /** * Loads a localized message bundle used with the current API locale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#fetchMessageBundle) */ fetchMessageBundle(bundleId: string): Promise; /** * Formats a `Date` or `Number` value to a string in the current locale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#formatDate) */ formatDate(value: Date | number, formatOptions?: Intl.DateTimeFormatOptions): string; /** * Formats a `date-only` field value to a string in the current locale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#formatDateOnly) */ formatDateOnly(value: string, options?: Intl.DateTimeFormatOptions): string; /** * Formats a `Number` value to a string in the current locale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#formatNumber) */ formatNumber(value: number, formatOptions?: Intl.NumberFormatOptions): string; /** * Formats a `time-only` field value to a string in the current locale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#formatTimeOnly) */ formatTimeOnly(value: string, options?: Intl.DateTimeFormatOptions): string; /** * Formats a `timestamp-offset` field value to a string in the current locale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#formatTimestamp) */ formatTimestamp(value: string, options?: Intl.DateTimeFormatOptions): string; /** * Returns the current locale used by the API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#getLocale) */ getLocale(): string; /** * Returns one of the known message bundle locale for an input locale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#normalizeMessageBundleLocale) */ normalizeMessageBundleLocale(locale: string): string | null; /** * Registers a [callback](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#LocaleChangeCallback) that gets notified when the locale changes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#onLocaleChange) */ onLocaleChange(callback: LocaleChangeCallback): Handle; /** * Provides right-to-left preference for input locale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#prefersRTL) */ prefersRTL(locale?: string): boolean; /** * Registers a message loader to load specified message bundles needed for translating strings. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#registerMessageBundleLoader) */ registerMessageBundleLoader(loader: MessageBundleLoader): any; /** * Sets the locale used by the API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#setLocale) */ setLocale(locale: string): void; /** * Use this to substitute keys in a `template` string with values from the argument `data`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#substitute) */ substitute(template: string, data: any, options?: SubstituteOptions): string; } export const intl: intl; export type FetchMessageBundle = (bundleId: string, locale: string) => Promise; export interface intlCreateJSONLoaderParams { /** * Used to check if the loader should be used to load a candidate's message bundle. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#createJSONLoader) */ pattern: string | RegExp; /** * Used to calculate the relative path of the file to load. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#createJSONLoader) */ base: string; /** * The location of the translation files. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#createJSONLoader) */ location: string | URL | Function; } export type LocaleChangeCallback = (newLocale: string) => void; /** * A message bundle loader is an object used to load translation strings in the user's locale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#MessageBundleLoader) */ export interface MessageBundleLoader { /** * Used to check if the loader should be used to load a candidate message bundle. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#MessageBundleLoader) */ pattern: string | RegExp; /** * Called to load the message bundle if the `pattern` matches the bundle identifier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#MessageBundleLoader) */ fetchMessageBundle: FetchMessageBundle; } /** * The Web map definition for formatting numbers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#NumberFormat) */ export interface NumberFormat { /** * Indicates if the number should be formatted with a thousands separator. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#NumberFormat) */ digitSeparator?: boolean; /** * Specifies the number of decimal places that should appear in the formatted number. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#NumberFormat) */ places?: number; } /** * The formatting options for date values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#SubstituteDateTimeFormatOptions) */ export interface SubstituteDateTimeFormatOptions { /** * The type of this format. * * [Read more...](global.html#type) */ type: "date"; /** * The date format options for the [Intl.DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DateTimeFormat) object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#SubstituteDateTimeFormatOptions) */ intlOptions: Intl.DateTimeFormatOptions; } /** * The formatting options for numeric values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#SubstituteNumberFormatOptions) */ export interface SubstituteNumberFormatOptions { /** * The type of this format. * * [Read more...](global.html#type) */ type: "number"; /** * The Intl number format options for the [Intl.NumberFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NumberFormat) object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#SubstituteNumberFormatOptions) */ intlOptions: Intl.NumberFormatOptions; } /** * An object to specify substitution options. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#SubstituteOptions) */ export interface SubstituteOptions { /** * A hashmap of string keys to formatting options. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-intl.html#SubstituteOptions) */ format: HashMap; } /** * Utility for retrieving the current version of the API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-kernel.html) */ interface kernel { /** * Current full version of the ArcGIS Maps SDK for JavaScript. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-kernel.html#fullVersion) */ readonly fullVersion: string; /** * Current `major.minor` version of the ArcGIS Maps SDK for JavaScript. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-kernel.html#version) */ readonly version: string; } export const kernel: kernel; export interface BaseDynamicLayer extends Layer, ScaleRangeLayer, RefreshableLayer, BlendLayer { } export class BaseDynamicLayer { readonly type: "base-dynamic"; /** * This class may be extended to create dynamic map layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseDynamicLayer.html) */ constructor(properties?: BaseDynamicLayerProperties); /** * Adds a promise to the layer's [loadable](https://developers.arcgis.com/javascript/latest/programming-patterns/#loadable) chain. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseDynamicLayer.html#addResolvingPromise) */ addResolvingPromise(promiseToLoad: Promise): Promise; /** * This method fetches the image for the specified extent and size. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseDynamicLayer.html#fetchImage) */ fetchImage(extent: Extent, width: number, height: number, options?: BaseDynamicLayerFetchImageOptions): Promise; /** * This method returns a URL to an image for a given extent, width, and height. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseDynamicLayer.html#getImageUrl) */ getImageUrl(extent: Extent, width: number, height: number): Promise | string; on(name: "refresh", eventHandler: BaseDynamicLayerRefreshEventHandler): IHandle; on(name: "layerview-create", eventHandler: BaseDynamicLayerLayerviewCreateEventHandler): IHandle; on(name: "layerview-create-error", eventHandler: BaseDynamicLayerLayerviewCreateErrorEventHandler): IHandle; on(name: "layerview-destroy", eventHandler: BaseDynamicLayerLayerviewDestroyEventHandler): IHandle; } interface BaseDynamicLayerProperties extends LayerProperties, ScaleRangeLayerProperties, RefreshableLayerProperties, BlendLayerProperties { } export interface BaseDynamicLayerFetchImageOptions { /** * An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to abort the request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseDynamicLayer.html#fetchImage) */ signal?: AbortSignal; } export interface BaseDynamicLayerLayerviewCreateErrorEvent { error: Error; view: View; } export interface BaseDynamicLayerLayerviewCreateEvent { layerView: LayerView; view: View; } export interface BaseDynamicLayerLayerviewDestroyEvent { layerView: LayerView; view: View; } export interface BaseDynamicLayerRefreshEvent { dataChanged: boolean; } export class BaseElevationLayer extends Layer { /** * The spatial reference of the layer. * * @default {@link module:esri/geometry/SpatialReference#WebMercator SpatialReference.WebMercator} * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#spatialReference) */ spatialReference: SpatialReference; /** * The tiling scheme information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#tileInfo) */ tileInfo: TileInfo; readonly type: "base-elevation"; /** * BaseElevationLayer is intended to be extended for creating custom elevation layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html) */ constructor(properties?: BaseElevationLayerProperties); /** * Adds a promise to the layer's [loadable](https://developers.arcgis.com/javascript/latest/programming-patterns/#loadable) chain. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#addResolvingPromise) */ addResolvingPromise(promiseToLoad: Promise): Promise; /** * Creates an elevation sampler for the given [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) by querying the service layer for elevation data and caching it so values may be sampled quickly afterwards. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#createElevationSampler) */ createElevationSampler(extent: Extent, options?: BaseElevationLayerCreateElevationSamplerOptions): Promise; /** * Fetches a tile at the given level, row, and column present in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#fetchTile) */ fetchTile(level: number, row: number, column: number, options?: BaseElevationLayerFetchTileOptions): Promise; /** * Returns the bounds of the tile as an array of four numbers that can be readily converted to an [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#getTileBounds) */ getTileBounds(level: number, row: number, column: number, out?: number[]): number[]; /** * Queries the service layer for elevation values for the given geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#queryElevation) */ queryElevation(geometry: Point | Multipoint | Polyline, options?: BaseElevationLayerQueryElevationOptions): Promise; } interface BaseElevationLayerProperties extends LayerProperties { /** * The spatial reference of the layer. * * @default {@link module:esri/geometry/SpatialReference#WebMercator SpatialReference.WebMercator} * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * The tiling scheme information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#tileInfo) */ tileInfo?: TileInfoProperties; } export interface BaseElevationLayerCreateElevationSamplerOptions { /** * Controls the horizontal resolution (cell size) in meters from which elevation data is sampled (defaults to `auto`). * * @default auto * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#createElevationSampler) */ demResolution?: number | string; /** * The value to use when there is no data available. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#createElevationSampler) */ noDataValue?: number; } export interface BaseElevationLayerFetchTileOptions { /** * The value representing pixels in the tile that don't contain an elevation value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#fetchTile) */ noDataValue?: number; /** * An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to abort the request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#fetchTile) */ signal?: AbortSignal; } export interface BaseElevationLayerQueryElevationOptions { /** * Controls the horizontal resolution (cell size) in meters from which elevation data is sampled (defaults to `auto`). * * @default auto * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#queryElevation) */ demResolution?: number | string; /** * Indicates whether to return additional sample information for each coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#queryElevation) */ returnSampleInfo?: boolean; /** * The value to use when there is no data available. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#queryElevation) */ noDataValue?: number; } /** * Describes elevation contained in the pixels that comprise an elevation tile. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#ElevationTileData) */ export interface ElevationTileData { /** * The elevation values of each pixel in the tile. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#ElevationTileData) */ values: number[]; /** * The width of the tile in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#ElevationTileData) */ width: number; /** * The height of the tile in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#ElevationTileData) */ height: number; /** * The maximum allowed error of the Z-value for each value in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#ElevationTileData) */ maxZError: number; /** * Indicating the pixel values where no elevation data is present. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#ElevationTileData) */ noDataValue: number; } export interface BaseTileLayer extends Layer, ScaleRangeLayer, RefreshableLayer, BlendLayer { } export class BaseTileLayer { /** * The spatial reference of the layer. * * @default {@link module:esri/geometry/SpatialReference#WebMercator SpatialReference.WebMercator} * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html#spatialReference) */ spatialReference: SpatialReference; /** * The tiling scheme information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html#tileInfo) */ tileInfo: TileInfo; /** * For [BaseTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html) the type is `base-tile`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html#type) */ readonly type: "base-tile" | "bing-maps"; /** * This class may be extended to create a custom [TileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html) */ constructor(properties?: BaseTileLayerProperties); /** * Adds a promise to the layer's [loadable](https://developers.arcgis.com/javascript/latest/programming-patterns/#loadable) chain. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html#addResolvingPromise) */ addResolvingPromise(promiseToLoad: Promise): Promise; /** * This method fetches a tile for the given level, row and column present in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html#fetchTile) */ fetchTile(level: number, row: number, col: number, options?: BaseTileLayerFetchTileOptions): Promise; /** * Returns the bounds of the tile as an array of four numbers that be readily converted to an [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html#getTileBounds) */ getTileBounds(level: number, row: number, column: number, out?: number[]): number[]; /** * This method returns a URL to an image for a given level, row and column. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html#getTileUrl) */ getTileUrl(level: number, row: number, col: number): string; on(name: "refresh", eventHandler: BaseTileLayerRefreshEventHandler): IHandle; on(name: "layerview-create", eventHandler: BaseTileLayerLayerviewCreateEventHandler): IHandle; on(name: "layerview-create-error", eventHandler: BaseTileLayerLayerviewCreateErrorEventHandler): IHandle; on(name: "layerview-destroy", eventHandler: BaseTileLayerLayerviewDestroyEventHandler): IHandle; } interface BaseTileLayerProperties extends LayerProperties, ScaleRangeLayerProperties, RefreshableLayerProperties, BlendLayerProperties { /** * The spatial reference of the layer. * * @default {@link module:esri/geometry/SpatialReference#WebMercator SpatialReference.WebMercator} * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * The tiling scheme information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html#tileInfo) */ tileInfo?: TileInfoProperties; } export interface BaseTileLayerFetchTileOptions { /** * An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to abort the request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html#fetchTile) */ signal?: AbortSignal; } export interface BaseTileLayerLayerviewCreateErrorEvent { error: Error; view: View; } export interface BaseTileLayerLayerviewCreateEvent { layerView: LayerView; view: View; } export interface BaseTileLayerLayerviewDestroyEvent { layerView: LayerView; view: View; } export interface BaseTileLayerRefreshEvent { dataChanged: boolean; } export interface BingMapsLayer extends BaseTileLayer, OperationalLayer, BlendLayer { } export class BingMapsLayer { /** * Expose Bing logo url. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BingMapsLayer.html#bingLogo) */ readonly bingLogo: string; /** * Copyright information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BingMapsLayer.html#copyright) */ readonly copyright: string; /** * Provides culture specific map labels. * * @default "en-US" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BingMapsLayer.html#culture) */ culture: string; /** * Indicates if the layer has attribution data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BingMapsLayer.html#hasAttributionData) */ readonly hasAttributionData: boolean; /** * Bing Maps Key. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BingMapsLayer.html#key) */ key: string; /** * This will alter Geopolitical disputed borders and labels to align with the specified user region. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BingMapsLayer.html#region) */ region: string; /** * For more information on Bing map styles please visit: https://learn.microsoft.com/en-us/bingmaps/rest-services/imagery/get-imagery-metadata * * @default "road" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BingMapsLayer.html#style) */ style: "road" | "aerial" | "hybrid"; readonly type: "bing-maps"; /** * This layer supports Microsoft's Bing tiled map content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BingMapsLayer.html) */ constructor(properties?: BingMapsLayerProperties); on(name: "refresh", eventHandler: BingMapsLayerRefreshEventHandler): IHandle; on(name: "layerview-create", eventHandler: BingMapsLayerLayerviewCreateEventHandler): IHandle; on(name: "layerview-create-error", eventHandler: BingMapsLayerLayerviewCreateErrorEventHandler): IHandle; on(name: "layerview-destroy", eventHandler: BingMapsLayerLayerviewDestroyEventHandler): IHandle; static fromJSON(json: any): BingMapsLayer; } interface BingMapsLayerProperties extends BaseTileLayerProperties, OperationalLayerProperties, BlendLayerProperties { /** * Provides culture specific map labels. * * @default "en-US" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BingMapsLayer.html#culture) */ culture?: string; /** * Bing Maps Key. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BingMapsLayer.html#key) */ key?: string; /** * This will alter Geopolitical disputed borders and labels to align with the specified user region. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BingMapsLayer.html#region) */ region?: string; /** * For more information on Bing map styles please visit: https://learn.microsoft.com/en-us/bingmaps/rest-services/imagery/get-imagery-metadata * * @default "road" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BingMapsLayer.html#style) */ style?: "road" | "aerial" | "hybrid"; } export interface BingMapsLayerLayerviewCreateErrorEvent { error: Error; view: View; } export interface BingMapsLayerLayerviewCreateEvent { layerView: LayerView; view: View; } export interface BingMapsLayerLayerviewDestroyEvent { layerView: LayerView; view: View; } export interface BingMapsLayerRefreshEvent { dataChanged: boolean; } export interface BuildingSceneLayer extends Layer, SceneService, PortalLayer, ScaleRangeLayer, CustomParametersMixin, APIKeyMixin, OperationalLayer { } export class BuildingSceneLayer { /** * The id of the currently active filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html#activeFilterId) */ activeFilterId: string; /** * A flat [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of all the [sublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html#sublayers) in the BuildingSublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html#allSublayers) */ readonly allSublayers: Collection; /** * Specifies how features are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html#elevationInfo) */ elevationInfo: BuildingSceneLayerElevationInfo; /** * Collection of filters that can be used to show or hide specific features in the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html#filters) */ filters: Collection; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html#legendEnabled) */ legendEnabled: boolean; /** * An array of field names from the service to include with each feature in all sublayers. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html#outFields) */ outFields: string[]; /** * Hierarchical structure of sublayers in a BuildingSceneLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html#sublayers) */ readonly sublayers: Collection; /** * Summary statistics for all component layers in the building scene layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html#summaryStatistics) */ readonly summaryStatistics: BuildingSummaryStatistics; readonly type: "building-scene"; /** * The BuildingSceneLayer is designed for visualizing buildings with detailed interiors in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html) */ constructor(properties?: BuildingSceneLayerProperties); /** * Loads the layer and all of its sublayers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html#loadAll) */ loadAll(): Promise; static fromJSON(json: any): BuildingSceneLayer; } interface BuildingSceneLayerProperties extends LayerProperties, SceneServiceProperties, PortalLayerProperties, ScaleRangeLayerProperties, CustomParametersMixinProperties, APIKeyMixinProperties, OperationalLayerProperties { /** * The id of the currently active filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html#activeFilterId) */ activeFilterId?: string; /** * Specifies how features are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html#elevationInfo) */ elevationInfo?: BuildingSceneLayerElevationInfo; /** * Collection of filters that can be used to show or hide specific features in the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html#filters) */ filters?: CollectionProperties; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html#legendEnabled) */ legendEnabled?: boolean; /** * An array of field names from the service to include with each feature in all sublayers. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html#outFields) */ outFields?: string[]; } export interface BuildingSceneLayerElevationInfo { /** * Defines how features are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html#elevationInfo) */ mode: "absolute-height"; /** * An elevation offset, which is added to the vertical position of each feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html#elevationInfo) */ offset?: number; /** * The unit for `offset` values. * * @default meters * * [Read more...](global.html#unit) */ unit?: "feet" | "meters" | "kilometers" | "miles" | "us-feet" | "yards"; } export interface BuildingComponentSublayer extends BuildingSublayer, TemporalSceneLayer, Loadable { } export class BuildingComponentSublayer { /** * The SQL where clause used to filter features on the client. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#definitionExpression) */ definitionExpression: string; /** * Indicates how the layer should display in the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widget. * * @default show * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#listMode) */ listMode: "show" | "hide"; /** * An array of field names from the service to include with each feature. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#outFields) */ outFields: string[]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#popupEnabled) */ popupEnabled: boolean; /** * The popup template for the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * The renderer assigned to the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#renderer) */ renderer: Renderer; readonly type: "building-component"; /** * BuildingComponentSublayers contain 3D Object features representing building components like doors, pipes or AC units. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html) */ constructor(properties?: BuildingComponentSublayerProperties); /** * Creates a default popup template for the layer, populated with all the fields of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#createPopupTemplate) */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate; /** * Creates a query object that can be used to fetch features that satisfy the component sublayer's current [definition expression](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#definitionExpression). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#createQuery) */ createQuery(): Query; /** * Returns the [Field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) instance for a field name (case-insensitive). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#getField) */ getField(fieldName: string): Field; /** * Returns the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) associated with the given field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#getFieldDomain) */ getFieldDomain(fieldName: string, options?: BuildingComponentSublayerGetFieldDomainOptions): Domain; /** * Gets field usage information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#getFieldUsageInfo) */ getFieldUsageInfo(fieldName: string): any; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the associated feature service and returns the 2D [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. * * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the associated feature service and returns the 2D [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. At the moment the 3D Extent can be returned by using [BuildingComponentSublayerView.queryExtent()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingComponentSublayerView.html#queryExtent), but this will return the 3D extent only for features currently in the view. The query succeeds only if the BuildingSceneLayer has an associated feature layer. If an associated feature layer is not available, then an error with the name `buildingscenelayer:query-not-available` is thrown. Read more about queries in the Querying section of the BuildingSceneLayer class description. [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#queryExtent) */ queryExtent(query?: Query | QueryProperties, options?: BuildingComponentSublayerQueryExtentOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the associated feature service and returns the number of features that satisfy the query. * * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the associated feature service and returns the number of features that satisfy the query. The query succeeds only if the layer's `supportsLayerQuery` capability is enabled. Use the [getFieldUsageInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#getFieldUsageInfo) method to check if the layer supports queries. If querying is not enabled, then an error with the name `buildingscenelayer:query-not-available` is thrown. Read more about queries in the Querying section of the BuildingSceneLayer class description. [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#queryFeatureCount) */ queryFeatureCount(query?: Query | QueryProperties, options?: BuildingComponentSublayerQueryFeatureCountOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the associated feature service and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html). * * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the associated feature service and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html). The query succeeds only if the layer's `supportsLayerQuery` capability is enabled. Use the [getFieldUsageInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#getFieldUsageInfo) method to check if the layer supports queries. If querying is not enabled, then an error with the name `buildingscenelayer:query-not-available` is thrown. Read more about queries in the Querying section of the BuildingSceneLayer class description. [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#queryFeatures) */ queryFeatures(query?: Query | QueryProperties, options?: BuildingComponentSublayerQueryFeaturesOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the associated feature service and returns an array of ObjectIDs of the features that satisfy the input query. * * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the associated feature service and returns an array of ObjectIDs of the features that satisfy the input query. The query succeeds only if the layer's `supportsLayerQuery` capability is enabled. Use the [getFieldUsageInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#getFieldUsageInfo) method to check if the layer supports queries. If querying is not enabled, then an error with the name `buildingscenelayer:query-not-available` is thrown. Read more about queries in the Querying section of the SceneLayer class description. [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#queryObjectIds) */ queryObjectIds(query?: Query | QueryProperties, options?: BuildingComponentSublayerQueryObjectIdsOptions): Promise; static fromJSON(json: any): BuildingComponentSublayer; } interface BuildingComponentSublayerProperties extends BuildingSublayerProperties, LoadableProperties { /** * The SQL where clause used to filter features on the client. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#definitionExpression) */ definitionExpression?: string; /** * Indicates how the layer should display in the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widget. * * @default show * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#listMode) */ listMode?: "show" | "hide"; /** * An array of field names from the service to include with each feature. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#outFields) */ outFields?: string[]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#popupEnabled) */ popupEnabled?: boolean; /** * The popup template for the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * The renderer assigned to the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#renderer) */ renderer?: RendererProperties; } export interface BuildingComponentSublayerGetFieldDomainOptions { /** * The feature to which the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) is assigned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#getFieldDomain) */ feature: Graphic; } export interface BuildingComponentSublayerQueryExtentOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#queryExtent) */ signal?: AbortSignal; } export interface BuildingComponentSublayerQueryFeatureCountOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#queryFeatureCount) */ signal?: AbortSignal; } export interface BuildingComponentSublayerQueryFeaturesOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#queryFeatures) */ signal?: AbortSignal; } export interface BuildingComponentSublayerQueryObjectIdsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#queryObjectIds) */ signal?: AbortSignal; } export class BuildingGroupSublayer extends BuildingSublayer { /** * Indicates how the sublayer should display in the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widget. * * @default show * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingGroupSublayer.html#listMode) */ listMode: "show" | "hide" | "hide-children"; /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of sublayers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingGroupSublayer.html#sublayers) */ readonly sublayers: Collection; readonly type: "building-group"; /** * Hierarchical group of [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html) sublayers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingGroupSublayer.html) */ constructor(properties?: BuildingGroupSublayerProperties); /** * Loads all contained sublayers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingGroupSublayer.html#loadAll) */ loadAll(): Promise; static fromJSON(json: any): BuildingGroupSublayer; } interface BuildingGroupSublayerProperties extends BuildingSublayerProperties { /** * Indicates how the sublayer should display in the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widget. * * @default show * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingGroupSublayer.html#listMode) */ listMode?: "show" | "hide" | "hide-children"; } export interface BuildingSublayer extends Accessor, Identifiable { } export class BuildingSublayer { /** * The sublayer's layer id as defined by the Scene Service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingSublayer.html#id) */ readonly id: number; /** * Indicates if this sublayer is empty. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingSublayer.html#isEmpty) */ readonly isEmpty: boolean; /** * The modelName is a standard name for each sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingSublayer.html#modelName) */ readonly modelName: string; /** * Opacity of the sublayer. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingSublayer.html#opacity) */ opacity: number; /** * The title of the sublayer used to identify it in places such as the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) and [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widgets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingSublayer.html#title) */ title: string; /** * Indicates if the sublayer is visible in the view. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingSublayer.html#visible) */ visible: boolean; /** * BuildingSublayer is the base class for sublayers of a BuildingSceneLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingSublayer.html) */ constructor(properties?: BuildingSublayerProperties); static fromJSON(json: any): BuildingSublayer; } interface BuildingSublayerProperties { /** * Opacity of the sublayer. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingSublayer.html#opacity) */ opacity?: number; /** * The title of the sublayer used to identify it in places such as the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) and [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widgets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingSublayer.html#title) */ title?: string; /** * Indicates if the sublayer is visible in the view. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingSublayer.html#visible) */ visible?: boolean; } export interface CSVLayer extends Layer, OrderedLayer, ScaleRangeLayer, TemporalLayer, BlendLayer, FeatureEffectLayer, FeatureReductionLayer, PortalLayer { } export class CSVLayer { /** * Describes the layer's supported capabilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ readonly capabilities: CSVLayerCapabilities; /** * Copyright information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#copyright) */ copyright: string; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#customParameters) */ customParameters: any; /** * The time zone that dates are stored in. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#dateFieldsTimeZone) */ readonly dateFieldsTimeZone: string; /** * The SQL where clause used to filter features on the client. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#definitionExpression) */ definitionExpression: string; /** * The column delimiter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#delimiter) */ delimiter: string; /** * The name of the layer's primary display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#displayField) */ displayField: string; /** * Specifies how features are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#elevationInfo) */ elevationInfo: CSVLayerElevationInfo; /** * An array of fields in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#fields) */ fields: Field[]; /** * A convenient property that can be used to make case-insensitive lookups for a field by name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#fieldsIndex) */ readonly fieldsIndex: FieldsIndex; /** * The geometry type of features in the CSVLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#geometryType) */ geometryType: "point"; /** * Returns `true` if the layer is loaded from a non-spatial table in a service. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#isTable) */ readonly isTable: boolean; /** * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#labelingInfo) */ labelingInfo: LabelClass[]; /** * Indicates whether to display labels for this layer. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#labelsVisible) */ labelsVisible: boolean; /** * The latitude field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#latitudeField) */ latitudeField: string; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#legendEnabled) */ legendEnabled: boolean; /** * The longitude field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#longitudeField) */ longitudeField: string; /** * The name of an `oid` [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#fields) containing a unique value or identifier for each feature in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#objectIdField) */ objectIdField: string; /** * An array of field names to include in the CSVLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#outFields) */ outFields: string[]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#popupEnabled) */ popupEnabled: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * Refresh interval of the layer in minutes. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#refreshInterval) */ refreshInterval: number; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#renderer) */ renderer: Renderer; /** * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#screenSizePerspectiveEnabled) */ screenSizePerspectiveEnabled: boolean; /** * The spatial reference of the layer. * * @default SpatialReference.WGS84 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#spatialReference) */ spatialReference: SpatialReference; readonly type: "csv"; /** * The URL of the CSV file. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#url) */ url: string; /** * The CSVLayer is a point layer based on a CSV file (.csv, .txt). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html) */ constructor(properties?: CSVLayerProperties); /** * Creates a popup template for the layer, populated with all the fields of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#createPopupTemplate) */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate; /** * Creates query parameters that can be used to fetch features that satisfy the layer's current filters, and definitions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#createQuery) */ createQuery(): Query; /** * Returns the [Field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) instance for a field name (case-insensitive). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#getField) */ getField(fieldName: string): Field; /** * Returns the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) associated with the given field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#getFieldDomain) */ getFieldDomain(fieldName: string, options?: CSVLayerGetFieldDomainOptions): Domain; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the CSV data and returns the [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#queryExtent) */ queryExtent(query?: Query | QueryProperties, options?: CSVLayerQueryExtentOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the CSV data and returns the number of features that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#queryFeatureCount) */ queryFeatureCount(query?: Query | QueryProperties, options?: CSVLayerQueryFeatureCountOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the CSV data and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html), which can be accessed using the `.then()` method once the promise resolves. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#queryFeatures) */ queryFeatures(query?: Query | QueryProperties, options?: CSVLayerQueryFeaturesOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the CSV data and returns an array of Object IDs for features that satisfy the input query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#queryObjectIds) */ queryObjectIds(query?: Query | QueryProperties, options?: CSVLayerQueryObjectIdsOptions): Promise; /** * Fetches all the data for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#refresh) */ refresh(): void; on(name: "refresh", eventHandler: CSVLayerRefreshEventHandler): IHandle; on(name: "layerview-create", eventHandler: CSVLayerLayerviewCreateEventHandler): IHandle; on(name: "layerview-create-error", eventHandler: CSVLayerLayerviewCreateErrorEventHandler): IHandle; on(name: "layerview-destroy", eventHandler: CSVLayerLayerviewDestroyEventHandler): IHandle; static fromJSON(json: any): CSVLayer; } interface CSVLayerProperties extends LayerProperties, OrderedLayerProperties, ScaleRangeLayerProperties, TemporalLayerProperties, BlendLayerProperties, FeatureEffectLayerProperties, FeatureReductionLayerProperties, PortalLayerProperties { /** * Copyright information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#copyright) */ copyright?: string; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#customParameters) */ customParameters?: any; /** * The SQL where clause used to filter features on the client. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#definitionExpression) */ definitionExpression?: string; /** * The column delimiter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#delimiter) */ delimiter?: string; /** * The name of the layer's primary display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#displayField) */ displayField?: string; /** * Specifies how features are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#elevationInfo) */ elevationInfo?: CSVLayerElevationInfo; /** * An array of fields in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#fields) */ fields?: FieldProperties[]; /** * The geometry type of features in the CSVLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#geometryType) */ geometryType?: "point"; /** * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#labelingInfo) */ labelingInfo?: LabelClassProperties[]; /** * Indicates whether to display labels for this layer. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#labelsVisible) */ labelsVisible?: boolean; /** * The latitude field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#latitudeField) */ latitudeField?: string; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#legendEnabled) */ legendEnabled?: boolean; /** * The longitude field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#longitudeField) */ longitudeField?: string; /** * The name of an `oid` [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#fields) containing a unique value or identifier for each feature in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#objectIdField) */ objectIdField?: string; /** * An array of field names to include in the CSVLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#outFields) */ outFields?: string[]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#popupEnabled) */ popupEnabled?: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * Refresh interval of the layer in minutes. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#refreshInterval) */ refreshInterval?: number; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#renderer) */ renderer?: RendererProperties; /** * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#screenSizePerspectiveEnabled) */ screenSizePerspectiveEnabled?: boolean; /** * The spatial reference of the layer. * * @default SpatialReference.WGS84 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * The URL of the CSV file. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#url) */ url?: string; } export interface CSVLayerCapabilities { /** * Describes characteristics of the data in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ data: CSVLayerCapabilitiesData; /** * Describes editing capabilities that can be performed on the features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ editing: CSVLayerCapabilitiesEditing; /** * Describes operations that can be performed on features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ operations: CSVLayerCapabilitiesOperations; /** * Describes [query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) operations that can be performed on features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ query: CSVLayerCapabilitiesQuery; /** * Indicates if the layer's query operation supports querying features or records related to features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ queryRelated: CSVLayerCapabilitiesQueryRelated; } export interface CSVLayerCapabilitiesData { /** * Indicates if the attachment is enabled on the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsAttachment: boolean; /** * Indicates if the features in the layer support m-values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsM: boolean; /** * Indicates if the features in the layer support z-values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsZ: boolean; } export interface CSVLayerCapabilitiesEditing { /** * Indicates if anonymous users can delete features created by others. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsDeleteByAnonymous: boolean; /** * Indicates if logged in users can delete features created by others. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsDeleteByOthers: boolean; /** * Indicates if the geometry of the features in the layer can be edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsGeometryUpdate: boolean; /** * Indicates if the `globalid` values provided by the client are used in [applyEdits](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#applyEdits). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsGlobalId: boolean; /** * Indicates if the `rollbackOnFailure` parameter can be set to `true` or `false` when running the synchronizeReplica operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsRollbackOnFailure: boolean; /** * Indicates if anonymous users can update features created by others. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsUpdateByAnonymous: boolean; /** * Indicates if logged in users can update features created by others. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsUpdateByOthers: boolean; /** * Indicates if `m-values` must be provided when updating features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsUpdateWithoutM: boolean; /** * Indicates if the layer supports uploading attachments by [UploadId](https://developers.arcgis.com/rest/services-reference/item.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsUploadWithItemId: boolean; } export interface CSVLayerCapabilitiesOperations { /** * Indicates if new features can be [added](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#applyEdits) to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsAdd: boolean; /** * Indicates if features can be [deleted](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#applyEdits) from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsDelete: boolean; /** * Indicates if features in the layer can be [updated](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#applyEdits). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsUpdate: boolean; /** * Indicates if features in the layer can be [edited](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#applyEdits). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsEditing: boolean; /** * Indicates if values of one or more field values in the layer can be updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsCalculate: boolean; /** * Indicates if features in the layer can be [queried](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#queryFeatures). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsQuery: boolean; /** * Indicates if the layer supports [REST API queryAttachments](https://developers.arcgis.com/rest/services-reference/query-attachments-feature-service-layer-.htm) operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsQueryAttachments: boolean; /** * Indicates if the layer supports a SQL-92 expression or where clause. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsValidateSql: boolean; /** * Indicates if resized attachments are supported in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsResizeAttachments: boolean; } export interface CSVLayerCapabilitiesQuery { /** * Indicates if the geometry centroid associated with each polygon feature can be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsCentroid: boolean; /** * Indicates if the layer's query operation supports a buffer distance for input geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsDistance: boolean; /** * Indicates if the layer supports queries for distinct values based on fields specified in the [outFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#outFields). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsDistinct: boolean; /** * Indicates if the query operation supports `disjoint` [spatial relationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#spatialRelationship). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsDisjointSpatialRelationship: boolean; /** * Indicates if the layer's query response includes the extent of features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsExtent: boolean; /** * Indicates if the layer's query response contains geometry attributes, including shape area and length attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsGeometryProperties: boolean; /** * Indicates if the layer supports the [having](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#having) clause on the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsHavingClause: boolean; /** * Indicates if features returned in the query response can be ordered by one or more fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsOrderBy: boolean; /** * Indicates if the query response supports pagination. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsPagination: boolean; /** * Indicates if the layer supports [percentile statisticType](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-StatisticDefinition.html#statisticType). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsPercentileStatistics: boolean; /** * Indicates if the query response includes the [query geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html#queryGeometry). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsQueryGeometry: boolean; /** * Indicates if the query operation supports the projection of geometries onto a virtual grid. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsQuantization: boolean; /** * Indicates if the query operation supports quantization designed to be used in edit mode (highest resolution at the given spatial reference). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsQuantizationEditMode: boolean; /** * Indicates if the number of features returned by the query operation can be controlled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsResultType: boolean; /** * Indicates if the query operation supports SQL expressions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsSqlExpression: boolean; /** * Indicates if the query operation supports using standardized queries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsStandardizedQueriesOnly: boolean; /** * Indicates if the layer supports field-based statistical functions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsStatistics: boolean; /** * Indicates if the layer supports historic moment query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsHistoricMoment: boolean; } export interface CSVLayerCapabilitiesQueryRelated { /** * Indicates if the layer's query response includes the number of features or records related to features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsCount: boolean; /** * Indicates if the related features or records returned in the query response can be ordered by one or more fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsOrderBy: boolean; /** * Indicates if the query response supports pagination for related features or records. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#capabilities) */ supportsPagination: boolean; } export interface CSVLayerElevationInfo { /** * Defines how the feature is placed with respect to the terrain surface or 3D objects in the scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#elevationInfo) */ mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; /** * An elevation offset, which is added to the vertical position of the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#elevationInfo) */ offset?: number; /** * Defines how to override a feature's Z-value based on its attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#elevationInfo) */ featureExpressionInfo?: CSVLayerElevationInfoFeatureExpressionInfo; /** * The unit for `featureExpressionInfo` and `offset` values. * * [Read more...](global.html#unit) */ unit?: "feet" | "meters" | "kilometers" | "miles" | "us-feet" | "yards"; } export interface CSVLayerElevationInfoFeatureExpressionInfo { /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Feature Z Profile](https://developers.arcgis.com/javascript/latest/arcade/#z-values). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#elevationInfo) */ expression?: string; } export interface CSVLayerGetFieldDomainOptions { /** * The feature to which the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) is assigned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#getFieldDomain) */ feature: Graphic; } export interface CSVLayerQueryExtentOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#queryExtent) */ signal?: AbortSignal; } export interface CSVLayerQueryFeatureCountOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#queryFeatureCount) */ signal?: AbortSignal; } export interface CSVLayerQueryFeaturesOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#queryFeatures) */ signal?: AbortSignal; } export interface CSVLayerQueryObjectIdsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#queryObjectIds) */ signal?: AbortSignal; } export interface CSVLayerLayerviewCreateErrorEvent { error: Error; view: View; } export interface CSVLayerLayerviewCreateEvent { layerView: LayerView; view: View; } export interface CSVLayerLayerviewDestroyEvent { layerView: LayerView; view: View; } export interface CSVLayerRefreshEvent { dataChanged: boolean; } export interface DimensionLayer extends Layer, OperationalLayer { } export class DimensionLayer { /** * The analysis object that stores the dimension shapes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-DimensionLayer.html#source) */ source: DimensionAnalysis; /** * The spatial reference of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-DimensionLayer.html#spatialReference) */ readonly spatialReference: SpatialReference; /** * The style defines how the dimension objects of this layer are displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-DimensionLayer.html#style) */ style: DimensionSimpleStyle; readonly type: "dimension"; /** * The dimension layer displays measurement annotations of lengths and distances in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-DimensionLayer.html) */ constructor(properties?: DimensionLayerProperties); static fromJSON(json: any): DimensionLayer; } interface DimensionLayerProperties extends LayerProperties, OperationalLayerProperties { /** * The analysis object that stores the dimension shapes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-DimensionLayer.html#source) */ source?: DimensionAnalysisProperties; /** * The style defines how the dimension objects of this layer are displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-DimensionLayer.html#style) */ style?: DimensionSimpleStyleProperties; } export interface ElevationLayer extends Layer, ArcGISCachedService, PortalLayer, OperationalLayer { } export class ElevationLayer { /** * The [image service's metadata JSON](https://developers.arcgis.com/rest/services-reference/image-service.htm) exposed by the ArcGIS REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#sourceJSON) */ sourceJSON: any; readonly type: "elevation"; /** * URL pointing to the Elevation layer resource on an ArcGIS Image Server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#url) */ url: string; /** * ElevationLayer is a tile layer used for rendering elevations in [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html) */ constructor(properties?: ElevationLayerProperties); /** * Creates an elevation sampler for the given [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) by querying the service layer for elevation data and caching it so values may be sampled quickly afterwards. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#createElevationSampler) */ createElevationSampler(extent: Extent, options?: ElevationLayerCreateElevationSamplerOptions): Promise; /** * Requests a tile from the service and decodes the data into a linear array of elevation values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#fetchTile) */ fetchTile(level: number, row: number, column: number, options?: ElevationLayerFetchTileOptions): Promise; /** * This method returns a URL to a tile for a given level, row and column. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#getTileUrl) */ getTileUrl(level: number, row: number, col: number): string; /** * Queries the service layer for elevation values for the given geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation) */ queryElevation(geometry: Point | Multipoint | Polyline, options?: ElevationLayerQueryElevationOptions): Promise; static fromJSON(json: any): ElevationLayer; } interface ElevationLayerProperties extends LayerProperties, ArcGISCachedServiceProperties, PortalLayerProperties, OperationalLayerProperties { /** * The [image service's metadata JSON](https://developers.arcgis.com/rest/services-reference/image-service.htm) exposed by the ArcGIS REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#sourceJSON) */ sourceJSON?: any; /** * URL pointing to the Elevation layer resource on an ArcGIS Image Server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#url) */ url?: string; } export interface ElevationLayerCreateElevationSamplerOptions { /** * Controls the horizontal resolution (cell size) in meters from which elevation data is sampled (defaults to `auto`). * * @default auto * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#createElevationSampler) */ demResolution?: number | string; /** * The value to use when there is no data available. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#createElevationSampler) */ noDataValue?: number; /** * An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to abort the request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#createElevationSampler) */ signal?: AbortSignal; } export interface ElevationLayerFetchTileOptions { /** * The value representing pixels in the tile that don't contain an elevation value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#fetchTile) */ noDataValue?: number; /** * An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to abort the request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#fetchTile) */ signal?: AbortSignal; } export interface ElevationLayerQueryElevationOptions { /** * Controls the horizontal resolution (cell size) in meters from which elevation data is sampled (defaults to `auto`). * * @default auto * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation) */ demResolution?: number | string; /** * Indicates whether to return additional sample information for each coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation) */ returnSampleInfo?: boolean; /** * The value to use when there is no data available. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation) */ noDataValue?: number; /** * An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to abort the request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation) */ signal?: AbortSignal; } /** * Object returned when [queryElevation()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation) promise resolves: * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#ElevationQueryResult) */ export interface ElevationLayerElevationQueryResult { /** * The geometry with sampled z-values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#ElevationQueryResult) */ geometry: Point | Multipoint | Polyline; /** * Contains additional information about how the geometry was sampled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#ElevationQueryResult) */ sampleInfo?: ElevationLayerElevationQueryResultSampleInfo[]; /** * The value used when there is no data available. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#ElevationQueryResult) */ noDataValue: number; } export interface ElevationLayerElevationQueryResultSampleInfo { /** * The resolution at which the z-value was sampled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#ElevationQueryResult) */ demResolution: number; } export interface FeatureLayer extends Layer, OrderedLayer, PortalLayer, ScaleRangeLayer, TemporalLayer, BlendLayer, CustomParametersMixin, APIKeyMixin, FeatureEffectLayer, FeatureReductionLayer, PublishableLayer, OperationalLayer, Clonable, FeatureLayerBase { } export class FeatureLayer { /** * Array of Chart Items of type WebMapWebChart available on the feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#charts) */ charts: any[]; /** * An object that allows you to create a dynamic layer with data either from map service sublayers or data from a registered workspace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#dynamicDataSource) */ dynamicDataSource: DynamicMapLayer | DynamicDataLayer; /** * Determines if the layer is editable. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#editingEnabled) */ editingEnabled: boolean; /** * An array of fields in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#fields) */ fields: Field[]; /** * The [template](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html) used in an associated layer's [FeatureForm](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#formTemplate) */ formTemplate: FormTemplate; /** * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#labelingInfo) */ labelingInfo: LabelClass[]; /** * Indicates whether to display labels for this layer. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#labelsVisible) */ labelsVisible: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#legendEnabled) */ legendEnabled: boolean; /** * An array of field names from the service to include with each feature. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#outFields) */ outFields: string[]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#popupEnabled) */ popupEnabled: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * Refresh interval of the layer in minutes. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#refreshInterval) */ refreshInterval: number; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#renderer) */ renderer: Renderer; /** * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#screenSizePerspectiveEnabled) */ screenSizePerspectiveEnabled: boolean; /** * A collection of [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) objects used to create a FeatureLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#source) */ source: Collection; /** * An array of feature templates defined in the feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#templates) */ templates: FeatureTemplate[]; readonly type: "feature"; /** * The name of the field holding the type ID for the features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#typeIdField) */ typeIdField: string; /** * An array of [types](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html) defined in the feature service exposed by ArcGIS REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#types) */ types: FeatureType[]; /** * A FeatureLayer is a single layer that can be created from a [Map Service](https://enterprise.arcgis.com/en/server/latest/publish-services/windows/what-is-a-map-service.htm) or [Feature Service](https://enterprise.arcgis.com/en/server/latest/publish-services/windows/what-is-a-feature-service-.htm); ArcGIS Online or ArcGIS Enterprise portal items; or from an array of client-side features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) */ constructor(properties?: FeatureLayerProperties); /** * Creates a popup template for the layer, populated with all the fields of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#createPopupTemplate) */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate; /** * Creates query parameter object that can be used to fetch features that satisfy the layer's configurations such as [definitionExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#definitionExpression), [gdbVersion](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#gdbVersion), and [historicMoment](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#historicMoment). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#createQuery) */ createQuery(): Query; /** * Returns a [FeatureType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html) describing the feature's type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#getFeatureType) */ getFeatureType(feature: Graphic): FeatureType; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the feature service and returns the [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryExtent) */ queryExtent(query?: Query | QueryProperties, options?: FeatureLayerQueryExtentOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the feature service and returns the number of features that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryFeatureCount) */ queryFeatureCount(query?: Query | QueryProperties, options?: FeatureLayerQueryFeatureCountOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the feature service and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html), which can be accessed using the `.then()` method once the promise resolves. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryFeatures) */ queryFeatures(query?: Query | QueryProperties, options?: FeatureLayerQueryFeaturesOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the feature service and returns an array of Object IDs for features that satisfy the input query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryObjectIds) */ queryObjectIds(query?: Query | QueryProperties, options?: FeatureLayerQueryObjectIdsOptions): Promise; /** * Executes a [TopFeaturesQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html) against a feature service and returns the count of features or records that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryTopFeatureCount) */ queryTopFeatureCount(topFeaturesQuery: TopFeaturesQuery | TopFeaturesQueryProperties, options?: FeatureLayerQueryTopFeatureCountOptions): Promise; /** * Executes a [TopFeaturesQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html) against a feature service and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html) once the promise resolves. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryTopFeatures) */ queryTopFeatures(topFeaturesQuery: TopFeaturesQuery | TopFeaturesQueryProperties, options?: FeatureLayerQueryTopFeaturesOptions): Promise; /** * Executes a [TopFeaturesQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html) against a feature service and returns the [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryTopFeaturesExtent) */ queryTopFeaturesExtent(topFeaturesQuery: TopFeaturesQuery | TopFeaturesQueryProperties, options?: FeatureLayerQueryTopFeaturesExtentOptions): Promise; /** * Executes a [TopFeaturesQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html) against a feature service and returns an array of Object IDs of features that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryTopObjectIds) */ queryTopObjectIds(topFeaturesQuery: TopFeaturesQuery | TopFeaturesQueryProperties, options?: FeatureLayerQueryTopObjectIdsOptions): Promise; /** * Fetches all the data for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#refresh) */ refresh(): void; on(name: "refresh", eventHandler: FeatureLayerRefreshEventHandler): IHandle; on(name: "edits", eventHandler: FeatureLayerEditsEventHandler): IHandle; on(name: "layerview-create", eventHandler: FeatureLayerLayerviewCreateEventHandler): IHandle; on(name: "layerview-create-error", eventHandler: FeatureLayerLayerviewCreateErrorEventHandler): IHandle; on(name: "layerview-destroy", eventHandler: FeatureLayerLayerviewDestroyEventHandler): IHandle; static fromJSON(json: any): FeatureLayer; } interface FeatureLayerProperties extends LayerProperties, OrderedLayerProperties, PortalLayerProperties, ScaleRangeLayerProperties, TemporalLayerProperties, BlendLayerProperties, CustomParametersMixinProperties, APIKeyMixinProperties, FeatureEffectLayerProperties, FeatureReductionLayerProperties, PublishableLayerProperties, OperationalLayerProperties, FeatureLayerBaseProperties { /** * Array of Chart Items of type WebMapWebChart available on the feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#charts) */ charts?: any[]; /** * An object that allows you to create a dynamic layer with data either from map service sublayers or data from a registered workspace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#dynamicDataSource) */ dynamicDataSource?: (DynamicMapLayer & { type: "map-layer" }) | (DynamicDataLayer & { type: "data-layer" }); /** * Determines if the layer is editable. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#editingEnabled) */ editingEnabled?: boolean; /** * An array of fields in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#fields) */ fields?: FieldProperties[]; /** * The [template](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html) used in an associated layer's [FeatureForm](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#formTemplate) */ formTemplate?: FormTemplateProperties; /** * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#labelingInfo) */ labelingInfo?: LabelClassProperties[]; /** * Indicates whether to display labels for this layer. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#labelsVisible) */ labelsVisible?: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#legendEnabled) */ legendEnabled?: boolean; /** * An array of field names from the service to include with each feature. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#outFields) */ outFields?: string[]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#popupEnabled) */ popupEnabled?: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * Refresh interval of the layer in minutes. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#refreshInterval) */ refreshInterval?: number; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#renderer) */ renderer?: RendererProperties; /** * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#screenSizePerspectiveEnabled) */ screenSizePerspectiveEnabled?: boolean; /** * A collection of [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) objects used to create a FeatureLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#source) */ source?: CollectionProperties; /** * An array of feature templates defined in the feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#templates) */ templates?: FeatureTemplateProperties[]; /** * The name of the field holding the type ID for the features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#typeIdField) */ typeIdField?: string; /** * An array of [types](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html) defined in the feature service exposed by ArcGIS REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#types) */ types?: FeatureTypeProperties[]; } /** * AttachmentEdit represents an attachment that can be added, updated or deleted via [applyEdits](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#applyEdits). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#AttachmentEdit) */ export interface AttachmentEdit { /** * The feature, `objectId` or `globalId` of feature associated with the attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#AttachmentEdit) */ feature: Graphic | number | string; /** * The attachment to be added, updated or deleted. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#AttachmentEdit) */ attachment: AttachmentEditAttachment; } /** * Describes the layer's supported capabilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ export interface Capabilities { /** * Describes what analytics capabilities are enabled on the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ analytics: CapabilitiesAnalytics; /** * Describes what attachment capabilities are enabled on the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ attachment: CapabilitiesAttachment; /** * Describes characteristics of the data in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ data: CapabilitiesData; /** * Describes editing capabilities that can be performed on the features in the layer via [applyEdits()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#applyEdits). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ editing: CapabilitiesEditing; /** * Describes the metadata contained on features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ metadata: CapabilitiesMetadata; /** * Describes operations that can be performed on features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ operations: CapabilitiesOperations; /** * Describes [query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) operations that can be performed on features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ query: CapabilitiesQuery; /** * Indicates if the layer's query operation supports querying features or records related to features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ queryRelated: CapabilitiesQueryRelated; /** * Describes [top features query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html) operations that can be performed on features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ queryTopFeatures: CapabilitiesQueryTopFeatures; } /** * Results returned from the [applyEdits](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#applyEdits) method if the `returnServiceEditsOption` parameter is set to `original-and-current-features`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditedFeatureResult) */ export interface EditedFeatureResult { /** * The layerId of the feature layer where features were edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditedFeatureResult) */ layerId: number; /** * Object containing all edited features belonging to the specified layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditedFeatureResult) */ editedFeatures: EditedFeatureResultEditedFeatures; } /** * The fields that record who adds or edits data in the feature service and when the edit is made. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditFieldsInfo) */ export interface EditFieldsInfo { /** * The name of the field that stores the name of the user who created the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditFieldsInfo) */ creatorField: string; /** * The name of the field that stores the date and time the feature was created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditFieldsInfo) */ creationDateField: string; /** * The name of the field that stores the name of the user who last edited the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditFieldsInfo) */ editorField: string; /** * The name of the field that stores the date and time the feature was last edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditFieldsInfo) */ editDateField: string; } /** * Specifies information about editing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditingInfo) */ export interface EditingInfo { /** * Indicates the last time the layer was edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditingInfo) */ lastEditDate: Date; } export interface FeatureLayerEditsEvent { addedAttachments: FeatureEditResult[]; addedFeatures: FeatureEditResult[]; deletedAttachments: FeatureEditResult[]; deletedFeatures: FeatureEditResult[]; editedFeatures: EditedFeatureResult; exceededTransferLimit: boolean; updatedAttachments: FeatureEditResult[]; updatedFeatures: FeatureEditResult[]; } /** * Results returned from the [applyEdits](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#applyEdits) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditsResult) */ export interface EditsResult { /** * Result of adding features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditsResult) */ addFeatureResults: FeatureEditResult[]; /** * Result of updating features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditsResult) */ updateFeatureResults: FeatureEditResult[]; /** * Result of deleting features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditsResult) */ deleteFeatureResults: FeatureEditResult[]; /** * Result of adding attachments. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditsResult) */ addAttachmentResults: FeatureEditResult[]; /** * Result of updating attachments. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditsResult) */ updateAttachmentResults: FeatureEditResult[]; /** * Result of deleting attachments. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditsResult) */ deleteAttachmentResults: FeatureEditResult[]; /** * Edited features as result of editing a feature that participates in composite relationships in a database. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditsResult) */ editedFeatureResults?: EditedFeatureResult[]; /** * The time edits were applied to the feature service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditsResult) */ editMoment?: number; } /** * FeatureEditResult represents the result of adding, updating or deleting a feature or an attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#FeatureEditResult) */ export interface FeatureEditResult { /** * The objectId of the feature or the attachmentId of the attachment that was edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#FeatureEditResult) */ objectId: number; /** * The globalId of the feature or the attachment that was edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#FeatureEditResult) */ globalId: string; /** * If the edit failed, the edit result includes an error. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#FeatureEditResult) */ error: FeatureEditResultError; } export interface FeatureLayerQueryExtentOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryExtent) */ signal?: AbortSignal; } export interface FeatureLayerQueryFeatureCountOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryFeatureCount) */ signal?: AbortSignal; } export interface FeatureLayerQueryFeaturesOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryFeatures) */ signal?: AbortSignal; } export interface FeatureLayerQueryObjectIdsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryObjectIds) */ signal?: AbortSignal; } export interface FeatureLayerQueryTopFeatureCountOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryTopFeatureCount) */ signal?: AbortSignal; } export interface FeatureLayerQueryTopFeaturesExtentOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryTopFeaturesExtent) */ signal?: AbortSignal; } export interface FeatureLayerQueryTopFeaturesOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryTopFeatures) */ signal?: AbortSignal; } export interface FeatureLayerQueryTopObjectIdsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryTopObjectIds) */ signal?: AbortSignal; } export interface FeatureLayerLayerviewCreateErrorEvent { error: Error; view: View; } export interface FeatureLayerLayerviewCreateEvent { layerView: LayerView; view: View; } export interface FeatureLayerLayerviewDestroyEvent { layerView: LayerView; view: View; } export interface FeatureLayerRefreshEvent { dataChanged: boolean; } export interface AttachmentEditAttachment { /** * The globalId of the attachment to be added or updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#AttachmentEdit) */ globalId: string; /** * The name of the attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#AttachmentEdit) */ name?: string; /** * The content type of the attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#AttachmentEdit) */ contentType?: string; /** * The id of pre-loaded attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#AttachmentEdit) */ uploadId?: string; /** * The attachment data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#AttachmentEdit) */ data?: Blob | any | string; } export interface CapabilitiesAnalytics { /** * Indicates if the feature service supports cache hint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsCacheHint: boolean; } export interface CapabilitiesAttachment { /** * Indicates if the [attachment operations](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html) support a cache hint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsCacheHint: boolean; /** * Indicates if the attachments can be [queried](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html) by their content types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsContentType: boolean; /** * Indicates if the attachment [queries](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html) support `exifInfo`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsExifInfo: boolean; /** * Indicates if the attachments can be [queried](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html) by their keywords. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsKeywords: boolean; /** * Indicates if the attachments can be [queried](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html) by their names. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsName: boolean; /** * Indicates if the attachments can be [queried](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html) by their sizes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsSize: boolean; /** * Indicates if resized attachments are supported in the feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsResize: boolean; } export interface CapabilitiesData { /** * Indicates if the feature service is versioned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ isVersioned: boolean; /** * Indicates if the attachment is enabled on the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsAttachment: boolean; /** * Indicates if the features in the layer support m-values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsM: boolean; /** * Indicates if the features in the layer support z-values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsZ: boolean; } export interface CapabilitiesEditing { /** * Indicates if anonymous users can delete features created by others. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsDeleteByAnonymous: boolean; /** * Indicates if logged in users can delete features created by others. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsDeleteByOthers: boolean; /** * Indicates if the geometry of the features in the layer can be edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsGeometryUpdate: boolean; /** * Indicates if the `globalId` values provided by the client are used in [applyEdits](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#applyEdits). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsGlobalId: boolean; /** * Indicates if the `rollbackOnFailureEnabled` parameter can be set to `true` or `false` when editing features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsRollbackOnFailure: boolean; /** * Indicates if anonymous users can update features created by others. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsUpdateByAnonymous: boolean; /** * Indicates if logged in users can update features created by others. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsUpdateByOthers: boolean; /** * Indicates if the layer supports uploading attachments by [UploadId](https://developers.arcgis.com/rest/services-reference/item.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsUploadWithItemId: boolean; /** * Indicates if `m-values` must be provided when updating features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsUpdateWithoutM: boolean; } export interface CapabilitiesMetadata { /** * Indicates whether to provide a user-defined field description. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsAdvancedFieldProperties: boolean; } export interface CapabilitiesOperations { /** * Indicates if new features can be [added](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#applyEdits) to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsAdd: boolean; /** * Indicates if values of one or more field values in the layer can be updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsCalculate: boolean; /** * Indicates if features can be [deleted](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#applyEdits) from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsDelete: boolean; /** * Indicates if features in the layer can be [edited](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#applyEdits). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsEditing: boolean; /** * Indicates if features in the layer can be [queried](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryFeatures). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsQuery: boolean; /** * Indicates if the layer supports [REST API queryAttachments](https://developers.arcgis.com/rest/services-reference/query-attachments-feature-service-layer-.htm) operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsQueryAttachments: boolean; /** * Deprecated since 4.24. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsResizeAttachments: boolean; /** * Indicates if the layer supports [REST API queryTopFeatures](https://developers.arcgis.com/rest/services-reference/enterprise/query-top-features-feature-service-layer-.htm) operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsQueryTopFeatures: boolean; /** * Indicates if features in the layer can be [updated](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#applyEdits). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsUpdate: boolean; /** * Indicates if the layer supports a SQL-92 expression or where clause. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsValidateSql: boolean; } export interface CapabilitiesQuery { /** * The maximum number of records that will be returned for a given query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ maxRecordCount: number; /** * Indicates if the query operation supports a [cache hint](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#cacheHint). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsCacheHint: boolean; /** * Indicates if the geometry centroid associated with each polygon feature can be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsCentroid: boolean; /** * Indicates if the query operation supports `disjoint` [spatial relationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#spatialRelationship). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsDisjointSpatialRelationship: boolean; /** * Indicates if the layer's query operation supports a buffer distance for input geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsDistance: boolean; /** * Indicates if the layer supports queries for distinct values based on fields specified in the [outFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#outFields). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsDistinct: boolean; /** * Indicates if the layer's query response includes the extent of features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsExtent: boolean; /** * Indicates if the layer's query response contains geometry attributes, including shape area and length attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsGeometryProperties: boolean; /** * Indicates if the layer supports the [having](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#having) clause on the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsHavingClause: boolean; /** * Indicates if the layer supports historic moment query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsHistoricMoment: boolean; /** * Indicates if the layer supports [Query.maxRecordCountFactor](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#maxRecordCountFactor) on the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsMaxRecordCountFactor: boolean; /** * Indicates if features returned in the query response can be ordered by one or more fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsOrderBy: boolean; /** * Indicates if the query response supports pagination. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsPagination: boolean; /** * Indicates if the layer supports [percentile statisticType](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-StatisticDefinition.html#statisticType). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsPercentileStatistics: boolean; /** * Indicates if the query operation supports the projection of geometries onto a virtual grid. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsQuantization: boolean; /** * Indicates if the query operation supports quantization designed to be used in edit mode (highest resolution at the given spatial reference). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsQuantizationEditMode: boolean; /** * Indicates if the query response includes the [query geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html#queryGeometry). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsQueryGeometry: boolean; /** * Indicates if the number of features returned by the query operation can be controlled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsResultType: boolean; /** * Indicates if the layer supports using standardized queries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsStandardizedQueriesOnly: boolean; /** * Indicates if the layer supports field-based statistical functions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsStatistics: boolean; /** * Indicates if the layer supports SQL expressions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsSqlExpression: boolean; /** * Indicates if the layer supports spatial extent, center or convex hull to be returned for each distinct group when [groupByFieldsForStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#groupByFieldsForStatistics) is used. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsSpatialAggregationStatistics: boolean; /** * List of supported aggregated geometries returned for each distinct group when [groupByFieldsForStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#groupByFieldsForStatistics) is used. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportedSpatialStatisticAggregations: CapabilitiesQuerySupportedSpatialStatisticAggregations; } export interface CapabilitiesQueryRelated { /** * Indicates if the [relationship query operation](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html) supports a cache hint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsCacheHint: boolean; /** * Indicates if the layer's query response includes the number of features or records related to features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsCount: boolean; /** * Indicates if the related features or records returned in the query response can be ordered by one or more fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsOrderBy: boolean; /** * Indicates if the query response supports pagination for related features or records. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsPagination: boolean; } export interface CapabilitiesQuerySupportedSpatialStatisticAggregations { /** * Indicates if the layer can return centroid for each distinct group for [groupByFieldsForStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#groupByFieldsForStatistics). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ centroid: boolean; /** * Indicates if the layer can return extent for each distinct group for [groupByFieldsForStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#groupByFieldsForStatistics). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ envelope: boolean; /** * Indicates if the layer can return convex hull for each distinct group for [groupByFieldsForStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#groupByFieldsForStatistics). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ convexHull: boolean; } export interface CapabilitiesQueryTopFeatures { /** * Indicates if the [top query operation](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html) supports a cache hint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#Capabilities) */ supportsCacheHint: boolean; } export interface EditedFeatureResultEditedFeatures { /** * Newly added features as a result of editing a feature that participates in a composite relationship. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditedFeatureResult) */ adds?: Graphic[]; /** * Object containing original and updated features as a result of editing a feature that participates in a composite relationship. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditedFeatureResult) */ updates?: EditedFeatureResultEditedFeaturesUpdates[]; /** * Deleted features as a result of editing a feature that participates in a composite relationship. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditedFeatureResult) */ deletes?: Graphic[]; /** * Edited features are returned in the spatial reference of the feature service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditedFeatureResult) */ spatialReference?: SpatialReference; } export interface EditedFeatureResultEditedFeaturesUpdates { /** * Original feature before the update took place. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditedFeatureResult) */ original?: Graphic[]; /** * Updated feature as a result of editing a feature that participates in a composite relationship. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditedFeatureResult) */ current?: Graphic[]; } export interface FeatureEditResultError { /** * Error name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#FeatureEditResult) */ name: string; /** * Message describing the error. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#FeatureEditResult) */ message: string; } export interface GeoJSONLayer extends Layer, BlendLayer, OrderedLayer, ScaleRangeLayer, FeatureEffectLayer, FeatureReductionLayer, OperationalLayer { } export class GeoJSONLayer { /** * Describes the layer's supported capabilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ readonly capabilities: GeoJSONLayerCapabilities; /** * Copyright information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#copyright) */ copyright: string; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#customParameters) */ customParameters: any; /** * The time zone that dates are stored in. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#dateFieldsTimeZone) */ readonly dateFieldsTimeZone: string; /** * The SQL where clause used to filter features on the client. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#definitionExpression) */ definitionExpression: string; /** * The name of the layer's primary display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#displayField) */ displayField: string; /** * Indicates if the layer is editable. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#editingEnabled) */ editingEnabled: boolean; /** * Specifies how features are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#elevationInfo) */ elevationInfo: GeoJSONLayerElevationInfo; /** * An array of fields in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#fields) */ fields: Field[]; /** * A convenient property that can be used to make case-insensitive lookups for a field by name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#fieldsIndex) */ readonly fieldsIndex: FieldsIndex; /** * The geometry type of features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#geometryType) */ geometryType: "point" | "polygon" | "polyline" | "multipoint"; /** * Indicates whether the client-side features in the layer have `Z` (elevation) values. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#hasZ) */ readonly hasZ: boolean; /** * Returns `true` if the layer is loaded from a non-spatial table in a service. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#isTable) */ readonly isTable: boolean; /** * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#labelingInfo) */ labelingInfo: LabelClass[]; /** * Indicates whether to display labels for this layer. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#labelsVisible) */ labelsVisible: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#legendEnabled) */ legendEnabled: boolean; /** * The name of a [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#fields) containing a unique value or identifier for each feature in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#objectIdField) */ objectIdField: string; /** * An array of field names from the geoJSON file to include with each feature. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#outFields) */ outFields: string[]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#popupEnabled) */ popupEnabled: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * The portal item referencing the geojson file from which the GeoJSONLayer is loaded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#portalItem) */ portalItem: PortalItem; /** * Refresh interval of the layer in minutes. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#refreshInterval) */ refreshInterval: number; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#renderer) */ renderer: Renderer; /** * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#screenSizePerspectiveEnabled) */ screenSizePerspectiveEnabled: boolean; /** * The spatial reference of the layer. * * @default SpatialReference.WGS84 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#spatialReference) */ spatialReference: SpatialReference; /** * An array of feature templates defined in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#templates) */ templates: FeatureTemplate[]; /** * The layer's time extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#timeExtent) */ timeExtent: TimeExtent; /** * TimeInfo provides information such as date fields that store [start](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#startField) and [end](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#endField) time for each feature and the [fullTimeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#fullTimeExtent) for the layer. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#timeInfo) */ timeInfo: TimeInfo; /** * A temporary offset of the time data based on a certain [TimeInterval](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeInterval.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#timeOffset) */ timeOffset: TimeInterval; readonly type: "geojson"; /** * The URL of the GeoJSON file. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#url) */ url: string; /** * Determines if the layer will update its temporal data based on the view's [timeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#timeExtent). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#useViewTime) */ useViewTime: boolean; /** * The GeoJSONLayer class is used to create a layer based on [GeoJSON](http://geojson.org/). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html) */ constructor(properties?: GeoJSONLayerProperties); /** * Applies edits to features in a layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#applyEdits) */ applyEdits(edits: GeoJSONLayerApplyEditsEdits): Promise; /** * Creates a popup template for the layer, populated with all the fields of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#createPopupTemplate) */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate; /** * Creates query parameter object that can be used to fetch features that satisfy the layer's configurations such as [definitionExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#definitionExpression). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#createQuery) */ createQuery(): Query; /** * Returns the [Field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) instance for a field name (case-insensitive). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#getField) */ getField(fieldName: string): Field; /** * Returns the Domain associated with the given field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#getFieldDomain) */ getFieldDomain(fieldName: string, options?: GeoJSONLayerGetFieldDomainOptions): Domain; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the layer and returns the [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#queryExtent) */ queryExtent(query?: Query | QueryProperties, options?: GeoJSONLayerQueryExtentOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the layer and returns the number of features that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#queryFeatureCount) */ queryFeatureCount(query?: Query | QueryProperties, options?: GeoJSONLayerQueryFeatureCountOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the layer and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html), which can be accessed using the `.then()` method once the promise resolves. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#queryFeatures) */ queryFeatures(query?: Query | QueryProperties, options?: GeoJSONLayerQueryFeaturesOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the layer and returns an array of Object IDs for features that satisfy the input query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#queryObjectIds) */ queryObjectIds(query?: Query | QueryProperties, options?: GeoJSONLayerQueryObjectIdsOptions): Promise; /** * Fetches all the data for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#refresh) */ refresh(): void; on(name: "refresh", eventHandler: GeoJSONLayerRefreshEventHandler): IHandle; on(name: "edits", eventHandler: GeoJSONLayerEditsEventHandler): IHandle; on(name: "layerview-create", eventHandler: GeoJSONLayerLayerviewCreateEventHandler): IHandle; on(name: "layerview-create-error", eventHandler: GeoJSONLayerLayerviewCreateErrorEventHandler): IHandle; on(name: "layerview-destroy", eventHandler: GeoJSONLayerLayerviewDestroyEventHandler): IHandle; static fromJSON(json: any): GeoJSONLayer; } interface GeoJSONLayerProperties extends LayerProperties, BlendLayerProperties, OrderedLayerProperties, ScaleRangeLayerProperties, FeatureEffectLayerProperties, FeatureReductionLayerProperties, OperationalLayerProperties { /** * Copyright information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#copyright) */ copyright?: string; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#customParameters) */ customParameters?: any; /** * The SQL where clause used to filter features on the client. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#definitionExpression) */ definitionExpression?: string; /** * The name of the layer's primary display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#displayField) */ displayField?: string; /** * Indicates if the layer is editable. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#editingEnabled) */ editingEnabled?: boolean; /** * Specifies how features are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#elevationInfo) */ elevationInfo?: GeoJSONLayerElevationInfo; /** * An array of fields in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#fields) */ fields?: FieldProperties[]; /** * The geometry type of features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#geometryType) */ geometryType?: "point" | "polygon" | "polyline" | "multipoint"; /** * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#labelingInfo) */ labelingInfo?: LabelClassProperties[]; /** * Indicates whether to display labels for this layer. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#labelsVisible) */ labelsVisible?: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#legendEnabled) */ legendEnabled?: boolean; /** * The name of a [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#fields) containing a unique value or identifier for each feature in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#objectIdField) */ objectIdField?: string; /** * An array of field names from the geoJSON file to include with each feature. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#outFields) */ outFields?: string[]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#popupEnabled) */ popupEnabled?: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * The portal item referencing the geojson file from which the GeoJSONLayer is loaded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#portalItem) */ portalItem?: PortalItemProperties; /** * Refresh interval of the layer in minutes. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#refreshInterval) */ refreshInterval?: number; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#renderer) */ renderer?: RendererProperties; /** * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#screenSizePerspectiveEnabled) */ screenSizePerspectiveEnabled?: boolean; /** * The spatial reference of the layer. * * @default SpatialReference.WGS84 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * An array of feature templates defined in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#templates) */ templates?: FeatureTemplateProperties[]; /** * The layer's time extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#timeExtent) */ timeExtent?: TimeExtentProperties; /** * TimeInfo provides information such as date fields that store [start](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#startField) and [end](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#endField) time for each feature and the [fullTimeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#fullTimeExtent) for the layer. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#timeInfo) */ timeInfo?: TimeInfoProperties; /** * A temporary offset of the time data based on a certain [TimeInterval](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeInterval.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#timeOffset) */ timeOffset?: TimeIntervalProperties; /** * The URL of the GeoJSON file. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#url) */ url?: string; /** * Determines if the layer will update its temporal data based on the view's [timeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#timeExtent). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#useViewTime) */ useViewTime?: boolean; } export interface GeoJSONLayerEditsEvent { addedFeatures: GeoJSONLayerEditsEventAddedFeatures[]; deletedFeatures: GeoJSONLayerEditsEventDeletedFeatures[]; updatedFeatures: GeoJSONLayerEditsEventUpdatedFeatures[]; } export interface GeoJSONLayerApplyEditsEdits { /** * An array or a [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of features to be added. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#applyEdits) */ addFeatures?: Graphic[] | Collection; /** * An array or a [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of features to be updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#applyEdits) */ updateFeatures?: Graphic[] | Collection; /** * An array or a [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of features, or objects to be deleted. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#applyEdits) */ deleteFeatures?: Graphic[] | any[] | Collection; } export interface GeoJSONLayerCapabilities { /** * Describes characteristics of the data in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ data: GeoJSONLayerCapabilitiesData; /** * Describes editing capabilities that can be performed on the features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ editing: GeoJSONLayerCapabilitiesEditing; /** * Describes operations that can be performed on features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ operations: GeoJSONLayerCapabilitiesOperations; /** * Describes [query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) operations that can be performed on features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ query: GeoJSONLayerCapabilitiesQuery; /** * Indicates if the layer's query operation supports querying features or records related to features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ queryRelated: GeoJSONLayerCapabilitiesQueryRelated; } export interface GeoJSONLayerCapabilitiesData { /** * Indicates if the attachment is enabled on the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsAttachment: boolean; /** * Indicates if the features in the layer support m-values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsM: boolean; /** * Indicates if the features in the layer support z-values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsZ: boolean; } export interface GeoJSONLayerCapabilitiesEditing { /** * Indicates if anonymous users can delete features created by others. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsDeleteByAnonymous: boolean; /** * Indicates if logged in users can delete features created by others. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsDeleteByOthers: boolean; /** * Indicates if the geometry of the features in the layer can be edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsGeometryUpdate: boolean; /** * Indicates if the `globalid` values provided by the client are used in [applyEdits](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#applyEdits). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsGlobalId: boolean; /** * Indicates if the `rollbackOnFailure` parameter can be set to `true` or `false` when running the synchronizeReplica operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsRollbackOnFailure: boolean; /** * Indicates if anonymous users can update features created by others. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsUpdateByAnonymous: boolean; /** * Indicates if logged in users can update features created by others. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsUpdateByOthers: boolean; /** * Indicates if `m-values` must be provided when updating features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsUpdateWithoutM: boolean; /** * Indicates if the layer supports uploading attachments by [UploadId](https://developers.arcgis.com/rest/services-reference/item.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsUploadWithItemId: boolean; } export interface GeoJSONLayerCapabilitiesOperations { /** * Indicates if new features can be [added](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#applyEdits) to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsAdd: boolean; /** * Indicates if features can be [deleted](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#applyEdits) from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsDelete: boolean; /** * Indicates if features in the layer can be [updated](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#applyEdits). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsUpdate: boolean; /** * Indicates if features in the layer can be [edited](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#applyEdits). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsEditing: boolean; /** * Indicates if values of one or more field values in the layer can be updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsCalculate: boolean; /** * Indicates if features in the layer can be [queried](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#queryFeatures). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsQuery: boolean; /** * Indicates if the layer supports [REST API queryAttachments](https://developers.arcgis.com/rest/services-reference/query-attachments-feature-service-layer-.htm) operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsQueryAttachments: boolean; /** * Indicates if the layer supports a SQL-92 expression or where clause. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsValidateSql: boolean; /** * Indicates if resized attachments are supported in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsResizeAttachments: boolean; } export interface GeoJSONLayerCapabilitiesQuery { /** * Indicates if the geometry centroid associated with each polygon feature can be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsCentroid: boolean; /** * Indicates if the layer's query operation supports a buffer distance for input geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsDistance: boolean; /** * Indicates if the layer supports queries for distinct values based on fields specified in the [outFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#outFields). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsDistinct: boolean; /** * Indicates if the query operation supports `disjoint` [spatial relationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#spatialRelationship). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsDisjointSpatialRelationship: boolean; /** * Indicates if the layer's query response includes the extent of features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsExtent: boolean; /** * Indicates if the layer's query response contains geometry attributes, including shape area and length attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsGeometryProperties: boolean; /** * Indicates if the layer supports the [having](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#having) clause on the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsHavingClause: boolean; /** * Indicates if features returned in the query response can be ordered by one or more fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsOrderBy: boolean; /** * Indicates if the query response supports pagination. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsPagination: boolean; /** * Indicates if the layer supports [percentile statisticType](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-StatisticDefinition.html#statisticType). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsPercentileStatistics: boolean; /** * Indicates if the query response includes the [query geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html#queryGeometry). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsQueryGeometry: boolean; /** * Indicates if the query operation supports the projection of geometries onto a virtual grid. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsQuantization: boolean; /** * Indicates if the query operation supports quantization designed to be used in edit mode (highest resolution at the given spatial reference). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsQuantizationEditMode: boolean; /** * Indicates if the number of features returned by the query operation can be controlled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsResultType: boolean; /** * Indicates if the query operation supports SQL expressions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsSqlExpression: boolean; /** * Indicates if the query operation supports using standardized queries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsStandardizedQueriesOnly: boolean; /** * Indicates if the layer supports field-based statistical functions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsStatistics: boolean; /** * Indicates if the layer supports historic moment query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsHistoricMoment: boolean; } export interface GeoJSONLayerCapabilitiesQueryRelated { /** * Indicates if the layer's query response includes the number of features or records related to features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsCount: boolean; /** * Indicates if the related features or records returned in the query response can be ordered by one or more fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsOrderBy: boolean; /** * Indicates if the query response supports pagination for related features or records. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#capabilities) */ supportsPagination: boolean; } export interface GeoJSONLayerElevationInfo { /** * Defines how the feature is placed with respect to the terrain surface or 3D objects in the scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#elevationInfo) */ mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; /** * An elevation offset, which is added to the vertical position of the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#elevationInfo) */ offset?: number; /** * Defines how to override a feature's Z-value based on its attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#elevationInfo) */ featureExpressionInfo?: GeoJSONLayerElevationInfoFeatureExpressionInfo; /** * The unit for `featureExpressionInfo` and `offset` values. * * [Read more...](global.html#unit) */ unit?: "feet" | "meters" | "kilometers" | "miles" | "us-feet" | "yards"; } export interface GeoJSONLayerElevationInfoFeatureExpressionInfo { /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Feature Z Profile](https://developers.arcgis.com/javascript/latest/arcade/#z-values). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#elevationInfo) */ expression?: string; } export interface GeoJSONLayerGetFieldDomainOptions { /** * The feature to which the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) is assigned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#getFieldDomain) */ feature: Graphic; } export interface GeoJSONLayerQueryExtentOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#queryExtent) */ signal?: AbortSignal; } export interface GeoJSONLayerQueryFeatureCountOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#queryFeatureCount) */ signal?: AbortSignal; } export interface GeoJSONLayerQueryFeaturesOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#queryFeatures) */ signal?: AbortSignal; } export interface GeoJSONLayerQueryObjectIdsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#queryObjectIds) */ signal?: AbortSignal; } export interface GeoJSONLayerLayerviewCreateErrorEvent { error: Error; view: View; } export interface GeoJSONLayerLayerviewCreateEvent { layerView: LayerView; view: View; } export interface GeoJSONLayerLayerviewDestroyEvent { layerView: LayerView; view: View; } export interface GeoJSONLayerRefreshEvent { dataChanged: boolean; } export interface GeoJSONLayerEditsEventAddedFeatures { objectId: number; } export interface GeoJSONLayerEditsEventDeletedFeatures { objectId: number; } export interface GeoJSONLayerEditsEventUpdatedFeatures { objectId: number; } export interface GeoRSSLayer extends Layer, ScaleRangeLayer, BlendLayer, OperationalLayer { } export class GeoRSSLayer { /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html#legendEnabled) */ legendEnabled: boolean; /** * Symbol used to represent line features from the GeoRSS feed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html#lineSymbol) */ lineSymbol: SimpleLineSymbol; /** * Symbol used to represent point features from the GeoRSS feed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html#pointSymbol) */ pointSymbol: PictureMarkerSymbol | SimpleMarkerSymbol; /** * Symbol used to represent polygon features from the GeoRSS feed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html#polygonSymbol) */ polygonSymbol: SimpleFillSymbol; /** * Refresh interval of the layer in minutes. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html#refreshInterval) */ refreshInterval: number; readonly type: "geo-rss"; /** * The URL pointing to a GeoRSS file. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html#url) */ url: string; /** * The GeoRSSLayer class is used to create a layer based on [GeoRSS](https://www.ogc.org/standards/georss). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html) */ constructor(properties?: GeoRSSLayerProperties); /** * Fetches all the data for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html#refresh) */ refresh(): void; on(name: "refresh", eventHandler: GeoRSSLayerRefreshEventHandler): IHandle; on(name: "layerview-create", eventHandler: GeoRSSLayerLayerviewCreateEventHandler): IHandle; on(name: "layerview-create-error", eventHandler: GeoRSSLayerLayerviewCreateErrorEventHandler): IHandle; on(name: "layerview-destroy", eventHandler: GeoRSSLayerLayerviewDestroyEventHandler): IHandle; static fromJSON(json: any): GeoRSSLayer; } interface GeoRSSLayerProperties extends LayerProperties, ScaleRangeLayerProperties, BlendLayerProperties, OperationalLayerProperties { /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html#legendEnabled) */ legendEnabled?: boolean; /** * Symbol used to represent line features from the GeoRSS feed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html#lineSymbol) */ lineSymbol?: SimpleLineSymbolProperties; /** * Symbol used to represent point features from the GeoRSS feed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html#pointSymbol) */ pointSymbol?: | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (SimpleMarkerSymbolProperties & { type: "simple-marker" }); /** * Symbol used to represent polygon features from the GeoRSS feed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html#polygonSymbol) */ polygonSymbol?: SimpleFillSymbolProperties; /** * Refresh interval of the layer in minutes. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html#refreshInterval) */ refreshInterval?: number; /** * The URL pointing to a GeoRSS file. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html#url) */ url?: string; } export interface GeoRSSLayerLayerviewCreateErrorEvent { error: Error; view: View; } export interface GeoRSSLayerLayerviewCreateEvent { layerView: LayerView; view: View; } export interface GeoRSSLayerLayerviewDestroyEvent { layerView: LayerView; view: View; } export interface GeoRSSLayerRefreshEvent { dataChanged: boolean; } export interface GraphicsLayer extends Layer, ScaleRangeLayer, BlendLayer { } export class GraphicsLayer { /** * Specifies how graphics are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#elevationInfo) */ elevationInfo: GraphicsLayerElevationInfo; /** * A collection of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#graphics) */ graphics: Collection; /** * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#screenSizePerspectiveEnabled) */ screenSizePerspectiveEnabled: boolean; readonly type: "graphics"; /** * A GraphicsLayer contains one or more client-side [Graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) */ constructor(properties?: GraphicsLayerProperties); /** * Adds a graphic to the layer's graphic collection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#add) */ add(graphic: Graphic): void; /** * Adds an array of graphics to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#addMany) */ addMany(graphics: Graphic[]): void; /** * Removes a graphic from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#remove) */ remove(graphic: Graphic): void; /** * Clears all the graphics from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#removeAll) */ removeAll(): void; /** * Removes an array of graphics from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#removeMany) */ removeMany(graphics: Graphic[]): void; } interface GraphicsLayerProperties extends LayerProperties, ScaleRangeLayerProperties, BlendLayerProperties { /** * Specifies how graphics are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#elevationInfo) */ elevationInfo?: GraphicsLayerElevationInfo; /** * A collection of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#graphics) */ graphics?: CollectionProperties; /** * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#screenSizePerspectiveEnabled) */ screenSizePerspectiveEnabled?: boolean; } export interface GraphicsLayerElevationInfo { /** * Defines how the feature is placed with respect to the terrain surface or 3D objects in the scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#elevationInfo) */ mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; /** * An elevation offset, which is added to the vertical position of the graphic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#elevationInfo) */ offset?: number; /** * Defines how to override a feature's Z-value based on its attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#elevationInfo) */ featureExpressionInfo?: GraphicsLayerElevationInfoFeatureExpressionInfo; /** * The unit for `featureExpressionInfo` and `offset` values. * * [Read more...](global.html#unit) */ unit?: "feet" | "meters" | "kilometers" | "miles" | "us-feet" | "yards"; } export interface GraphicsLayerElevationInfoFeatureExpressionInfo { /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Feature Z Profile](https://developers.arcgis.com/javascript/latest/arcade/#z-values). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#elevationInfo) */ expression?: string; } export interface GroupLayer extends Layer, LayersMixin, TablesMixin, PortalLayer, BlendLayer, OperationalLayer { } export class GroupLayer { /** * A flattened collection of all [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) in the group layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#allLayers) */ readonly allLayers: Collection; /** * A flattened collection of tables anywhere in the group layer's hierarchy. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#allTables) */ readonly allTables: Collection; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#maxScale) */ maxScale: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#minScale) */ minScale: number; readonly type: "group"; /** * Indicates how to manage the visibility of the children layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#visibilityMode) */ visibilityMode: "independent" | "inherited" | "exclusive"; /** * GroupLayer provides the ability to organize several sublayers into one common layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html) */ constructor(properties?: GroupLayerProperties); /** * Loads all the externally loadable resources associated with the group layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#loadAll) */ loadAll(): Promise; /** * Saves the layer to its existing portal item in the [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html) authenticated within the user's current session. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#save) */ save(options?: GroupLayerSaveOptions): Promise; /** * Saves the layer to a new portal item in the [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html) authenticated within the user's current session. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#saveAs) */ saveAs(portalItem: PortalItem | PortalItemProperties, options?: GroupLayerSaveAsOptions): Promise; static fromJSON(json: any): GroupLayer; } interface GroupLayerProperties extends LayerProperties, LayersMixinProperties, TablesMixinProperties, PortalLayerProperties, BlendLayerProperties, OperationalLayerProperties { /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#maxScale) */ maxScale?: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#minScale) */ minScale?: number; /** * Indicates how to manage the visibility of the children layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#visibilityMode) */ visibilityMode?: "independent" | "inherited" | "exclusive"; } export interface GroupLayerSaveAsOptions { /** * The portal folder where the layer's portal item will be saved. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#saveAs) */ folder?: PortalFolder; /** * Options for validating the save operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#saveAs) */ validationOptions?: GroupLayerSaveAsOptionsValidationOptions; } export interface GroupLayerSaveAsOptionsValidationOptions { /** * Indicates whether to ignore saving unsupported layers or layers with unsupported content, such as unsupported symbology. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#saveAs) */ ignoreUnsupported?: boolean; } export interface GroupLayerSaveOptions { /** * Options for validating the save operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#save) */ validationOptions?: GroupLayerSaveOptionsValidationOptions; } export interface GroupLayerSaveOptionsValidationOptions { /** * Indicates whether to ignore saving unsupported layers or layers with unsupported content, such as unsupported symbology. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#save) */ ignoreUnsupported?: boolean; } export interface ImageryLayer extends Layer, ArcGISImageService, OperationalLayer, PortalLayer, RefreshableLayer, ScaleRangeLayer, TemporalLayer, BlendLayer, Clonable { } export class ImageryLayer { /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#customParameters) */ customParameters: any; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#legendEnabled) */ legendEnabled: boolean; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#popupEnabled) */ popupEnabled: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#popupTemplate) */ popupTemplate: PopupTemplate; readonly type: "imagery"; /** * Represents a dynamic [image service resource](https://developers.arcgis.com/rest/services-reference/image-service.htm) as a layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html) */ constructor(properties?: ImageryLayerProperties); /** * Creates a default popup template for the layer, populated with all the fields of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#createPopupTemplate) */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate; /** * Executes the [pixelFilter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#pixelFilter) function and redraws the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#redraw) */ redraw(): void; /** * Saves the layer to its existing portal item in the [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html) authenticated within the user's current session. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#save) */ save(options?: ImageryLayerSaveOptions): Promise; /** * Saves the layer to a new portal item in the [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html) authenticated within the user's current session. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#saveAs) */ saveAs(portalItem: PortalItem | PortalItemProperties, options?: ImageryLayerSaveAsOptions): Promise; on(name: "refresh", eventHandler: ImageryLayerRefreshEventHandler): IHandle; on(name: "layerview-create", eventHandler: ImageryLayerLayerviewCreateEventHandler): IHandle; on(name: "layerview-create-error", eventHandler: ImageryLayerLayerviewCreateErrorEventHandler): IHandle; on(name: "layerview-destroy", eventHandler: ImageryLayerLayerviewDestroyEventHandler): IHandle; static fromJSON(json: any): ImageryLayer; } interface ImageryLayerProperties extends LayerProperties, ArcGISImageServiceProperties, OperationalLayerProperties, PortalLayerProperties, RefreshableLayerProperties, ScaleRangeLayerProperties, TemporalLayerProperties, BlendLayerProperties { /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#customParameters) */ customParameters?: any; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#legendEnabled) */ legendEnabled?: boolean; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#popupEnabled) */ popupEnabled?: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; } export interface ImageryLayerSaveAsOptions { /** * The portal folder where the layer's portal item will be saved. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#saveAs) */ folder?: PortalFolder; /** * Options for validating the save operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#saveAs) */ validationOptions?: ImageryLayerSaveAsOptionsValidationOptions; } export interface ImageryLayerSaveAsOptionsValidationOptions { /** * Indicates whether to ignore saving unsupported layers or layers with unsupported content, such as unsupported symbology. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#saveAs) */ ignoreUnsupported?: boolean; } export interface ImageryLayerSaveOptions { /** * Options for validating the save operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#save) */ validationOptions?: ImageryLayerSaveOptionsValidationOptions; } export interface ImageryLayerSaveOptionsValidationOptions { /** * Indicates whether to ignore saving unsupported layers or layers with unsupported content, such as unsupported symbology. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#save) */ ignoreUnsupported?: boolean; } export interface ImageryLayerLayerviewCreateErrorEvent { error: Error; view: View; } export interface ImageryLayerLayerviewCreateEvent { layerView: LayerView; view: View; } export interface ImageryLayerLayerviewDestroyEvent { layerView: LayerView; view: View; } /** * An object containing measurement values returned from a mensuration operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#measurementValue) */ export interface MeasurementValue { /** * Measured value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#measurementValue) */ value: number; /** * Uncertainty of the measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#measurementValue) */ uncertainty: number; /** * Unit used in the mensuration operation. * * [Read more...](global.html#unit) */ unit: string; /** * Measured value represented in significant figures in string format. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#measurementValue) */ displayValue: string; } /** * An object that provides the user access to [pixels](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixels) and their values in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#PixelData) */ export interface PixelData { /** * The extent of the `pixelBlock`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#PixelData) */ extent: Extent; /** * An object representing the pixels in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#PixelData) */ pixelBlock: PixelBlock; } export type PixelFilterFunction = (pixelData: PixelData) => void; /** * Raster statistics information returned that meets the specified [ImageHistogramParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html) from the `computeStatisticsHistograms()` method on [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#computeStatisticsHistograms) or [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#computeStatisticsHistograms). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterBandStatistics) */ export interface RasterBandStatistics { /** * Minimum value of the statistics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterBandStatistics) */ min: number; /** * Maximum value of the statistics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterBandStatistics) */ max: number; /** * Average of the statistics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterBandStatistics) */ avg: number; /** * Standard deviation of the statistics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterBandStatistics) */ stddev: number; /** * Count of the statistics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterBandStatistics) */ count?: number; /** * Mode value of the statistics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterBandStatistics) */ mode?: number; /** * Median value of the statistics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterBandStatistics) */ median?: number; /** * Sum of the statistics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterBandStatistics) */ sum?: number; } /** * The raster function published with the image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterFunctionInfo) */ export interface RasterFunctionInfo { /** * Name of the raster function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterFunctionInfo) */ name: string; /** * Description of the raster function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterFunctionInfo) */ description: string; /** * Additional info describing what the raster function does. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterFunctionInfo) */ help: string; /** * The function type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterFunctionInfo) */ functionType: number; /** * Inline base64 encoded thumbnail of the raster function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterFunctionInfo) */ thumbnail: string; } /** * Raster histogram information returned that meets the specified [ImageHistogramParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html) from the [computeHistograms()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#computeHistograms) or [computeStatisticsHistograms()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#computeStatisticsHistograms) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterHistogram) */ export interface RasterHistogram { /** * Number of bins. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterHistogram) */ size: number; /** * The minimum pixel value of the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterHistogram) */ min: number; /** * The maximum pixel value of the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterHistogram) */ max: number; /** * Count of pixels that fall into each bin. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterHistogram) */ counts: number[] | Uint32Array; } export interface ImageryLayerRefreshEvent { dataChanged: boolean; } export interface ImageryTileLayer extends Layer, ImageryTileMixin, OperationalLayer, PortalLayer, ScaleRangeLayer, BlendLayer, Clonable { } export class ImageryTileLayer { /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#customParameters) */ customParameters: any; /** * Defines how to interpolate pixel values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#interpolation) */ interpolation: "nearest" | "bilinear" | "cubic" | "majority"; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#legendEnabled) */ legendEnabled: boolean; /** * Represents a multidimensional subset of raster data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#multidimensionalSubset) */ multidimensionalSubset: MultidimensionalSubset; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#popupEnabled) */ popupEnabled: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * A complete list of fields that consists of service pixel value and vector fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#rasterFields) */ readonly rasterFields: Field[]; /** * The client-side raster functions are operations that apply processing directly to the source image pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#rasterFunction) */ rasterFunction: RasterFunction; /** * The data source for client-side ImageryTileLayer can be a [coverage JSON](https://www.ogc.org/standard/coveragejson/) object or [PixelData](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#PixelData). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#source) */ source: any | PixelData; /** * The [tiled image service's metadata JSON](https://developers.arcgis.com/rest/services-reference/image-service.htm) exposed by the ArcGIS REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#sourceJSON) */ sourceJSON: any; /** * The tiling scheme information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#tileInfo) */ tileInfo: TileInfo; /** * The layer's time extent. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#timeExtent) */ timeExtent: TimeExtent; /** * TimeInfo provides information such as date fields that store [start](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#startField) and [end](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#endField) time for each feature and the [fullTimeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#fullTimeExtent) for the layer. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#timeInfo) */ timeInfo: TimeInfo; /** * A temporary offset of the time data based on a certain [TimeInterval](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeInterval.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#timeOffset) */ timeOffset: TimeInterval; readonly type: "imagery-tile"; /** * The URL of the REST endpoint of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#url) */ url: string; /** * Determines if the layer will update its temporal data based on the view's [timeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#timeExtent). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#useViewTime) */ useViewTime: boolean; /** * The version of ArcGIS Server in which the image service is published. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#version) */ readonly version: number; /** * ImageryTileLayer presents raster data from a tiled image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html) */ constructor(properties?: ImageryTileLayerProperties); /** * Computes [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterBandStatistics) and [histograms](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterHistogram) for the provided [ImageHistogramParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#computeStatisticsHistograms) */ computeStatisticsHistograms(parameters: ImageHistogramParameters | ImageHistogramParametersProperties, requestOptions?: any): Promise; /** * Creates a default popup template for the layer, populated with all the fields of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#createPopupTemplate) */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate; /** * This method fetches a tile for the given level, row and column present in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#fetchTile) */ fetchTile(level: number, row: number, col: number, options?: ImageryTileLayerFetchTileOptions): Promise; /** * Saves the layer to its existing portal item in the [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html) authenticated within the user's current session. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#save) */ save(options?: ImageryTileLayerSaveOptions): Promise; /** * Saves the layer to a new portal item in the [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html) authenticated within the user's current session. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#saveAs) */ saveAs(portalItem: PortalItem | PortalItemProperties, options?: ImageryTileLayerSaveAsOptions): Promise; static fromJSON(json: any): ImageryTileLayer; } interface ImageryTileLayerProperties extends LayerProperties, ImageryTileMixinProperties, OperationalLayerProperties, PortalLayerProperties, ScaleRangeLayerProperties, BlendLayerProperties { /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#customParameters) */ customParameters?: any; /** * Defines how to interpolate pixel values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#interpolation) */ interpolation?: "nearest" | "bilinear" | "cubic" | "majority"; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#legendEnabled) */ legendEnabled?: boolean; /** * Represents a multidimensional subset of raster data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#multidimensionalSubset) */ multidimensionalSubset?: MultidimensionalSubsetProperties; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#popupEnabled) */ popupEnabled?: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * The client-side raster functions are operations that apply processing directly to the source image pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#rasterFunction) */ rasterFunction?: RasterFunctionProperties; /** * The data source for client-side ImageryTileLayer can be a [coverage JSON](https://www.ogc.org/standard/coveragejson/) object or [PixelData](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#PixelData). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#source) */ source?: any | PixelData; /** * The [tiled image service's metadata JSON](https://developers.arcgis.com/rest/services-reference/image-service.htm) exposed by the ArcGIS REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#sourceJSON) */ sourceJSON?: any; /** * The tiling scheme information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#tileInfo) */ tileInfo?: TileInfoProperties; /** * The layer's time extent. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#timeExtent) */ timeExtent?: TimeExtentProperties; /** * TimeInfo provides information such as date fields that store [start](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#startField) and [end](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#endField) time for each feature and the [fullTimeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#fullTimeExtent) for the layer. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#timeInfo) */ timeInfo?: TimeInfoProperties; /** * A temporary offset of the time data based on a certain [TimeInterval](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeInterval.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#timeOffset) */ timeOffset?: TimeIntervalProperties; /** * The URL of the REST endpoint of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#url) */ url?: string; /** * Determines if the layer will update its temporal data based on the view's [timeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#timeExtent). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#useViewTime) */ useViewTime?: boolean; } export interface ImageryTileLayerFetchTileOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#fetchTile) */ signal?: AbortSignal; } export interface ImageryTileLayerSaveAsOptions { /** * The portal folder where the layer's portal item will be saved. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#saveAs) */ folder?: PortalFolder; /** * Options for validating the save operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#saveAs) */ validationOptions?: ImageryTileLayerSaveAsOptionsValidationOptions; } export interface ImageryTileLayerSaveAsOptionsValidationOptions { /** * Indicates whether to ignore saving unsupported layers or layers with unsupported content, such as unsupported symbology. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#saveAs) */ ignoreUnsupported?: boolean; } export interface ImageryTileLayerSaveOptions { /** * Options for validating the save operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#save) */ validationOptions?: ImageryTileLayerSaveOptionsValidationOptions; } export interface ImageryTileLayerSaveOptionsValidationOptions { /** * Indicates whether to ignore saving unsupported layers or layers with unsupported content, such as unsupported symbology. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#save) */ ignoreUnsupported?: boolean; } /** * Additional options to set for `identify()` method on [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#identify) and [WCSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#identify). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#RasterIdentifyOptions) */ export interface RasterIdentifyOptions { /** * A dimensional definition used for the `identify` operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#RasterIdentifyOptions) */ multidimensionalDefinition?: DimensionalDefinition[]; /** * Name of the transposed variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#RasterIdentifyOptions) */ transposedVariableName?: string; /** * [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#RasterIdentifyOptions) */ signal?: AbortSignal; } /** * The result of `identify` operation on [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#identify) and [WCSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#identify). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#RasterIdentifyResult) */ export interface RasterIdentifyResult { /** * The identified location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#RasterIdentifyResult) */ location: Point; /** * Image service pixel values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#RasterIdentifyResult) */ value: number[]; /** * The processed pixel values showing results of the [rasterFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#rasterFunction) applied to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#RasterIdentifyResult) */ processedValue: number[]; /** * Transposed multidimensional data for the requested location and variable returned from a transposed multidimensional [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#identify). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#RasterIdentifyResult) */ dataSeries?: RasterSliceValue[]; } /** * Data series returned in [RasterIdentifyResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#RasterIdentifyResult) when [identify()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#identify) is called on a transposed multidimensional ImageryTileLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#RasterSliceValue) */ export interface RasterSliceValue { /** * Image service pixel values for a given slice. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#RasterSliceValue) */ value: number[]; /** * A dimensional definition associated with a given slice. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#RasterSliceValue) */ multidimensionalDefinition: DimensionalDefinition[]; /** * The magnitude and direction values for services containing vector data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#RasterSliceValue) */ magdirValue?: number[]; } export interface IntegratedMesh3DTilesLayer extends Layer, PortalLayer, CustomParametersMixin, APIKeyMixin, OperationalLayer { } export class IntegratedMesh3DTilesLayer { /** * Specifies how the mesh is placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMesh3DTilesLayer.html#elevationInfo) */ elevationInfo: IntegratedMesh3DTilesLayerElevationInfo; /** * The spatial reference of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMesh3DTilesLayer.html#spatialReference) */ spatialReference: SpatialReference; readonly type: "integrated-mesh-3dtiles"; /** * The URL of the root json file. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMesh3DTilesLayer.html#url) */ url: string; /** * The IntegratedMesh3DTilesLayer is designed for visualizing accurate representations of built and natural environments in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMesh3DTilesLayer.html) */ constructor(properties?: IntegratedMesh3DTilesLayerProperties); static fromJSON(json: any): IntegratedMesh3DTilesLayer; } interface IntegratedMesh3DTilesLayerProperties extends LayerProperties, PortalLayerProperties, CustomParametersMixinProperties, APIKeyMixinProperties, OperationalLayerProperties { /** * Specifies how the mesh is placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMesh3DTilesLayer.html#elevationInfo) */ elevationInfo?: IntegratedMesh3DTilesLayerElevationInfo; /** * The spatial reference of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMesh3DTilesLayer.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * The URL of the root json file. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMesh3DTilesLayer.html#url) */ url?: string; } export interface IntegratedMesh3DTilesLayerElevationInfo { /** * Defines how the mesh is placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMesh3DTilesLayer.html#elevationInfo) */ mode: "absolute-height"; /** * An elevation offset, which is added to the vertical position of the mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMesh3DTilesLayer.html#elevationInfo) */ offset?: number; /** * The unit for `offset` values. * * @default meters * * [Read more...](global.html#unit) */ unit?: "feet" | "meters" | "kilometers" | "miles" | "us-feet" | "yards"; } export interface IntegratedMeshLayer extends Layer, SceneService, PortalLayer, ScaleRangeLayer, CustomParametersMixin, APIKeyMixin, OperationalLayer { } export class IntegratedMeshLayer { /** * Specifies how the mesh is placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html#elevationInfo) */ elevationInfo: IntegratedMeshLayerElevationInfo; /** * A collection of [SceneModification](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SceneModification.html) with polygons and types to apply client-side modifications. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html#modifications) */ modifications: SceneModifications; readonly type: "integrated-mesh"; /** * The IntegratedMeshLayer is designed for visualizing accurate representations of built and natural environments in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html) */ constructor(properties?: IntegratedMeshLayerProperties); static fromJSON(json: any): IntegratedMeshLayer; } interface IntegratedMeshLayerProperties extends LayerProperties, SceneServiceProperties, PortalLayerProperties, ScaleRangeLayerProperties, CustomParametersMixinProperties, APIKeyMixinProperties, OperationalLayerProperties { /** * Specifies how the mesh is placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html#elevationInfo) */ elevationInfo?: IntegratedMeshLayerElevationInfo; /** * A collection of [SceneModification](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SceneModification.html) with polygons and types to apply client-side modifications. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html#modifications) */ modifications?: SceneModificationsProperties; } export interface IntegratedMeshLayerElevationInfo { /** * Defines how the mesh is placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html#elevationInfo) */ mode: "absolute-height"; /** * An elevation offset, which is added to the vertical position of the mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html#elevationInfo) */ offset?: number; /** * The unit for `offset` values. * * @default meters * * [Read more...](global.html#unit) */ unit?: "feet" | "meters" | "kilometers" | "miles" | "us-feet" | "yards"; } export interface KMLLayer extends Layer, OperationalLayer, PortalLayer, ScaleRangeLayer, BlendLayer { } export class KMLLayer { /** * A collection of [KMLSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html)s. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html#sublayers) */ sublayers: Collection; readonly type: "kml"; /** * The publicly accessible URL for a .kml or .kmz file. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html#url) */ url: string; /** * The KMLLayer class is used to create a layer based on a KML file (.kml, .kmz). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html) */ constructor(properties?: KMLLayerProperties); static fromJSON(json: any): KMLLayer; } interface KMLLayerProperties extends LayerProperties, OperationalLayerProperties, PortalLayerProperties, ScaleRangeLayerProperties, BlendLayerProperties { /** * A collection of [KMLSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html)s. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html#sublayers) */ sublayers?: CollectionProperties; /** * The publicly accessible URL for a .kml or .kmz file. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html#url) */ url?: string; } export interface KnowledgeGraphSublayer extends Layer, BlendLayer, FeatureReductionLayer { } export class KnowledgeGraphSublayer { /** * Describes the layer's supported capabilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#capabilities) */ readonly capabilities: KnowledgeGraphSublayerCapabilities; /** * The definition of the default popup template for the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#defaultPopupTemplate) */ readonly defaultPopupTemplate: PopupTemplate; /** * The SQL where clause used to filter features on the client. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#definitionExpression) */ definitionExpression: string; /** * The name of the sublayer's primary display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#displayField) */ displayField: string; /** * Specifies how features are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#elevationInfo) */ elevationInfo: KnowledgeGraphSublayerElevationInfo; /** * The name of the geometry field for the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#geometryFieldName) */ geometryFieldName: string; /** * The geometry type of features in the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#geometryType) */ geometryType: "point" | "multipoint" | "polyline" | "polygon"; /** * Specifies whether the sublayer represents an [entity type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) or [relationship type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#graphType) */ graphType: "entity" | "relationship"; /** * Indicates whether the features in the sublayer have `M` (measurement) values. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#hasM) */ hasM: boolean; /** * Indicates whether the features in the layer have `Z` (elevation) values. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#hasZ) */ hasZ: boolean; /** * The label definition for this sublayer, specified as an array of [label classes](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#labelingInfo) */ labelingInfo: LabelClass[]; /** * Indicates whether to display labels for this sublayer. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#labelsVisible) */ labelsVisible: boolean; /** * The name of an `oid` containing a unique value or identifier for each feature in the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#objectIdField) */ objectIdField: string; /** * Outlines the [type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphObjectType.html) definition for the named type represented by the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#objectType) */ objectType: GraphObjectType; /** * The [KnowledgeGraphLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html) of which this is a sublayer for a specific entity or relationship type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#parentCompositeLayer) */ parentCompositeLayer: KnowledgeGraphLayer; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#popupEnabled) */ popupEnabled: boolean; /** * The popup template for the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * The renderer assigned to the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#renderer) */ renderer: Renderer; readonly type: "knowledge-graph-sublayer"; /** * A KnowledgeGraphSublayer is a sublayer of a [KnowledgeGraphLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#layers) that contains all instances of a named type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html) */ constructor(properties?: KnowledgeGraphSublayerProperties); /** * Creates a popup template for the layer, populated with all the fields of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#createPopupTemplate) */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate; /** * Creates query parameter object that can be used to fetch features that satisfy the layer's configurations such as [definitionExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#definitionExpression),. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#createQuery) */ createQuery(): Query; /** * Returns the [Field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) instance for a field name (case-insensitive). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#getField) */ getField(fieldName: string): Field; /** * Returns the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) associated with the given field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#getFieldDomain) */ getFieldDomain(fieldName: string, options?: KnowledgeGraphSublayerGetFieldDomainOptions): Domain; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the knowledge graph service and returns the [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#queryExtent) */ queryExtent(query?: Query | QueryProperties, options?: KnowledgeGraphSublayerQueryExtentOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the [knowledge graph service](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html) and returns the number of features that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#queryFeatureCount) */ queryFeatureCount(query?: Query | QueryProperties, options?: KnowledgeGraphSublayerQueryFeatureCountOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the feature service and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html), which can be accessed using the `.then()` method once the promise resolves. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#queryFeatures) */ queryFeatures(query?: Query | QueryProperties, options?: KnowledgeGraphSublayerQueryFeaturesOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the knowledge graph service and returns an array of Object IDs for features that satisfy the input query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#queryObjectIds) */ queryObjectIds(query?: Query | QueryProperties, options?: KnowledgeGraphSublayerQueryObjectIdsOptions): Promise; } interface KnowledgeGraphSublayerProperties extends LayerProperties, BlendLayerProperties, FeatureReductionLayerProperties { /** * The SQL where clause used to filter features on the client. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#definitionExpression) */ definitionExpression?: string; /** * The name of the sublayer's primary display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#displayField) */ displayField?: string; /** * Specifies how features are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#elevationInfo) */ elevationInfo?: KnowledgeGraphSublayerElevationInfo; /** * The name of the geometry field for the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#geometryFieldName) */ geometryFieldName?: string; /** * The geometry type of features in the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#geometryType) */ geometryType?: "point" | "multipoint" | "polyline" | "polygon"; /** * Specifies whether the sublayer represents an [entity type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) or [relationship type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#graphType) */ graphType?: "entity" | "relationship"; /** * Indicates whether the features in the sublayer have `M` (measurement) values. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#hasM) */ hasM?: boolean; /** * Indicates whether the features in the layer have `Z` (elevation) values. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#hasZ) */ hasZ?: boolean; /** * The label definition for this sublayer, specified as an array of [label classes](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#labelingInfo) */ labelingInfo?: LabelClassProperties[]; /** * Indicates whether to display labels for this sublayer. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#labelsVisible) */ labelsVisible?: boolean; /** * The name of an `oid` containing a unique value or identifier for each feature in the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#objectIdField) */ objectIdField?: string; /** * Outlines the [type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphObjectType.html) definition for the named type represented by the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#objectType) */ objectType?: GraphObjectTypeProperties; /** * The [KnowledgeGraphLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html) of which this is a sublayer for a specific entity or relationship type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#parentCompositeLayer) */ parentCompositeLayer?: KnowledgeGraphLayerProperties; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#popupEnabled) */ popupEnabled?: boolean; /** * The popup template for the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * The renderer assigned to the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#renderer) */ renderer?: RendererProperties; } /** * Describes the layer's supported capabilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ export interface KnowledgeGraphSublayerCapabilities { /** * Describes what analytics capabilities are enabled on the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ analytics: KnowledgeGraphSublayerCapabilitiesAnalytics; /** * Describes what attachment capabilities are enabled on the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ attachment: KnowledgeGraphSublayerCapabilitiesAttachment; /** * Describes characteristics of the data in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ data: KnowledgeGraphSublayerCapabilitiesData; /** * Describes editing capabilities that can be performed on the features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ editing: KnowledgeGraphSublayerCapabilitiesEditing; /** * Describes the metadata contained on features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ metadata: KnowledgeGraphSublayerCapabilitiesMetadata; /** * Describes operations that can be performed on features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ operations: KnowledgeGraphSublayerCapabilitiesOperations; /** * Describes [query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) operations that can be performed on features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ query: KnowledgeGraphSublayerCapabilitiesQuery; /** * Indicates if the layer's query operation supports querying features or records related to features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ queryRelated: KnowledgeGraphSublayerCapabilitiesQueryRelated; /** * Describes [top features query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html) operations that can be performed on features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ queryTopFeatures: KnowledgeGraphSublayerCapabilitiesQueryTopFeatures; } export interface KnowledgeGraphSublayerElevationInfo { /** * Defines how the feature is placed with respect to the terrain surface or 3D objects in the scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#elevationInfo) */ mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; /** * An elevation offset, which is added to the vertical position of the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#elevationInfo) */ offset?: number; /** * Defines how to override a feature's Z-value based on its attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#elevationInfo) */ featureExpressionInfo?: KnowledgeGraphSublayerElevationInfoFeatureExpressionInfo; /** * The unit for `featureExpressionInfo` and `offset` values. * * [Read more...](global.html#unit) */ unit?: "feet" | "meters" | "kilometers" | "miles" | "us-feet" | "yards"; } export interface KnowledgeGraphSublayerElevationInfoFeatureExpressionInfo { /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Feature Z Profile](https://developers.arcgis.com/javascript/latest/arcade/#z-values). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#elevationInfo) */ expression?: string; } export interface KnowledgeGraphSublayerGetFieldDomainOptions { /** * The feature to which the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) is assigned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#getFieldDomain) */ feature: Graphic; } export interface KnowledgeGraphSublayerQueryExtentOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#queryExtent) */ signal?: AbortSignal; } export interface KnowledgeGraphSublayerQueryFeatureCountOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#queryFeatureCount) */ signal?: AbortSignal; } export interface KnowledgeGraphSublayerQueryFeaturesOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#queryFeatures) */ signal?: AbortSignal; } export interface KnowledgeGraphSublayerQueryObjectIdsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#queryObjectIds) */ signal?: AbortSignal; } export interface KnowledgeGraphSublayerCapabilitiesAnalytics { /** * Indicates if the feature service supports cache hint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsCacheHint: boolean; } export interface KnowledgeGraphSublayerCapabilitiesAttachment { /** * Indicates if the [attachment operations](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html) support a cache hint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsCacheHint: boolean; /** * Indicates if the attachments can be [queried](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html) by their content types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsContentType: boolean; /** * Indicates if the attachment [queries](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html) support `exifInfo`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsExifInfo: boolean; /** * Indicates if the attachments can be [queried](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html) by their keywords. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsKeywords: boolean; /** * Indicates if the attachments can be [queried](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html) by their names. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsName: boolean; /** * Indicates if the attachments can be [queried](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html) by their sizes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsSize: boolean; /** * Indicates if resized attachments are supported in the feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsResize: boolean; } export interface KnowledgeGraphSublayerCapabilitiesData { /** * Indicates if the feature service is versioned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ isVersioned: boolean; /** * Indicates if the attachment is enabled on the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsAttachment: boolean; /** * Indicates if the features in the layer support m-values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsM: boolean; /** * Indicates if the features in the layer support z-values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsZ: boolean; } export interface KnowledgeGraphSublayerCapabilitiesEditing { /** * Indicates if anonymous users can delete features created by others. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsDeleteByAnonymous: boolean; /** * Indicates if logged in users can delete features created by others. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsDeleteByOthers: boolean; /** * Indicates if the geometry of the features in the layer can be edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsGeometryUpdate: boolean; /** * Indicates if the `globalId` values provided by the client are used in editing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsGlobalId: boolean; /** * Indicates if the `rollbackOnFailureEnabled` parameter can be set to `true` or `false` when editing features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsRollbackOnFailure: boolean; /** * Indicates if anonymous users can update features created by others. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsUpdateByAnonymous: boolean; /** * Indicates if logged in users can update features created by others. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsUpdateByOthers: boolean; /** * Indicates if the layer supports uploading attachments by [UploadId](https://developers.arcgis.com/rest/services-reference/item.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsUploadWithItemId: boolean; /** * Indicates if `m-values` must be provided when updating features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsUpdateWithoutM: boolean; } export interface KnowledgeGraphSublayerCapabilitiesMetadata { /** * Indicates whether to provide a user-defined field description. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsAdvancedFieldProperties: boolean; } export interface KnowledgeGraphSublayerCapabilitiesOperations { /** * Indicates if new features can be added to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsAdd: boolean; /** * Indicates if values of one or more field values in the layer can be updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsCalculate: boolean; /** * Indicates if features can be deleted from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsDelete: boolean; /** * Indicates if features in the layer can be edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsEditing: boolean; /** * Indicates if features in the layer can be [queried](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#queryFeatures). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsQuery: boolean; /** * Indicates if the layer supports [REST API queryAttachments](https://developers.arcgis.com/rest/services-reference/query-attachments-feature-service-layer-.htm) operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsQueryAttachments: boolean; /** * Deprecated since 4.24. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsResizeAttachments: boolean; /** * Indicates if the layer supports [REST API queryTopFeatures](https://developers.arcgis.com/rest/services-reference/enterprise/query-top-features-feature-service-layer-.htm) operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsQueryTopFeatures: boolean; /** * Indicates if features in the layer can be updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsUpdate: boolean; /** * Indicates if the layer supports a SQL-92 expression or where clause. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsValidateSql: boolean; } export interface KnowledgeGraphSublayerCapabilitiesQuery { /** * The maximum number of records that will be returned for a given query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ maxRecordCount: number; /** * Indicates if the query operation supports a [cache hint](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#cacheHint). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsCacheHint: boolean; /** * Indicates if the geometry centroid associated with each polygon feature can be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsCentroid: boolean; /** * Indicates if the query operation supports `disjoint` [spatial relationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#spatialRelationship). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsDisjointSpatialRelationship: boolean; /** * Indicates if the layer's query operation supports a buffer distance for input geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsDistance: boolean; /** * Indicates if the layer supports queries for distinct values based on fields specified in the [outFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#outFields). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsDistinct: boolean; /** * Indicates if the layer's query response includes the extent of features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsExtent: boolean; /** * Indicates if the layer's query response contains geometry attributes, including shape area and length attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsGeometryProperties: boolean; /** * Indicates if the layer supports the [having](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#having) clause on the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsHavingClause: boolean; /** * Indicates if the layer supports historic moment query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsHistoricMoment: boolean; /** * Indicates if features returned in the query response can be ordered by one or more fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsOrderBy: boolean; /** * Indicates if the query response supports pagination. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsPagination: boolean; /** * Indicates if the layer supports [percentile statisticType](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-StatisticDefinition.html#statisticType). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsPercentileStatistics: boolean; /** * Indicates if the query operation supports the projection of geometries onto a virtual grid. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsQuantization: boolean; /** * Indicates if the query operation supports quantization designed to be used in edit mode (highest resolution at the given spatial reference). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsQuantizationEditMode: boolean; /** * Indicates if the query response includes the [query geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html#queryGeometry). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsQueryGeometry: boolean; /** * Indicates if the number of features returned by the query operation can be controlled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsResultType: boolean; /** * Indicates if the layer supports using standardized queries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsStandardizedQueriesOnly: boolean; /** * Indicates if the layer supports field-based statistical functions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsStatistics: boolean; /** * Indicates if the layer supports SQL expressions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsSqlExpression: boolean; /** * Indicates if the layer supports spatial extent, center or convex hull to be returned for each distinct group when [groupByFieldsForStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#groupByFieldsForStatistics) is used. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsSpatialAggregationStatistics: boolean; /** * List of supported aggregated geometries returned for each distinct group when [groupByFieldsForStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#groupByFieldsForStatistics) is used. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportedSpatialStatisticAggregations: KnowledgeGraphSublayerCapabilitiesQuerySupportedSpatialStatisticAggregations; } export interface KnowledgeGraphSublayerCapabilitiesQueryRelated { /** * Indicates if the [relationship query operation](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html) supports a cache hint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsCacheHint: boolean; /** * Indicates if the layer's query response includes the number of features or records related to features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsCount: boolean; /** * Indicates if the related features or records returned in the query response can be ordered by one or more fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsOrderBy: boolean; /** * Indicates if the query response supports pagination for related features or records. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsPagination: boolean; } export interface KnowledgeGraphSublayerCapabilitiesQuerySupportedSpatialStatisticAggregations { /** * Indicates if the layer can return centroid for each distinct group for [groupByFieldsForStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#groupByFieldsForStatistics). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ centroid: boolean; /** * Indicates if the layer can return extent for each distinct group for [groupByFieldsForStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#groupByFieldsForStatistics). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ envelope: boolean; /** * Indicates if the layer can return convex hull for each distinct group for [groupByFieldsForStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#groupByFieldsForStatistics). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ convexHull: boolean; } export interface KnowledgeGraphSublayerCapabilitiesQueryTopFeatures { /** * Indicates if the [top query operation](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html) supports a cache hint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#Capabilities) */ supportsCacheHint: boolean; } export class KnowledgeGraphLayer extends Layer { /** * Defines a set of [named types](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphNamedObject.html) and/or [entities](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html) and [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html) to be included in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#inclusionModeDefinition) */ inclusionModeDefinition: InclusionModeDefinition; /** * The [data model](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-DataModel.html), [service definition](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html) and [url](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#url) of the [knowledge graph service](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html) that contains the data for the KnowledgeGraphLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#knowledgeGraph) */ readonly knowledgeGraph: KnowledgeGraph; /** * A collection of operational [KnowledgeGraphSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#layers) */ readonly layers: Collection; /** * The [entity types](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) included in the KnowledgeGraphLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#memberEntityTypes) */ readonly memberEntityTypes: EntityType[]; /** * The [relationship types](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html) included in the KnowledgeGraphLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#memberRelationshipTypes) */ readonly memberRelationshipTypes: RelationshipType[]; /** * Contains the sublayer ids that have been cached. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#sublayerIdsCache) */ readonly sublayerIdsCache: globalThis.Map>; /** * All non-spatial [entity type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) and [relationship type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html) sublayers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#tables) */ readonly tables: Collection; /** * The layer type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#type) */ readonly type: "knowledge-graph"; /** * The url of the [knowledge graph service](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#url) */ url: string; /** * A KnowledgeGraphLayer is a composite layer that can be created from a [knowledge graph service](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html) */ constructor(properties?: KnowledgeGraphLayerProperties); /** * Adds new entities or relationships to the knowledge graph layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#addRecords) */ addRecords(records: IdTypePair[]): Promise; /** * Assumes that data for all of the members defined in the inclusionModeDefinition is already loaded into local storage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#loadLayerAssumingLocalCache) */ loadLayerAssumingLocalCache(): void; /** * Removes entities or relationships from the knowledge graph layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#removeRecords) */ removeRecords(records: IdTypePair[]): Promise; } interface KnowledgeGraphLayerProperties extends LayerProperties { /** * Defines a set of [named types](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphNamedObject.html) and/or [entities](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html) and [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html) to be included in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#inclusionModeDefinition) */ inclusionModeDefinition?: InclusionModeDefinition; /** * The url of the [knowledge graph service](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#url) */ url?: string; } /** * The id and named type of a record to be added or removed from the knowledge graph. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#IdTypePair) */ export interface IdTypePair { /** * The global ID of the record to be added to or removed from the the knowledge graph layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#IdTypePair) */ id: string; /** * the named type of the record to be added or removed from the knowledge graph layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#IdTypePair) */ typeName: string; } /** * Defines the sublayer structure and the named types that will be in the KnowledgeGraphLayer * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#InclusionModeDefinition) */ export interface InclusionModeDefinition { /** * Specifies whether to create sublayers for each [named type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphNamedObject.html) regardless of whether or not they are included in the `namedTypeDefinition`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#InclusionModeDefinition) */ generateAllSublayers: boolean; /** * A map of named types and the specific instances of those types to include in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#InclusionModeDefinition) */ namedTypeDefinitions: globalThis.Map; } /** * Defines the contents of each specified named type in the [`inclusionModeDefinition`](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#inclusionModeDefinition) and whether all instance of the named type will be used or a specified subset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#LayerInclusionDefinition) */ export interface LayerInclusionDefinition { /** * If `true` all of the instances of the named type will be included regardless of if there is a defined list of members. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#LayerInclusionDefinition) */ useAllData: boolean; /** * A map of the specific members of the named type to be included. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#LayerInclusionDefinition) */ members: globalThis.Map; } /** * Defines the list of `members` for a named type in the [`inclusionModeDefinition`](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#inclusionModeDefinition). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#LayerInclusionMemberDefinition) */ export interface LayerInclusionMemberDefinition { /** * The global ID of the specific instance of the named type to be included in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html#LayerInclusionMemberDefinition) */ id: string; } export interface Layer extends Accessor, Loadable, Evented, Identifiable { } export class Layer { /** * The full extent of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#fullExtent) */ fullExtent: Extent; /** * The unique ID assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#id) */ id: string; /** * Indicates how the layer should display in the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widget. * * @default "show" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#listMode) */ listMode: "show" | "hide" | "hide-children"; /** * Indicates whether the layer's resources have loaded. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#loaded) */ readonly loaded: boolean; /** * The opacity of the layer. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#opacity) */ opacity: number; /** * The parent to which the layer belongs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#parent) */ parent: Map | Basemap | Ground | GroupLayer; /** * When `true`, the layer can be persisted. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#persistenceEnabled) */ persistenceEnabled: boolean; /** * The title of the layer used to identify it in places such as the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#title) */ title: string; /** * The layer type provides a convenient way to check the type of the layer without the need to import specific layer modules. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#type) */ readonly type: | "base-dynamic" | "base-elevation" | "base-tile" | "bing-maps" | "building-scene" | "csv" | "dimension" | "elevation" | "feature" | "geojson" | "geo-rss" | "graphics" | "group" | "imagery" | "imagery-tile" | "integrated-mesh" | "integrated-mesh-3dtiles" | "kml" | "line-of-sight" | "map-image" | "map-notes" | "media" | "ogc-feature" | "open-street-map" | "oriented-imagery" | "point-cloud" | "route" | "scene" | "georeferenced-image" | "stream" | "tile" | "unknown" | "unsupported" | "vector-tile" | "wcs" | "web-tile" | "wfs" | "wms" | "wmts" | "voxel" | "subtype-group" | "knowledge-graph" | "knowledge-graph-sublayer"; /** * Indicates if the layer is visible in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#visible) */ visible: boolean; /** * The layer is the most fundamental component of a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) */ constructor(properties?: LayerProperties); /** * Called by the views, such as [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) and [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html), when the layer is added to the [Map.layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) collection and a layer view must be created for it. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#createLayerView) */ createLayerView(view: any, options?: LayerCreateLayerViewOptions): Promise; /** * Destroys the layer and any associated resources (including its [portalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#portalItem), if it is a property on the layer). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#destroy) */ destroy(): void; /** * Fetches custom attribution data for the layer when it becomes available. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#fetchAttributionData) */ fetchAttributionData(): Promise; on(name: "layerview-create", eventHandler: LayerLayerviewCreateEventHandler): IHandle; on(name: "layerview-create-error", eventHandler: LayerLayerviewCreateErrorEventHandler): IHandle; on(name: "layerview-destroy", eventHandler: LayerLayerviewDestroyEventHandler): IHandle; /** * Creates a new layer instance from an ArcGIS Server URL. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#fromArcGISServerUrl) */ static fromArcGISServerUrl(params: LayerFromArcGISServerUrlParams): Promise; /** * Creates a new layer instance of the appropriate layer class from an ArcGIS Online or ArcGIS Enterprise [portal item](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#fromPortalItem) */ static fromPortalItem(params: LayerFromPortalItemParams): Promise; } interface LayerProperties extends LoadableProperties { /** * The full extent of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#fullExtent) */ fullExtent?: ExtentProperties; /** * The unique ID assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#id) */ id?: string; /** * Indicates how the layer should display in the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widget. * * @default "show" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#listMode) */ listMode?: "show" | "hide" | "hide-children"; /** * The opacity of the layer. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#opacity) */ opacity?: number; /** * The parent to which the layer belongs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#parent) */ parent?: MapProperties | BasemapProperties | GroundProperties | (GroupLayerProperties & { type: "group" }); /** * When `true`, the layer can be persisted. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#persistenceEnabled) */ persistenceEnabled?: boolean; /** * The title of the layer used to identify it in places such as the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#title) */ title?: string; /** * Indicates if the layer is visible in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#visible) */ visible?: boolean; } export interface LayerCreateLayerViewOptions { /** * A signal to abort the creation of the layerview. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#createLayerView) */ signal?: AbortSignal; } export interface LayerFromArcGISServerUrlParams { /** * The ArcGIS Server URL used to create the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#fromArcGISServerUrl) */ url: string; /** * Set any of the layer's properties here for constructing the layer instance (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#fromArcGISServerUrl) */ properties?: any; } export interface LayerFromPortalItemParams { /** * The object representing an ArcGIS Online or ArcGIS Enterprise portal item from which to load the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#fromPortalItem) */ portalItem: PortalItem; } export interface LayerLayerviewCreateErrorEvent { error: Error; view: View; } export interface LayerLayerviewCreateEvent { layerView: LayerView; view: View; } export interface LayerLayerviewDestroyEvent { layerView: LayerView; view: View; } export interface LineOfSightLayer extends Layer, OperationalLayer { } export class LineOfSightLayer { /** * The [LineOfSightAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html) associated with the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-LineOfSightLayer.html#analysis) */ analysis: LineOfSightAnalysis; /** * The observer defines the point from which the line of sight analysis is performed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-LineOfSightLayer.html#observer) */ observer: LineOfSightAnalysisObserver; /** * The spatial reference of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-LineOfSightLayer.html#spatialReference) */ readonly spatialReference: SpatialReference; /** * Target locations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-LineOfSightLayer.html#targets) */ targets: Collection; readonly type: "line-of-sight"; /** * LineOfSightLayer computes the line of sight from a single observer position towards a set of targets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-LineOfSightLayer.html) */ constructor(properties?: LineOfSightLayerProperties); static fromJSON(json: any): LineOfSightLayer; } interface LineOfSightLayerProperties extends LayerProperties, OperationalLayerProperties { /** * The [LineOfSightAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html) associated with the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-LineOfSightLayer.html#analysis) */ analysis?: LineOfSightAnalysisProperties; /** * The observer defines the point from which the line of sight analysis is performed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-LineOfSightLayer.html#observer) */ observer?: LineOfSightAnalysisObserverProperties; /** * Target locations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-LineOfSightLayer.html#targets) */ targets?: CollectionProperties; } export interface MapImageLayer extends Layer, SublayersOwner, ArcGISMapService, ScaleRangeLayer, RefreshableLayer, TemporalLayer, BlendLayer, CustomParametersMixin, OperationalLayer { } export class MapImageLayer { /** * A flat [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of all the [sublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#sublayers) in the MapImageLayer including the sublayers of its sublayers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#allSublayers) */ readonly allSublayers: Collection; /** * The time zone that dates are stored in. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#dateFieldsTimeZone) */ readonly dateFieldsTimeZone: string; /** * This property is set by the service publisher and indicates that dates should be considered without the local timezone. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#datesInUnknownTimezone) */ readonly datesInUnknownTimezone: boolean; /** * The output dots per inch (DPI) of the MapImageLayer. * * @default 96 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#dpi) */ dpi: number; /** * The version of the geodatabase of the map service data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#gdbVersion) */ gdbVersion: string; /** * The output image type. * * @default png24 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#imageFormat) */ imageFormat: "png" | "png8" | "png24" | "png32" | "jpg" | "pdf" | "bmp" | "gif" | "svg" | "pngjpg"; /** * Indicates the maximum height of the image exported by the service. * * @default 2048 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#imageMaxHeight) */ imageMaxHeight: number; /** * Indicates the maximum width of the image exported by the service. * * @default 2048 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#imageMaxWidth) */ imageMaxWidth: number; /** * Indicates whether the background of the image exported by the service is transparent. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#imageTransparency) */ imageTransparency: boolean; /** * The portal item from which the layer is loaded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#portalItem) */ portalItem: PortalItem; /** * The IANA time zone the author of the service intended data from date fields to be viewed in. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#preferredTimeZone) */ readonly preferredTimeZone: string; /** * The [map service's metadata JSON](https://developers.arcgis.com/rest/services-reference/map-service.htm) exposed by the ArcGIS REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#sourceJSON) */ sourceJSON: any; /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [Sublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html) objects that allow you to alter the properties of one or more sublayers of the MapImageLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#sublayers) */ sublayers: Collection; readonly type: "map-image"; /** * The URL to the REST endpoint of the map service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#url) */ url: string; /** * MapImageLayer allows you to display and analyze data from [sublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#sublayers) defined in a [map service](https://enterprise.arcgis.com/en/server/latest/publish-services/windows/what-is-a-map-service.htm), exporting images instead of features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html) */ constructor(properties?: MapImageLayerProperties); /** * Gets the parameters of the exported image to use when calling the [export REST operation](https://developers.arcgis.com/rest/services-reference/export-map.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#createExportImageParameters) */ createExportImageParameters(extent: Extent, width: number, height: number, options?: MapImageLayerCreateExportImageParametersOptions): any; /** * This method fetches the image for the specified extent and size. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#fetchImage) */ fetchImage(extent: Extent, width: number, height: number, options?: MapImageLayerFetchImageOptions): Promise; /** * Loads all of the sublayers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#loadAll) */ loadAll(): Promise; on(name: "refresh", eventHandler: MapImageLayerRefreshEventHandler): IHandle; on(name: "layerview-create", eventHandler: MapImageLayerLayerviewCreateEventHandler): IHandle; on(name: "layerview-create-error", eventHandler: MapImageLayerLayerviewCreateErrorEventHandler): IHandle; on(name: "layerview-destroy", eventHandler: MapImageLayerLayerviewDestroyEventHandler): IHandle; static fromJSON(json: any): MapImageLayer; } interface MapImageLayerProperties extends LayerProperties, ArcGISMapServiceProperties, ScaleRangeLayerProperties, RefreshableLayerProperties, TemporalLayerProperties, BlendLayerProperties, CustomParametersMixinProperties, OperationalLayerProperties { /** * The output dots per inch (DPI) of the MapImageLayer. * * @default 96 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#dpi) */ dpi?: number; /** * The version of the geodatabase of the map service data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#gdbVersion) */ gdbVersion?: string; /** * The output image type. * * @default png24 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#imageFormat) */ imageFormat?: "png" | "png8" | "png24" | "png32" | "jpg" | "pdf" | "bmp" | "gif" | "svg" | "pngjpg"; /** * Indicates the maximum height of the image exported by the service. * * @default 2048 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#imageMaxHeight) */ imageMaxHeight?: number; /** * Indicates the maximum width of the image exported by the service. * * @default 2048 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#imageMaxWidth) */ imageMaxWidth?: number; /** * Indicates whether the background of the image exported by the service is transparent. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#imageTransparency) */ imageTransparency?: boolean; /** * The portal item from which the layer is loaded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#portalItem) */ portalItem?: PortalItemProperties; /** * The [map service's metadata JSON](https://developers.arcgis.com/rest/services-reference/map-service.htm) exposed by the ArcGIS REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#sourceJSON) */ sourceJSON?: any; /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [Sublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html) objects that allow you to alter the properties of one or more sublayers of the MapImageLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#sublayers) */ sublayers?: CollectionProperties; /** * The URL to the REST endpoint of the map service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#url) */ url?: string; } export interface MapImageLayerLayerviewCreateErrorEvent { error: Error; view: View; } export interface MapImageLayerLayerviewCreateEvent { layerView: LayerView; view: View; } export interface MapImageLayerLayerviewDestroyEvent { layerView: LayerView; view: View; } export interface MapImageLayerCreateExportImageParametersOptions { /** * The rotation in degrees of the exported image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#createExportImageParameters) */ rotation?: number; /** * The pixel ratio to apply to the dpi of the exported image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#createExportImageParameters) */ pixelRatio?: number; /** * The time instant or time extent of content to render. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#createExportImageParameters) */ timeExtent?: any; } export interface MapImageLayerFetchImageOptions { /** * The rotation in degrees of the exported image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#fetchImage) */ rotation?: number; /** * The ratio of the resolution in physical pixels of the image to the resolution it will be displayed at. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#fetchImage) */ pixelRatio?: number; /** * The time instant or time extent of content to render. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#fetchImage) */ timeExtent?: any; /** * An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to abort the request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#fetchImage) */ signal?: AbortSignal; } export interface MapImageLayerRefreshEvent { dataChanged: boolean; } export interface MapNotesLayer extends Layer, OperationalLayer, PortalLayer, ScaleRangeLayer, BlendLayer { } export class MapNotesLayer { /** * Describes the layer's supported capabilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapNotesLayer.html#capabilities) */ readonly capabilities: MapNotesLayerCapabilities; /** * A layer containing a collection of graphics with multipoint geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapNotesLayer.html#multipointLayer) */ readonly multipointLayer: GraphicsLayer; /** * A layer containing a collection of graphics with point geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapNotesLayer.html#pointLayer) */ readonly pointLayer: GraphicsLayer; /** * A layer containing a collection of graphics with polygon geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapNotesLayer.html#polygonLayer) */ readonly polygonLayer: GraphicsLayer; /** * A layer containing a collection of graphics with polyline geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapNotesLayer.html#polylineLayer) */ readonly polylineLayer: GraphicsLayer; /** * A layer containing a collection of text graphics with point geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapNotesLayer.html#textLayer) */ readonly textLayer: GraphicsLayer; readonly type: "map-notes"; /** * The MapNotesLayer lets you display and modify map notes (features sketched on a web map) from the [Map Viewer](https://www.arcgis.com/apps/mapviewer/index.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapNotesLayer.html) */ constructor(properties?: MapNotesLayerProperties); static fromJSON(json: any): MapNotesLayer; } interface MapNotesLayerProperties extends LayerProperties, OperationalLayerProperties, PortalLayerProperties, ScaleRangeLayerProperties, BlendLayerProperties { } export interface MapNotesLayerCapabilities { /** * Describes operations that can be performed on map notes in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapNotesLayer.html#capabilities) */ operations: MapNotesLayerCapabilitiesOperations; } export interface MapNotesLayerCapabilitiesOperations { /** * Indicates if map notes in the layer can be edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapNotesLayer.html#capabilities) */ supportsMapNotesEditing: boolean; } export interface MediaLayer extends Layer, ScaleRangeLayer, BlendLayer, OperationalLayer { } export class MediaLayer { /** * Copyright information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#copyright) */ copyright: string; /** * The source for the MediaLayer that will be displayed on the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#source) */ source: ImageElement | VideoElement | LocalMediaElementSource; /** * The spatial reference of the layer and defines the spatial reference of the layer's [fullExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#fullExtent). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#spatialReference) */ spatialReference: SpatialReference; readonly type: "media"; /** * The MediaLayer class is used to add [image](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html) and [video](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VideoElement.html) elements to the map at a specified geographic [location](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html#georeference). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html) */ constructor(properties?: MediaLayerProperties); /** * Saves the layer to its existing portal item in the [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html) authenticated within the user's current session. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#save) */ save(options?: MediaLayerSaveOptions): Promise; /** * Saves the layer to a new portal item in the [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html) authenticated within the user's current session. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#saveAs) */ saveAs(portalItem: PortalItem | PortalItemProperties, options?: MediaLayerSaveAsOptions): Promise; static fromJSON(json: any): MediaLayer; } interface MediaLayerProperties extends LayerProperties, ScaleRangeLayerProperties, BlendLayerProperties, OperationalLayerProperties { /** * Copyright information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#copyright) */ copyright?: string; /** * The source for the MediaLayer that will be displayed on the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#source) */ source?: | (ImageElementProperties & { type: "image" }) | (VideoElementProperties & { type: "video" }) | LocalMediaElementSourceProperties | CollectionProperties< (ImageElementProperties & { type: "image" }) | (VideoElementProperties & { type: "video" }) > | ((ImageElementProperties & { type: "image" }) | (VideoElementProperties & { type: "video" }))[]; /** * The spatial reference of the layer and defines the spatial reference of the layer's [fullExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#fullExtent). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; } export interface MediaLayerSaveAsOptions { /** * The portal folder where the layer's portal item will be saved. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#saveAs) */ folder?: PortalFolder; /** * Options for validating the save operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#saveAs) */ validationOptions?: MediaLayerSaveAsOptionsValidationOptions; } export interface MediaLayerSaveAsOptionsValidationOptions { /** * Indicates whether to ignore saving unsupported layers or layers with unsupported content, such as unsupported symbology. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#saveAs) */ ignoreUnsupported?: boolean; } export interface MediaLayerSaveOptions { /** * Options for validating the save operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#save) */ validationOptions?: MediaLayerSaveOptionsValidationOptions; } export interface MediaLayerSaveOptionsValidationOptions { /** * Indicates whether to ignore saving unsupported layers or layers with unsupported content, such as unsupported symbology. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#save) */ ignoreUnsupported?: boolean; } export class APIKeyMixin { /** * An authorization string used to access a resource or service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-APIKeyMixin.html#apiKey) */ apiKey: string; } interface APIKeyMixinProperties { /** * An authorization string used to access a resource or service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-APIKeyMixin.html#apiKey) */ apiKey?: string; } export class ArcGISCachedService { /** * The copyright text as defined by the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISCachedService.html#copyright) */ copyright: string; /** * The spatial reference of the layer as defined by the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISCachedService.html#spatialReference) */ readonly spatialReference: SpatialReference; /** * Contains information about the tiling scheme for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISCachedService.html#tileInfo) */ tileInfo: TileInfo; constructor(properties?: ArcGISCachedServiceProperties); static fromJSON(json: any): ArcGISCachedService; } interface ArcGISCachedServiceProperties { /** * The copyright text as defined by the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISCachedService.html#copyright) */ copyright?: string; /** * Contains information about the tiling scheme for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISCachedService.html#tileInfo) */ tileInfo?: TileInfoProperties; } export class ArcGISImageService { /** * Defines a band combination using 0-based band indexes. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#bandIds) */ bandIds: number[]; /** * Describes the layer's supported capabilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ capabilities: ArcGISImageServiceCapabilities; /** * The compression quality value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#compressionQuality) */ compressionQuality: number; /** * Controls the tolerance of the lerc compression algorithm. * * @default 0.01 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#compressionTolerance) */ compressionTolerance: number; /** * The copyright text as defined by the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#copyright) */ copyright: string; /** * Default mosaic rule of the image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#defaultMosaicRule) */ readonly defaultMosaicRule: MosaicRule; /** * The SQL where clause used to filter rasters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#definitionExpression) */ definitionExpression: string; /** * An array of fields in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#fields) */ fields: Field[]; /** * A convenient property that can be used to make case-insensitive lookups for a [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#fields) by name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#fieldsIndex) */ readonly fieldsIndex: FieldsIndex; /** * The format of the exported image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#format) */ format: "png" | "png8" | "png24" | "png32" | "jpg" | "bmp" | "gif" | "jpgpng" | "lerc" | "tiff"; /** * Indicates if the layer has [multidimensionalInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#multidimensionalInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#hasMultidimensions) */ hasMultidimensions: boolean; /** * Indicates the maximum height of the image exported by the service. * * @default 4100 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#imageMaxHeight) */ imageMaxHeight: number; /** * Indicates the maximum width of the image exported by the service. * * @default 15000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#imageMaxWidth) */ imageMaxWidth: number; /** * Defines how to interpolate pixel values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#interpolation) */ interpolation: "nearest" | "bilinear" | "cubic" | "majority"; /** * Defines how overlapping images should be mosaicked. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#mosaicRule) */ mosaicRule: MosaicRule; /** * The multidimensional information associated with the layer if the layer's [hasMultidimensions](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#hasMultidimensions) property is `true`. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#multidimensionalInfo) */ readonly multidimensionalInfo: RasterMultidimensionalInfo; /** * Represents a multidimensional subset of raster data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#multidimensionalSubset) */ multidimensionalSubset: MultidimensionalSubset; /** * The pixel value representing no available information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#noData) */ noData: number | number[]; /** * Interpretation of the [noData](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#noData) setting. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#noDataInterpretation) */ noDataInterpretation: "any" | "all"; /** * The name of an `oid` [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#fields) containing a unique value or identifier for each raster in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#objectIdField) */ objectIdField: string; /** * A function that processes [pixelData](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ImageryLayerView.html#pixelData). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#pixelFilter) */ pixelFilter: PixelFilterFunction; /** * Raster source pixel type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#pixelType) */ pixelType: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; /** * A complete list of fields that consists of raster attribute table fields, item pixel value, service pixel value, service pixel value with various server defined function templates, and raster attribute table fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#rasterFields) */ readonly rasterFields: Field[]; /** * Specifies the rule for how the requested image should be processed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#rasterFunction) */ rasterFunction: RasterFunction; /** * Returns raster function information for the image services, including the name, description, help, function type, and a thumbnail of pre-configured raster function templates. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#rasterFunctionInfos) */ readonly rasterFunctionInfos: RasterFunctionInfo[]; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#renderer) */ renderer: | ClassBreaksRenderer | UniqueValueRenderer | RasterStretchRenderer | RasterShadedReliefRenderer | RasterColormapRenderer | VectorFieldRenderer | FlowRenderer; /** * Specifies the rule for how the requested image should be rendered. * * @deprecated since 4.27. Use {@link module:esri/layers/ImageryLayer#rasterFunction rasterFunction} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#renderingRule) */ renderingRule: RasterFunction; /** * Source raster information of the image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#serviceRasterInfo) */ readonly serviceRasterInfo: RasterInfo; /** * The [image service's metadata JSON](https://developers.arcgis.com/rest/services-reference/image-service.htm) exposed by the ArcGIS REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#sourceJSON) */ sourceJSON: any; /** * Image service data source type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#sourceType) */ readonly sourceType: "mosaic-dataset" | "raster-dataset"; /** * The spatial reference of the image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#spatialReference) */ readonly spatialReference: SpatialReference; /** * The URL to the REST endpoint of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#url) */ url: string; /** * The version of ArcGIS Server in which the image service is published. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#version) */ readonly version: number; constructor(properties?: ArcGISImageServiceProperties); /** * Computes the rotation angle of a ImageryLayer at a given location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#computeAngles) */ computeAngles(parameters: ImageAngleParameters | ImageAngleParametersProperties, requestOptions?: any): Promise; /** * Computes histograms based on the provided [ImageHistogramParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#computeHistograms) */ computeHistograms(parameters: ImageHistogramParameters | ImageHistogramParametersProperties, requestOptions?: any): Promise; /** * Computes the corresponding pixel location in columns and rows for an image based on input geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#computePixelSpaceLocations) */ computePixelSpaceLocations(parameters: ImagePixelLocationParameters, requestOptions?: any): Promise; /** * Computes [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterBandStatistics) and [histograms](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterHistogram) for the provided [ImageHistogramParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#computeStatisticsHistograms) */ computeStatisticsHistograms(parameters: ImageHistogramParameters | ImageHistogramParametersProperties, requestOptions?: any): Promise; /** * Returns an image using the [export REST operation](https://developers.arcgis.com/rest/services-reference/export-image.htm) that displays data from an [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#fetchImage) */ fetchImage(extent: Extent, width: number, height: number, options?: ArcGISImageServiceFetchImageOptions): Promise; /** * Finds images based on the provided [FindImagesParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindImagesParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#findImages) */ findImages(parameters: FindImagesParameters | FindImagesParametersProperties, requestOptions?: any): Promise; /** * Generates raster info for the specified raster function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#generateRasterInfo) */ generateRasterInfo(rasterFunction: RasterFunction | RasterFunctionProperties, options?: ArcGISImageServiceGenerateRasterInfoOptions): Promise; /** * Gets the [image coordinate system](https://developers.arcgis.com/rest/services-reference/raster-ics.htm) information of a catalog item in an image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#getCatalogItemICSInfo) */ getCatalogItemICSInfo(rasterId: number, options?: ArcGISImageServiceGetCatalogItemICSInfoOptions): Promise; /** * Get the [raster info](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html) of a [catalog item](https://developers.arcgis.com/rest/services-reference/raster-catalog-item.htm) in an image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#getCatalogItemRasterInfo) */ getCatalogItemRasterInfo(rasterId: number, options?: ArcGISImageServiceGetCatalogItemRasterInfoOptions): Promise; /** * Returns sample point locations, pixel values and corresponding resolutions of the source data for a given geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#getSamples) */ getSamples(parameters: ImageSampleParameters | ImageSampleParametersProperties, requestOptions?: any): Promise; /** * Sends a request to the ArcGIS REST image service to identify content based on the specified [ImageIdentifyParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#identify) */ identify(parameters: ImageIdentifyParameters | ImageIdentifyParametersProperties, requestOptions?: any): Promise; /** * Converts a geometry from an image space to a map space using the provided [ImageToMapParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#imageToMap) */ imageToMap(parameters: ImageToMapParameters | ImageToMapParametersProperties, requestOptions?: any): Promise; /** * Creates a map space geometry from multiray image space geometries using the provided [ImageToMapMultirayParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapMultirayParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#imageToMapMultiray) */ imageToMapMultiray(parameters: ImageToMapMultirayParameters | ImageToMapMultirayParametersProperties, requestOptions?: any): Promise; /** * Converts a given geometry from a map space to an image space using the provided [MapToImageParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MapToImageParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#mapToImage) */ mapToImage(parameters: MapToImageParameters | MapToImageParametersProperties, requestOptions?: any): Promise; /** * Calculates the area and perimeter of a given geometry on an image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#measureAreaAndPerimeter) */ measureAreaAndPerimeter(parameters: ImageAreaParameters | ImageAreaParametersProperties, requestOptions?: any): Promise; /** * Measures the area and the perimeter of a polygon in an image space on a selected raster when the following conditions are met: * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#measureAreaFromImage) */ measureAreaFromImage(parameters: MeasureFromImageParameters | MeasureFromImageParametersProperties, requestOptions?: any): Promise; /** * Calculates the distance and angle between two points on an image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#measureDistanceAndAngle) */ measureDistanceAndAngle(parameters: ImageDistanceParameters | ImageDistanceParametersProperties, requestOptions?: any): Promise; /** * Calculates the height of an object between two points on an image service if the sensor info is available. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#measureHeight) */ measureHeight(parameters: ImageHeightParameters | ImageHeightParametersProperties, requestOptions?: any): Promise; /** * Measures the length of a polyline in an image space on a selected raster when the following conditions are met: * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#measureLengthFromImage) */ measureLengthFromImage(parameters: MeasureFromImageParameters | MeasureFromImageParametersProperties, requestOptions?: any): Promise; /** * Returns the location for a given point or centroid of a given area on an image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#measurePointOrCentroid) */ measurePointOrCentroid(parameters: ImagePointParameters | ImagePointParametersProperties, requestOptions?: any): Promise; /** * Returns the boundary of an image for the provided [ImageBoundaryParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageBoundaryParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#queryBoundary) */ queryBoundary(parameters: ImageBoundaryParameters | ImageBoundaryParametersProperties, requestOptions?: any): Promise; /** * Returns GPS information for the provided [ImageGPSInfoParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfoParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#queryGPSInfo) */ queryGPSInfo(parameters: ImageGPSInfoParameters | ImageGPSInfoParametersProperties, requestOptions?: any): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the image service and returns an array of Object IDs for the rasters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#queryObjectIds) */ queryObjectIds(query?: Query | QueryProperties, requestOptions?: any): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the image service and returns the number of rasters that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#queryRasterCount) */ queryRasterCount(query?: Query | QueryProperties, requestOptions?: any): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against an image service and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html), which can be accessed using the `.then()` method once the promise resolves. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#queryRasters) */ queryRasters(query: Query | QueryProperties, requestOptions?: any): Promise; static fromJSON(json: any): ArcGISImageService; } interface ArcGISImageServiceProperties { /** * Defines a band combination using 0-based band indexes. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#bandIds) */ bandIds?: number[]; /** * Describes the layer's supported capabilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ capabilities?: ArcGISImageServiceCapabilities; /** * The compression quality value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#compressionQuality) */ compressionQuality?: number; /** * Controls the tolerance of the lerc compression algorithm. * * @default 0.01 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#compressionTolerance) */ compressionTolerance?: number; /** * The copyright text as defined by the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#copyright) */ copyright?: string; /** * The SQL where clause used to filter rasters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#definitionExpression) */ definitionExpression?: string; /** * An array of fields in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#fields) */ fields?: FieldProperties[]; /** * The format of the exported image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#format) */ format?: "png" | "png8" | "png24" | "png32" | "jpg" | "bmp" | "gif" | "jpgpng" | "lerc" | "tiff"; /** * Indicates if the layer has [multidimensionalInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#multidimensionalInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#hasMultidimensions) */ hasMultidimensions?: boolean; /** * Indicates the maximum height of the image exported by the service. * * @default 4100 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#imageMaxHeight) */ imageMaxHeight?: number; /** * Indicates the maximum width of the image exported by the service. * * @default 15000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#imageMaxWidth) */ imageMaxWidth?: number; /** * Defines how to interpolate pixel values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#interpolation) */ interpolation?: "nearest" | "bilinear" | "cubic" | "majority"; /** * Defines how overlapping images should be mosaicked. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#mosaicRule) */ mosaicRule?: MosaicRuleProperties; /** * Represents a multidimensional subset of raster data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#multidimensionalSubset) */ multidimensionalSubset?: MultidimensionalSubsetProperties; /** * The pixel value representing no available information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#noData) */ noData?: number | number[]; /** * Interpretation of the [noData](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#noData) setting. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#noDataInterpretation) */ noDataInterpretation?: "any" | "all"; /** * The name of an `oid` [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#fields) containing a unique value or identifier for each raster in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#objectIdField) */ objectIdField?: string; /** * A function that processes [pixelData](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ImageryLayerView.html#pixelData). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#pixelFilter) */ pixelFilter?: PixelFilterFunction; /** * Raster source pixel type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#pixelType) */ pixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; /** * Specifies the rule for how the requested image should be processed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#rasterFunction) */ rasterFunction?: RasterFunctionProperties; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#renderer) */ renderer?: | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (RasterStretchRendererProperties & { type: "raster-stretch" }) | (RasterShadedReliefRendererProperties & { type: "raster-shaded-relief" }) | (RasterColormapRendererProperties & { type: "raster-colormap" }) | (VectorFieldRendererProperties & { type: "vector-field" }) | (FlowRendererProperties & { type: "flow" }); /** * Specifies the rule for how the requested image should be rendered. * * @deprecated since 4.27. Use {@link module:esri/layers/ImageryLayer#rasterFunction rasterFunction} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#renderingRule) */ renderingRule?: RasterFunctionProperties; /** * The [image service's metadata JSON](https://developers.arcgis.com/rest/services-reference/image-service.htm) exposed by the ArcGIS REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#sourceJSON) */ sourceJSON?: any; /** * The URL to the REST endpoint of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#url) */ url?: string; } export interface ArcGISImageServiceCapabilities { /** * Describes [mensuration operations](https://developers.arcgis.com/rest/services-reference/enterprise/measure.htm) supported by the ImageryLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ mensuration: ArcGISImageServiceCapabilitiesMensuration; /** * Describes operations supported by the ImageryLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ operations: ArcGISImageServiceCapabilitiesOperations; /** * Describes [query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) operations supported by the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ query: ArcGISImageServiceCapabilitiesQuery; } export interface ArcGISImageServiceCapabilitiesMensuration { /** * Indicates if the layer supports 3D mensuration operations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supports3D: boolean; /** * Indicates if the layer supports area and perimeter mensuration operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsAreaAndPerimeter: boolean; /** * Indicates if the layer supports distance and angle mensuration operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsDistanceAndAngle: boolean; /** * Indicates if the layer supports a mensuration operation for calculating a height of a ground feature by measuring from the base of the object to the top of the object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsHeightFromBaseAndTop: boolean; /** * Indicates if the layer supports a mensuration operation for calculating a height of a feature by measuring from the base of the object to the top of the object's shadow on the ground. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsHeightFromBaseAndTopShadow: boolean; /** * Indicates if the layer supports mensuration operation for calculating a height from the top of the object to the top of the objects's shadow on the ground. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsHeightFromTopAndTopShadow: boolean; /** * Indicates if the layer supports point or centroid mensuration operations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsPointOrCentroid: boolean; } export interface ArcGISImageServiceCapabilitiesOperations { /** * Indicates if the layer supports a [compute histograms](https://developers.arcgis.com/rest/services-reference/compute-histograms.htm) operation from an area of interest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsComputeHistograms: boolean; /** * Indicates if the layer supports an [export image](https://developers.arcgis.com/rest/services-reference/export-image.htm) operation based on a bounding box. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsExportImage: boolean; /** * Indicates if the layer supports an [identify](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-identify.html#identify) operation on pixel values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsIdentify: boolean; /** * Indicates if the layer supports mensuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsMeasure: boolean; /** * Indicates if the layer supports image to map operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsImageToMap: boolean; /** * Indicates if the layer supports image to map multiray operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsImageToMapMultiray: boolean; /** * Indicates if the layer supports find images operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsFindImages: boolean; /** * Indicates if the layer supports get image url operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsGetImageUrl: boolean; /** * Indicates if the layer supports map to image operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsMapToImage: boolean; /** * Indicates if the layer allows the source image to be [downloaded](https://developers.arcgis.com/rest/services-reference/download-rasters.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsDownload: boolean; /** * Indicates if the layer supports an operation to [query images](https://developers.arcgis.com/rest/services-reference/query-image-service-.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsQuery: boolean; /** * Indicates if the layer supports a [sampling operation](https://developers.arcgis.com/rest/services-reference/get-samples.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsGetSamples: boolean; /** * Indicates if the layer supports [projection of geometries](https://developers.arcgis.com/rest/services-reference/project.htm), including from/to image spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsProject: boolean; /** * Indicates if the layer supports an operation [computing statistics and histograms](https://developers.arcgis.com/rest/services-reference/compute-statistics-and-histograms.htm) from an area of interest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsComputeStatisticsHistograms: boolean; /** * Indicates if the layer supports an operation to [query the service's boundary](https://developers.arcgis.com/rest/services-reference/query-boundary.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsQueryBoundary: boolean; /** * Indicates if the layer supports an operation to [query the service's gps info](https://developers.arcgis.com/rest/services-reference/enterprise/query-gps-.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsQueryGPSInfo: boolean; /** * Indicates if the elevation layer supports an operation to [compute volumes](https://developers.arcgis.com/rest/services-reference/calculate-volume.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsCalculateVolume: boolean; /** * Indicates if the layer supports [computing pixel location](https://developers.arcgis.com/rest/services-reference/compute-pixel-location.htm) in pixel space. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsComputePixelLocation: boolean; } export interface ArcGISImageServiceCapabilitiesQuery { /** * Indicates if the layer supports field-based statistical functions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsStatistics: boolean; /** * Indicates if the layer returned in the query response can be ordered by one or more fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsOrderBy: boolean; /** * Indicates if the layer supports queries for distinct values based on fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsDistinct: boolean; /** * Indicates if the layer supports paged queries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsPagination: boolean; /** * Indicates if the layer supports use of standardized queries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ supportsStandardizedQueriesOnly: boolean; /** * The maximum number of records that will be returned for a given query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#capabilities) */ maxRecordCount: boolean; } export interface ArcGISImageServiceFetchImageOptions { /** * An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to abort the request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#fetchImage) */ signal?: AbortSignal; } export interface ArcGISImageServiceGenerateRasterInfoOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#generateRasterInfo) */ signal?: AbortSignal; } export interface ArcGISImageServiceGetCatalogItemICSInfoOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#getCatalogItemICSInfo) */ signal?: AbortSignal; } export interface ArcGISImageServiceGetCatalogItemRasterInfoOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#getCatalogItemRasterInfo) */ signal?: AbortSignal; } export class ArcGISMapService { /** * Indicates the layer's supported capabilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ readonly capabilities: ArcGISMapServiceCapabilities; /** * The copyright text as defined by the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#copyright) */ copyright: string; /** * The full extent of the layer as defined by the map service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#fullExtent) */ fullExtent: Extent; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#legendEnabled) */ legendEnabled: boolean; /** * The spatial reference of the layer as defined by the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#spatialReference) */ readonly spatialReference: SpatialReference; /** * The version of ArcGIS Server in which the map service is published. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#version) */ readonly version: number; constructor(properties?: ArcGISMapServiceProperties); static fromJSON(json: any): ArcGISMapService; } interface ArcGISMapServiceProperties { /** * The copyright text as defined by the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#copyright) */ copyright?: string; /** * The full extent of the layer as defined by the map service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#fullExtent) */ fullExtent?: ExtentProperties; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#legendEnabled) */ legendEnabled?: boolean; } export interface ArcGISMapServiceCapabilities { /** * Indicates options supported by the exportMap operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ exportMap: ArcGISMapServiceCapabilitiesExportMap; /** * Indicates options supported by the exportTiles operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ exportTiles: ArcGISMapServiceCapabilitiesExportTiles; /** * Indicates operations that can be performed on the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ operations: ArcGISMapServiceCapabilitiesOperations; } export interface ArcGISMapServiceCapabilitiesExportMap { /** * Indicates if sublayers support Arcade expressions for labeling. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ supportsArcadeExpressionForLabeling: boolean; /** * Indicates if sublayers rendering can be modified or added using dynamic layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ supportsDynamicLayers: boolean; /** * Indicates if sublayers can be added, or removed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ supportsSublayersChanges: boolean; /** * Indicates if sublayers [definition expression](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#definitionExpression) can be set. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ supportsSublayerDefinitionExpression: boolean; /** * Indicates if sublayers [visibility](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#visible) can be changed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ supportsSublayerVisibility: boolean; /** * _Since 4.23_ Indicates if [CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html) can be used in a sublayer's [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#renderer). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ supportsCIMSymbols: boolean; } export interface ArcGISMapServiceCapabilitiesExportTiles { /** * Specifies the maximum number of tiles that can be exported to a cache dataset or a tile package. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ maxExportTilesCount: number; } export interface ArcGISMapServiceCapabilitiesOperations { /** * Indicates if the service can generate images. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ supportsExportMap: boolean; /** * Indicates if the tiles from the service can be exported. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ supportsExportTiles: boolean; /** * Indicates if the service supports the [identify operation](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-identify.html#identify). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ supportsIdentify: boolean; /** * Indicates if features in the sublayers can be [queried](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#queryFeatures). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ supportsQuery: boolean; /** * Indicates if the service exposes a tile map that describes the presence of tiles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ supportsTileMap: boolean; } export class BlendLayer { /** * Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer. * * @default normal * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-BlendLayer.html#blendMode) */ blendMode: | "average" | "color-burn" | "color-dodge" | "color" | "darken" | "destination-atop" | "destination-in" | "destination-out" | "destination-over" | "difference" | "exclusion" | "hard-light" | "hue" | "invert" | "lighten" | "lighter" | "luminosity" | "minus" | "multiply" | "normal" | "overlay" | "plus" | "reflect" | "saturation" | "screen" | "soft-light" | "source-atop" | "source-in" | "source-out" | "vivid-light" | "xor"; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to how image filters work. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-BlendLayer.html#effect) */ effect: Effect; } interface BlendLayerProperties { /** * Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer. * * @default normal * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-BlendLayer.html#blendMode) */ blendMode?: | "average" | "color-burn" | "color-dodge" | "color" | "darken" | "destination-atop" | "destination-in" | "destination-out" | "destination-over" | "difference" | "exclusion" | "hard-light" | "hue" | "invert" | "lighten" | "lighter" | "luminosity" | "minus" | "multiply" | "normal" | "overlay" | "plus" | "reflect" | "saturation" | "screen" | "soft-light" | "source-atop" | "source-in" | "source-out" | "vivid-light" | "xor"; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to how image filters work. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-BlendLayer.html#effect) */ effect?: any[] | string; } export class CustomParametersMixin { /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-CustomParametersMixin.html#customParameters) */ customParameters: any; } interface CustomParametersMixinProperties { /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-CustomParametersMixin.html#customParameters) */ customParameters?: any; } export class FeatureEffectLayer { /** * The featureEffect can be used to draw attention features of interest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureEffectLayer.html#featureEffect) */ featureEffect: FeatureEffect; } interface FeatureEffectLayerProperties { /** * The featureEffect can be used to draw attention features of interest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureEffectLayer.html#featureEffect) */ featureEffect?: FeatureEffectProperties; } export class FeatureLayerBase { /** * Describes the layer's supported capabilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#capabilities) */ readonly capabilities: Capabilities; /** * Copyright information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#copyright) */ copyright: string; /** * The time zone that dates are stored in. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#dateFieldsTimeZone) */ dateFieldsTimeZone: string; /** * This property is set by the service publisher and indicates that dates should be considered without the local timezone. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#datesInUnknownTimezone) */ readonly datesInUnknownTimezone: boolean; /** * The SQL where clause used to filter features on the client. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#definitionExpression) */ definitionExpression: string; /** * The name of the layer's primary display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#displayField) */ displayField: string; /** * The editor tracking fields, which record who adds or edits the data through the feature service and when edits are made. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#editFieldsInfo) */ readonly editFieldsInfo: EditFieldsInfo; /** * Specifies information about editing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#editingInfo) */ readonly editingInfo: EditingInfo; /** * Describes effective capabilities of the layer taking in to consideration privileges of the currently signed-in user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#effectiveCapabilities) */ readonly effectiveCapabilities: Capabilities; /** * Indicates whether the layer is editable taking in to consideration privileges of the currently signed-in user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#effectiveEditingEnabled) */ readonly effectiveEditingEnabled: boolean; /** * Specifies how features are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#elevationInfo) */ elevationInfo: FeatureLayerBaseElevationInfo; /** * A convenient property that can be used to make case-insensitive lookups for a field by name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#fieldsIndex) */ readonly fieldsIndex: FieldsIndex; /** * When a feature layer is configured as floor-aware, it has a floorInfo property defined. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#floorInfo) */ floorInfo: LayerFloorInfo; /** * The full extent of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#fullExtent) */ fullExtent: Extent; /** * The version of the geodatabase of the feature service data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#gdbVersion) */ gdbVersion: string; /** * Provides information on the system maintained area and length fields along with their respective units. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#geometryFieldsInfo) */ readonly geometryFieldsInfo: GeometryFieldsInfo; /** * The geometry type of features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#geometryType) */ geometryType: "point" | "multipoint" | "polyline" | "polygon" | "multipatch" | "mesh"; /** * Indicates whether the client-side features in the layer have `M` (measurement) values. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#hasM) */ hasM: boolean; /** * Indicates whether the client-side features in the layer have `Z` (elevation) values. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#hasZ) */ hasZ: boolean; /** * The historic moment to query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#historicMoment) */ historicMoment: Date; /** * Returns `true` if the layer is loaded from a non-spatial table in a service. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#isTable) */ readonly isTable: boolean; /** * The layer ID, or layer index, of a Feature Service layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#layerId) */ layerId: number; /** * The name of an `oid` [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#fields) containing a unique value or identifier for each feature in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#objectIdField) */ objectIdField: string; /** * The IANA time zone the author of the service intended data from date fields to be viewed in. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#preferredTimeZone) */ readonly preferredTimeZone: string; /** * Array of [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html) set up for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#relationships) */ readonly relationships: Relationship[]; /** * When `true`, indicates that M values will be returned. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#returnM) */ returnM: boolean; /** * When `true`, indicates that z-values will always be returned. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#returnZ) */ returnZ: boolean; /** * The service definition expression limits the features available for display and query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#serviceDefinitionExpression) */ readonly serviceDefinitionExpression: string; /** * Indicates the portal item of the hosted feature service that contains this layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#serviceItemId) */ readonly serviceItemId: string; /** * The [feature service's metadata JSON](https://developers.arcgis.com/rest/services-reference/layer-feature-service-.htm) exposed by the ArcGIS REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#sourceJSON) */ sourceJSON: any; /** * The spatial reference of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#spatialReference) */ spatialReference: SpatialReference; /** * The name of the field which holds the id of the [subtypes](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#subtypes). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#subtypeField) */ readonly subtypeField: string; /** * An array of [subtypes](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Subtype.html) defined in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#subtypes) */ readonly subtypes: Subtype[]; /** * The title of the layer used to identify it in places such as the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) and [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widgets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#title) */ title: string; /** * The absolute URL of the REST endpoint of the layer, non-spatial table or service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#url) */ url: string; /** * The version of ArcGIS Server in which the layer is published. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#version) */ readonly version: number; /** * Adds an attachment to a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#addAttachment) */ addAttachment(feature: Graphic, attachment: HTMLFormElement | FormData): Promise; /** * Applies edits to features in a layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#applyEdits) */ applyEdits(edits: FeatureLayerBaseApplyEditsEdits, options?: FeatureLayerBaseApplyEditsOptions): Promise; /** * Deletes attachments from a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#deleteAttachments) */ deleteAttachments(feature: Graphic, attachmentIds: number[]): Promise; /** * Returns the [Field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) instance for a field name (case-insensitive). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#getField) */ getField(fieldName: string): Field; /** * Returns the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) associated with the given field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#getFieldDomain) */ getFieldDomain(fieldName: string, options?: FeatureLayerBaseGetFieldDomainOptions): Domain; /** * Query information about attachments associated with features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#queryAttachments) */ queryAttachments(attachmentQuery: AttachmentQuery | AttachmentQueryProperties, options?: FeatureLayerBaseQueryAttachmentsOptions): Promise; /** * Executes a [RelationshipQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html) against the feature service and returns [FeatureSets](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html) grouped by source layer or table objectIds. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#queryRelatedFeatures) */ queryRelatedFeatures(relationshipQuery: RelationshipQuery | RelationshipQueryProperties, options?: FeatureLayerBaseQueryRelatedFeaturesOptions): Promise; /** * Executes a [RelationshipQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html) against the feature service and when resolved, it returns an `object` containing key value pairs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#queryRelatedFeaturesCount) */ queryRelatedFeaturesCount(relationshipQuery: RelationshipQuery | RelationshipQueryProperties, options?: FeatureLayerBaseQueryRelatedFeaturesCountOptions): Promise; /** * Saves the layer to its existing portal item in the [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html) authenticated within the user's current session. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#save) */ save(options?: FeatureLayerBaseSaveOptions): Promise; /** * Saves the layer to a new portal item in the [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html) authenticated within the user's current session. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#saveAs) */ saveAs(portalItem: PortalItem | PortalItemProperties, options?: FeatureLayerBaseSaveAsOptions): Promise; /** * Updates an existing attachment for a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#updateAttachment) */ updateAttachment(feature: Graphic, attachmentId: number, attachment: HTMLFormElement | FormData): Promise; } interface FeatureLayerBaseProperties { /** * Copyright information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#copyright) */ copyright?: string; /** * The time zone that dates are stored in. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#dateFieldsTimeZone) */ dateFieldsTimeZone?: string; /** * The SQL where clause used to filter features on the client. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#definitionExpression) */ definitionExpression?: string; /** * The name of the layer's primary display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#displayField) */ displayField?: string; /** * Specifies how features are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#elevationInfo) */ elevationInfo?: FeatureLayerBaseElevationInfo; /** * When a feature layer is configured as floor-aware, it has a floorInfo property defined. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#floorInfo) */ floorInfo?: LayerFloorInfoProperties; /** * The full extent of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#fullExtent) */ fullExtent?: ExtentProperties; /** * The version of the geodatabase of the feature service data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#gdbVersion) */ gdbVersion?: string; /** * The geometry type of features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#geometryType) */ geometryType?: "point" | "multipoint" | "polyline" | "polygon" | "multipatch" | "mesh"; /** * Indicates whether the client-side features in the layer have `M` (measurement) values. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#hasM) */ hasM?: boolean; /** * Indicates whether the client-side features in the layer have `Z` (elevation) values. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#hasZ) */ hasZ?: boolean; /** * The historic moment to query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#historicMoment) */ historicMoment?: DateProperties; /** * The layer ID, or layer index, of a Feature Service layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#layerId) */ layerId?: number; /** * The name of an `oid` [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#fields) containing a unique value or identifier for each feature in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#objectIdField) */ objectIdField?: string; /** * When `true`, indicates that M values will be returned. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#returnM) */ returnM?: boolean; /** * When `true`, indicates that z-values will always be returned. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#returnZ) */ returnZ?: boolean; /** * The [feature service's metadata JSON](https://developers.arcgis.com/rest/services-reference/layer-feature-service-.htm) exposed by the ArcGIS REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#sourceJSON) */ sourceJSON?: any; /** * The spatial reference of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * The title of the layer used to identify it in places such as the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) and [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widgets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#title) */ title?: string; /** * The absolute URL of the REST endpoint of the layer, non-spatial table or service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#url) */ url?: string; } export interface FeatureLayerBaseApplyEditsEdits { /** * An array or a [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of features to be added. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#applyEdits) */ addFeatures?: Graphic[] | Collection; /** * An array or a [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of features to be updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#applyEdits) */ updateFeatures?: Graphic[] | Collection; /** * An array or a [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of features, or an array of objects with `objectId` or `globalId` of each feature to be deleted. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#applyEdits) */ deleteFeatures?: Graphic[] | Collection | any[]; /** * An array of attachments to be added. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#applyEdits) */ addAttachments?: AttachmentEdit[]; /** * An array of attachments to be updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#applyEdits) */ updateAttachments?: AttachmentEdit[]; /** * An array of [globalId](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#AttachmentEdit)s for attachments to be deleted. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#applyEdits) */ deleteAttachments?: string[]; } export interface FeatureLayerBaseApplyEditsOptions { /** * The geodatabase version to apply the edits. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#applyEdits) */ gdbVersion?: string; /** * Indicates whether the edit results should return the time edits were applied. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#applyEdits) */ returnEditMoment?: boolean; /** * If set to `original-and-current-features`, the [EditedFeatureResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#EditedFeatureResult) parameter will be included in the `applyEdits` response. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#applyEdits) */ returnServiceEditsOption?: "none" | "original-and-current-features"; /** * Indicates whether the edits should be applied only if all submitted edits succeed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#applyEdits) */ rollbackOnFailureEnabled?: boolean; /** * Indicates whether the edits can be applied using globalIds of features or attachments. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#applyEdits) */ globalIdUsed?: boolean; } export interface FeatureLayerBaseElevationInfo { /** * Defines how the feature is placed with respect to the terrain surface or 3D objects in the scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#elevationInfo) */ mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; /** * An elevation offset, which is added to the vertical position of the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#elevationInfo) */ offset?: number; /** * Defines how to override a feature's Z-value based on its attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#elevationInfo) */ featureExpressionInfo?: FeatureLayerBaseElevationInfoFeatureExpressionInfo; /** * The unit for `featureExpressionInfo` and `offset` values. * * [Read more...](global.html#unit) */ unit?: "feet" | "meters" | "kilometers" | "miles" | "us-feet" | "yards"; } export interface FeatureLayerBaseElevationInfoFeatureExpressionInfo { /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Feature Z Profile](https://developers.arcgis.com/javascript/latest/arcade/#z-values). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#elevationInfo) */ expression?: string; } export interface FeatureLayerBaseGetFieldDomainOptions { /** * The feature to which the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) is assigned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#getFieldDomain) */ feature: Graphic; } export interface FeatureLayerBaseQueryAttachmentsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#queryAttachments) */ signal?: AbortSignal; } export interface FeatureLayerBaseQueryRelatedFeaturesCountOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#queryRelatedFeaturesCount) */ signal?: AbortSignal; } export interface FeatureLayerBaseQueryRelatedFeaturesOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#queryRelatedFeatures) */ signal?: AbortSignal; } export interface FeatureLayerBaseSaveAsOptions { /** * The portal folder where the layer's portal item will be saved. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#saveAs) */ folder?: PortalFolder; /** * Options for validating the save operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#saveAs) */ validationOptions?: FeatureLayerBaseSaveAsOptionsValidationOptions; } export interface FeatureLayerBaseSaveAsOptionsValidationOptions { /** * Indicates whether to ignore saving unsupported layers or layers with unsupported content, such as unsupported symbology. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#saveAs) */ ignoreUnsupported?: boolean; } export interface FeatureLayerBaseSaveOptions { /** * Options for validating the save operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#save) */ validationOptions?: FeatureLayerBaseSaveOptionsValidationOptions; } export interface FeatureLayerBaseSaveOptionsValidationOptions { /** * Indicates whether to ignore saving unsupported layers or layers with unsupported content, such as unsupported symbology. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureLayerBase.html#save) */ ignoreUnsupported?: boolean; } export class FeatureReductionLayer { /** * Configures the method for reducing the number of point features in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureReductionLayer.html#featureReduction) */ featureReduction: FeatureReductionBinning | FeatureReductionCluster | FeatureReductionSelection; } interface FeatureReductionLayerProperties { /** * Configures the method for reducing the number of point features in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-FeatureReductionLayer.html#featureReduction) */ featureReduction?: | (FeatureReductionBinningProperties & { type: "binning" }) | (FeatureReductionClusterProperties & { type: "cluster" }) | (FeatureReductionSelectionProperties & { type: "selection" }); } export class ImageryTileMixin { /** * Defines a band combination using 0-based band indexes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ImageryTileMixin.html#bandIds) */ bandIds: number[]; /** * The copyright text as defined by the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ImageryTileMixin.html#copyright) */ copyright: string; /** * The multidimensional definitions associated with the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ImageryTileMixin.html#multidimensionalDefinition) */ multidimensionalDefinition: DimensionalDefinition[]; /** * Raster information retrieved from data source. * * @deprecated since 4.29. Use {@link module:esri/layers/ImageryTileLayer#serviceRasterInfo serviceRasterInfo} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ImageryTileMixin.html#rasterInfo) */ readonly rasterInfo: RasterInfo; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ImageryTileMixin.html#renderer) */ renderer: | ClassBreaksRenderer | UniqueValueRenderer | RasterStretchRenderer | RasterShadedReliefRenderer | RasterColormapRenderer | VectorFieldRenderer | FlowRenderer; /** * Raster information retrieved from tiled imagery data source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ImageryTileMixin.html#serviceRasterInfo) */ readonly serviceRasterInfo: RasterInfo; /** * Fetches pixels for a given extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ImageryTileMixin.html#fetchPixels) */ fetchPixels(extent: Extent, width: number, height: number, options?: ImageryTileMixinFetchPixelsOptions): Promise; /** * Identify pixel values at a given location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ImageryTileMixin.html#identify) */ identify(point: Point | PointProperties, options?: RasterIdentifyOptions): Promise; } interface ImageryTileMixinProperties { /** * Defines a band combination using 0-based band indexes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ImageryTileMixin.html#bandIds) */ bandIds?: number[]; /** * The copyright text as defined by the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ImageryTileMixin.html#copyright) */ copyright?: string; /** * The multidimensional definitions associated with the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ImageryTileMixin.html#multidimensionalDefinition) */ multidimensionalDefinition?: DimensionalDefinitionProperties[]; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ImageryTileMixin.html#renderer) */ renderer?: | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (RasterStretchRendererProperties & { type: "raster-stretch" }) | (RasterShadedReliefRendererProperties & { type: "raster-shaded-relief" }) | (RasterColormapRendererProperties & { type: "raster-colormap" }) | (VectorFieldRendererProperties & { type: "vector-field" }) | (FlowRendererProperties & { type: "flow" }); } export interface ImageryTileMixinFetchPixelsOptions { /** * Added at version 4.23. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ImageryTileMixin.html#fetchPixels) */ interpolation?: "nearest" | "bilinear" | "cubic" | "majority"; /** * An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to abort the request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ImageryTileMixin.html#fetchPixels) */ signal?: AbortSignal; } export class OperationalLayer { /** * Enable persistence of the layer in a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html) or [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-OperationalLayer.html#persistenceEnabled) */ persistenceEnabled: boolean; constructor(properties?: OperationalLayerProperties); static fromJSON(json: any): OperationalLayer; } interface OperationalLayerProperties { /** * Enable persistence of the layer in a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html) or [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-OperationalLayer.html#persistenceEnabled) */ persistenceEnabled?: boolean; } export class OrderedLayer { /** * Determines the order in which features are drawn in the view. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-OrderedLayer.html#orderBy) */ orderBy: OrderedLayerOrderBy[]; } interface OrderedLayerProperties { /** * Determines the order in which features are drawn in the view. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-OrderedLayer.html#orderBy) */ orderBy?: OrderedLayerOrderBy[]; } export interface OrderedLayerOrderBy { /** * The number or date field whose values will be used to sort features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-OrderedLayer.html#orderBy) */ field?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Feature Z Profile](https://developers.arcgis.com/javascript/latest/arcade/#feature-sorting). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-OrderedLayer.html#orderBy) */ valueExpression?: string; /** * The sort order. * * @default ascending * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-OrderedLayer.html#orderBy) */ order?: "ascending" | "descending"; } export class PortalLayer { /** * The portal item from which the layer is loaded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-PortalLayer.html#portalItem) */ portalItem: PortalItem; constructor(properties?: PortalLayerProperties); static fromJSON(json: any): PortalLayer; } interface PortalLayerProperties { /** * The portal item from which the layer is loaded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-PortalLayer.html#portalItem) */ portalItem?: PortalItemProperties; } export class PublishableLayer { /** * Checks layer's publishing status while the layer is being published to the portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-PublishableLayer.html#publishingInfo) */ readonly publishingInfo: PublishingInfo; } interface PublishableLayerProperties { } export class RefreshableLayer { /** * Refresh interval of the layer in minutes. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-RefreshableLayer.html#refreshInterval) */ refreshInterval: number; /** * Fetches all the data for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-RefreshableLayer.html#refresh) */ refresh(): void; } interface RefreshableLayerProperties { /** * Refresh interval of the layer in minutes. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-RefreshableLayer.html#refreshInterval) */ refreshInterval?: number; } export class ScaleRangeLayer { /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ScaleRangeLayer.html#maxScale) */ maxScale: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ScaleRangeLayer.html#minScale) */ minScale: number; } interface ScaleRangeLayerProperties { /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ScaleRangeLayer.html#maxScale) */ maxScale?: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ScaleRangeLayer.html#minScale) */ minScale?: number; } export class SceneService { /** * The copyright text as defined by the scene service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#copyright) */ copyright: string; /** * The layer ID, or layer index, of a Scene Service layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#layerId) */ layerId: number; /** * The spatial reference of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#spatialReference) */ spatialReference: SpatialReference; /** * The URL of the REST endpoint of the layer or scene service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#url) */ url: string; /** * The version of the scene service specification used for this service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#version) */ readonly version: SceneServiceVersion; constructor(properties?: SceneServiceProperties); static fromJSON(json: any): SceneService; } interface SceneServiceProperties { /** * The copyright text as defined by the scene service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#copyright) */ copyright?: string; /** * The layer ID, or layer index, of a Scene Service layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#layerId) */ layerId?: number; /** * The spatial reference of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * The URL of the REST endpoint of the layer or scene service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#url) */ url?: string; } export interface SceneServiceVersion { /** * The major version of the scene layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#version) */ major: number; /** * The minor version of the scene layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#version) */ minor: number; /** * The complete version string of the scene layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#version) */ versionString: string; } export class SublayersOwner { /** * Returns a deep clone of a map service's [sublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html) as defined by the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SublayersOwner.html#createServiceSublayers) */ createServiceSublayers(): Collection; /** * Returns the sublayer with the given layerId. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SublayersOwner.html#findSublayerById) */ findSublayerById(id: number): Sublayer; } export class TemporalLayer { /** * The layer's time extent. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-TemporalLayer.html#timeExtent) */ timeExtent: TimeExtent; /** * TimeInfo provides information such as date fields that store [start](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#startField) and [end](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#endField) time for each feature and the [fullTimeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#fullTimeExtent) for the layer. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-TemporalLayer.html#timeInfo) */ timeInfo: TimeInfo; /** * A temporary offset of the time data based on a certain [TimeInterval](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeInterval.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-TemporalLayer.html#timeOffset) */ timeOffset: TimeInterval; /** * Determines if the layer will update its temporal data based on the view's [timeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#timeExtent). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-TemporalLayer.html#useViewTime) */ useViewTime: boolean; } interface TemporalLayerProperties { /** * The layer's time extent. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-TemporalLayer.html#timeExtent) */ timeExtent?: TimeExtentProperties; /** * TimeInfo provides information such as date fields that store [start](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#startField) and [end](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#endField) time for each feature and the [fullTimeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#fullTimeExtent) for the layer. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-TemporalLayer.html#timeInfo) */ timeInfo?: TimeInfoProperties; /** * A temporary offset of the time data based on a certain [TimeInterval](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeInterval.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-TemporalLayer.html#timeOffset) */ timeOffset?: TimeIntervalProperties; /** * Determines if the layer will update its temporal data based on the view's [timeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#timeExtent). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-TemporalLayer.html#useViewTime) */ useViewTime?: boolean; } export class TemporalSceneLayer { } /** * Provides utility functions for the [WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html) */ interface wfsUtils { /** * Fetches the GetCapabilities document of a WFS service which contains information about the list of layers in the service and the available operations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#getCapabilities) */ getCapabilities(url: string, options?: wfsUtilsGetCapabilitiesOptions): Promise; /** * Returns the [WFSLayerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSLayerInfo) from the capabilities of the WFS service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#getWFSLayerInfo) */ getWFSLayerInfo(capabilities: WFSCapabilities, name?: string, namespaceUri?: string, options?: wfsUtilsGetWFSLayerInfoOptions): Promise; } export const wfsUtils: wfsUtils; /** * WFS service information about the available layers and operations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSCapabilities) */ export interface WFSCapabilities { /** * Information about the operations needed to consume the WFS service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSCapabilities) */ operations: WFSOperations; /** * An array of featureTypes (or layers) available in the WFS service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSCapabilities) */ featureTypes: WFSFeatureType[]; } /** * Provides information about an individual feature type, or layer, found in the WFS service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSFeatureType) */ export interface WFSFeatureType { /** * The type name of the featureType. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSFeatureType) */ typeName: string; /** * The name of the featureType. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSFeatureType) */ name: string; /** * The title of the featureType. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSFeatureType) */ title: string; /** * The description of the featureType. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSFeatureType) */ description: string; /** * The extent of the features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSFeatureType) */ extent: Extent; /** * The prefix of the namespace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSFeatureType) */ namespacePrefix: string; /** * The namespaceUri of the featureType. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSFeatureType) */ namespaceUri: string; /** * the default spatialReference wkid used when not explicitely specified in the GetFeature call. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSFeatureType) */ defaultSpatialReference: number; /** * An array of spatialReference wkids that are supported on the featureType. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSFeatureType) */ supportedSpatialReferences: number[]; } /** * The layer info from the WFS service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSLayerInfo) */ export interface WFSLayerInfo { /** * The URL to the WFS service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSLayerInfo) */ url: string; /** * The name of the layer in the WFS service to display. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSLayerInfo) */ name: string; /** * The namespace URI for the layer name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSLayerInfo) */ namespaceUri: string; /** * The fields on the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSLayerInfo) */ fields: Field[]; /** * The geometry type of the features in the layer. * * [Read more...](global.html#geometryType) */ geometryType: "point" | "multipoint" | "polyline" | "polygon"; /** * The field containing the object ID. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSLayerInfo) */ objectIdField: string; /** * The spatial reference of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSLayerInfo) */ spatialReference: SpatialReference; /** * The extent of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSLayerInfo) */ extent: Extent; /** * Determines whether the X and Y coordinates should be swapped. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSLayerInfo) */ swapXY: boolean | undefined; wfsCapabilities: WFSCapabilities; /** * The custom parameters applied to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSLayerInfo) */ customParameters: any; } /** * Information about some operations of the WFS service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSOperations) */ export interface WFSOperations { GetCapabilities: WFSOperationsGetCapabilities; DescribeFeatureType: WFSOperationsDescribeFeatureType; GetFeature: WFSOperationsGetFeature; } export interface wfsUtilsGetCapabilitiesOptions { /** * A list of key-value pairs of parameters to append to the url. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#getCapabilities) */ customParameters?: any; /** * An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to abort the executions of the remote method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#getCapabilities) */ signal?: AbortSignal; } export interface wfsUtilsGetWFSLayerInfoOptions { /** * A list of key-value pairs of parameters to append to the url. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#getWFSLayerInfo) */ customParameters?: any; /** * The desired spatial reference for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#getWFSLayerInfo) */ spatialReference?: any; /** * An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to abort the executions of the remote method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#getWFSLayerInfo) */ signal?: AbortSignal; } export interface WFSOperationsDescribeFeatureType { /** * The URL to the DescribeFeatureType endpoint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSOperations) */ url: string; } export interface WFSOperationsGetCapabilities { /** * The URL to the GetCapabilities endpoint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSOperations) */ url: string; } export interface WFSOperationsGetFeature { /** * The URL to the GetFeature endpoint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSOperations) */ url: string; /** * Value of the output format parameter to send with the GetFeature call. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSOperations) */ outputFormat: string; /** * Indicates if the GetFeature request supports pagination. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSOperations) */ supportsPagination: boolean; } export interface OGCFeatureLayer extends Layer, APIKeyMixin, BlendLayer, CustomParametersMixin, OperationalLayer, OrderedLayer, PortalLayer, RefreshableLayer, ScaleRangeLayer, FeatureEffectLayer, FeatureReductionLayer { } export class OGCFeatureLayer { /** * The unique identifier of the collection on the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#collectionId) */ collectionId: string; /** * Copyright information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#copyright) */ copyright: string; /** * Description of the features in the collection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#description) */ readonly description: string; /** * The name of the layer's primary display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#displayField) */ displayField: string; /** * Specifies how features are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#elevationInfo) */ elevationInfo: OGCFeatureLayerElevationInfo; /** * An array of fields in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#fields) */ fields: Field[]; /** * A convenient property that can be used to make case-insensitive lookups for a field by name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#fieldsIndex) */ readonly fieldsIndex: FieldsIndex; /** * The geometry type of features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#geometryType) */ geometryType: "point" | "polygon" | "polyline" | "multipoint"; /** * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#labelingInfo) */ labelingInfo: LabelClass[]; /** * Indicates whether to display labels for this layer. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#labelsVisible) */ labelsVisible: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#legendEnabled) */ legendEnabled: boolean; /** * Explicitly set the maximum number of features that can be returned in a single request. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#maxRecordCount) */ maxRecordCount: number; /** * The OGCFeatureLayer requires that each feature be uniquely identified with an object id. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#objectIdField) */ objectIdField: string; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#popupEnabled) */ popupEnabled: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#renderer) */ renderer: Renderer; /** * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#screenSizePerspectiveEnabled) */ screenSizePerspectiveEnabled: boolean; /** * The spatial reference the source data is stored in. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#spatialReference) */ readonly spatialReference: SpatialReference; readonly type: "ogc-feature"; /** * The URL to the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#url) */ url: string; /** * The OGCFeatureLayer class is used to create a layer based on individual collections from a [OGC API Features](https://www.opengeospatial.org/standards/ogcapi-features) service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html) */ constructor(properties?: OGCFeatureLayerProperties); /** * Creates a popup template for the layer, populated with all the fields of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#createPopupTemplate) */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate; /** * Returns the [Field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) instance for a field name (case-insensitive). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#getField) */ getField(fieldName: string): Field; on(name: "refresh", eventHandler: OGCFeatureLayerRefreshEventHandler): IHandle; on(name: "layerview-create", eventHandler: OGCFeatureLayerLayerviewCreateEventHandler): IHandle; on(name: "layerview-create-error", eventHandler: OGCFeatureLayerLayerviewCreateErrorEventHandler): IHandle; on(name: "layerview-destroy", eventHandler: OGCFeatureLayerLayerviewDestroyEventHandler): IHandle; static fromJSON(json: any): OGCFeatureLayer; } interface OGCFeatureLayerProperties extends LayerProperties, APIKeyMixinProperties, BlendLayerProperties, CustomParametersMixinProperties, OperationalLayerProperties, OrderedLayerProperties, PortalLayerProperties, RefreshableLayerProperties, ScaleRangeLayerProperties, FeatureEffectLayerProperties, FeatureReductionLayerProperties { /** * The unique identifier of the collection on the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#collectionId) */ collectionId?: string; /** * Copyright information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#copyright) */ copyright?: string; /** * The name of the layer's primary display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#displayField) */ displayField?: string; /** * Specifies how features are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#elevationInfo) */ elevationInfo?: OGCFeatureLayerElevationInfo; /** * An array of fields in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#fields) */ fields?: FieldProperties[]; /** * The geometry type of features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#geometryType) */ geometryType?: "point" | "polygon" | "polyline" | "multipoint"; /** * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#labelingInfo) */ labelingInfo?: LabelClassProperties[]; /** * Indicates whether to display labels for this layer. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#labelsVisible) */ labelsVisible?: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#legendEnabled) */ legendEnabled?: boolean; /** * Explicitly set the maximum number of features that can be returned in a single request. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#maxRecordCount) */ maxRecordCount?: number; /** * The OGCFeatureLayer requires that each feature be uniquely identified with an object id. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#objectIdField) */ objectIdField?: string; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#popupEnabled) */ popupEnabled?: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#renderer) */ renderer?: RendererProperties; /** * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#screenSizePerspectiveEnabled) */ screenSizePerspectiveEnabled?: boolean; /** * The URL to the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#url) */ url?: string; } export interface OGCFeatureLayerLayerviewCreateErrorEvent { error: Error; view: View; } export interface OGCFeatureLayerLayerviewCreateEvent { layerView: LayerView; view: View; } export interface OGCFeatureLayerLayerviewDestroyEvent { layerView: LayerView; view: View; } export interface OGCFeatureLayerElevationInfo { /** * Defines how the feature is placed with respect to the terrain surface or 3D objects in the scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#elevationInfo) */ mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; /** * An elevation offset, which is added to the vertical position of the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#elevationInfo) */ offset?: number; /** * Defines how to override a feature's Z-value based on its attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#elevationInfo) */ featureExpressionInfo?: OGCFeatureLayerElevationInfoFeatureExpressionInfo; /** * The unit for `featureExpressionInfo` and `offset` values. * * [Read more...](global.html#unit) */ unit?: "feet" | "meters" | "kilometers" | "miles" | "us-feet" | "yards"; } export interface OGCFeatureLayerElevationInfoFeatureExpressionInfo { /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Feature Z Profile](https://developers.arcgis.com/javascript/latest/arcade/#z-values). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#elevationInfo) */ expression?: string; } export interface OGCFeatureLayerRefreshEvent { dataChanged: boolean; } export class OpenStreetMapLayer extends WebTileLayer { readonly type: "open-street-map"; /** * Allows you to use [basemaps](http://wiki.openstreetmap.org/wiki/List_of_OSM-based_services) from [OpenStreetMap](http://www.openstreetmap.org/). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OpenStreetMapLayer.html) */ constructor(properties?: OpenStreetMapLayerProperties); static fromJSON(json: any): OpenStreetMapLayer; } interface OpenStreetMapLayerProperties extends WebTileLayerProperties { } export interface OrientedImageryLayer extends Layer, BlendLayer, OrderedLayer, ScaleRangeLayer, FeatureEffectLayer, FeatureReductionLayer, OperationalLayer { } export class OrientedImageryLayer { /** * Camera orientation defining the first rotation around z-axis of the camera. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#cameraHeading) */ cameraHeading: number; /** * The height of camera above the ground when the imagery was captured. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#cameraHeight) */ cameraHeight: number; /** * Camera orientation defining the second rotation around x-axis of the camera in the positive counterclockwise direction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#cameraPitch) */ cameraPitch: number; /** * Camera orientation defining the final rotation around z-axis of the camera in the positive clockwise direction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#cameraRoll) */ cameraRoll: number; /** * Copyright information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#copyright) */ copyright: string; /** * Modifies the extent of the image's ground footprint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#coveragePercent) */ coveragePercent: number; /** * The SQL where clause used to filter features on the client. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#definitionExpression) */ definitionExpression: string; /** * Prefix used to build the DEM url path in conjunction with the [elevationSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#elevationSource) attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#demPathPrefix) */ demPathPrefix: string; /** * Suffix used to build the DEM url path in conjunction with the [elevationSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#elevationSource) attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#demPathSuffix) */ demPathSuffix: string; /** * Prefix used to build the depth image url path in conjunction with the depth image attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#depthImagePathPrefix) */ depthImagePathPrefix: string; /** * Suffix used to build the depth image url path in conjunction with the depth image attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#depthImagePathSuffix) */ depthImagePathSuffix: string; /** * The name of the layer's primary display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#displayField) */ displayField: string; /** * The source of elevation, that will be used to compute ground to image transformations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#elevationSource) */ elevationSource: ConstantElevation | ElevationSource; /** * The farthest usable distance of the imagery from the camera position. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#farDistance) */ farDistance: number; /** * An array of fields in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#fields) */ fields: Field[]; /** * The geometry type of features in the OrientedImageryLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#geometryType) */ geometryType: "point"; /** * The camera's scope in horizontal direction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#horizontalFieldOfView) */ horizontalFieldOfView: number; /** * Defines the unit that will be used for all horizontal measurements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#horizontalMeasurementUnit) */ horizontalMeasurementUnit: number; /** * Prefix used to build the image url path in conjunction with the image attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#imagePathPrefix) */ imagePathPrefix: string; /** * Suffix used to build the image url path in conjunction with the image attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#imagePathSuffix) */ imagePathSuffix: string; /** * The orientation of the camera in degrees relative to the scene when the image was captured. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#imageRotation) */ imageRotation: number; /** * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#labelingInfo) */ labelingInfo: LabelClass[]; /** * Indicates whether to display labels for this layer. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#labelsVisible) */ labelsVisible: boolean; /** * A unique id that identifies an operational layer in a map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#layerId) */ readonly layerId: string; /** * Maximum search distance to be used while querying the feature service specified in the Oriented Imagery Layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#maximumDistance) */ maximumDistance: number; /** * The nearest usable distance of the imagery from the camera position. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#nearDistance) */ nearDistance: number; /** * The name of an `oid` [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#fields) containing a unique value or identifier for each feature in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#objectIdField) */ objectIdField: string; /** * Semicolon-delimited string used to store standard deviation values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#orientationAccuracy) */ orientationAccuracy: number[]; /** * String that defines the imagery type used in the particular Oriented Imagery Layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#orientedImageryType) */ orientedImageryType: "horizontal" | "nadir" | "oblique" | "360" | "inspection"; /** * An array of field names to include in the OrientedImageryLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#outFields) */ outFields: string[]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#popupEnabled) */ popupEnabled: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * The portal item referencing the Oriented Imagery layer item from which the OrientedImageryLayer is loaded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#portalItem) */ portalItem: PortalItem; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#renderer) */ renderer: Renderer; /** * The spatial reference of the layer. * * @default SpatialReference.WGS84 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#spatialReference) */ spatialReference: SpatialReference; /** * Defines the unit of time used in the viewer's time selector tool. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#timeIntervalUnit) */ timeIntervalUnit: "days" | "hours" | "minutes" | "months" | "weeks" | "years"; /** * The layer type provides a convenient way to check the type of the layer without the need to import specific layer modules. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#type) */ readonly type: "oriented-imagery"; /** * The URL of the Oriented Imagery layer service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#url) */ url: string; /** * The camera's scope in the vertical direction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#verticalFieldOfView) */ verticalFieldOfView: number; /** * Defines the primary unit to be used for all vertical measurements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#verticalMeasurementUnit) */ verticalMeasurementUnit: "feet" | "meter"; /** * Prefix used to build the video url path in conjunction with the image attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#videoPathPrefix) */ videoPathPrefix: string; /** * Suffix used to build the video url path in conjunction with the image attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#videoPathSuffix) */ videoPathSuffix: string; /** * An Oriented Imagery Layer is a single spatial layer that can be created from a [Feature Service](https://enterprise.arcgis.com/en/server/latest/publish-services/windows/what-is-a-feature-service-.htm); or ArcGIS Online or ArcGIS Enterprise portal items. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html) */ constructor(properties?: OrientedImageryLayerProperties); /** * Creates query parameters that can be used to fetch features that satisfy the layer's current filters, and definitions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#createQuery) */ createQuery(): Query; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the Oriented Imagery features and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html), which can be accessed using the `.then()` method once the promise resolves. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#queryFeatures) */ queryFeatures(query?: Query | QueryProperties, options?: OrientedImageryLayerQueryFeaturesOptions): Promise; static fromJSON(json: any): OrientedImageryLayer; } interface OrientedImageryLayerProperties extends LayerProperties, BlendLayerProperties, OrderedLayerProperties, ScaleRangeLayerProperties, FeatureEffectLayerProperties, FeatureReductionLayerProperties, OperationalLayerProperties { /** * Camera orientation defining the first rotation around z-axis of the camera. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#cameraHeading) */ cameraHeading?: number; /** * The height of camera above the ground when the imagery was captured. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#cameraHeight) */ cameraHeight?: number; /** * Camera orientation defining the second rotation around x-axis of the camera in the positive counterclockwise direction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#cameraPitch) */ cameraPitch?: number; /** * Camera orientation defining the final rotation around z-axis of the camera in the positive clockwise direction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#cameraRoll) */ cameraRoll?: number; /** * Copyright information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#copyright) */ copyright?: string; /** * Modifies the extent of the image's ground footprint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#coveragePercent) */ coveragePercent?: number; /** * The SQL where clause used to filter features on the client. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#definitionExpression) */ definitionExpression?: string; /** * Prefix used to build the DEM url path in conjunction with the [elevationSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#elevationSource) attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#demPathPrefix) */ demPathPrefix?: string; /** * Suffix used to build the DEM url path in conjunction with the [elevationSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#elevationSource) attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#demPathSuffix) */ demPathSuffix?: string; /** * Prefix used to build the depth image url path in conjunction with the depth image attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#depthImagePathPrefix) */ depthImagePathPrefix?: string; /** * Suffix used to build the depth image url path in conjunction with the depth image attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#depthImagePathSuffix) */ depthImagePathSuffix?: string; /** * The name of the layer's primary display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#displayField) */ displayField?: string; /** * The source of elevation, that will be used to compute ground to image transformations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#elevationSource) */ elevationSource?: ConstantElevation | ElevationSource; /** * The farthest usable distance of the imagery from the camera position. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#farDistance) */ farDistance?: number; /** * An array of fields in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#fields) */ fields?: FieldProperties[]; /** * The geometry type of features in the OrientedImageryLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#geometryType) */ geometryType?: "point"; /** * The camera's scope in horizontal direction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#horizontalFieldOfView) */ horizontalFieldOfView?: number; /** * Defines the unit that will be used for all horizontal measurements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#horizontalMeasurementUnit) */ horizontalMeasurementUnit?: number; /** * Prefix used to build the image url path in conjunction with the image attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#imagePathPrefix) */ imagePathPrefix?: string; /** * Suffix used to build the image url path in conjunction with the image attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#imagePathSuffix) */ imagePathSuffix?: string; /** * The orientation of the camera in degrees relative to the scene when the image was captured. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#imageRotation) */ imageRotation?: number; /** * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#labelingInfo) */ labelingInfo?: LabelClassProperties[]; /** * Indicates whether to display labels for this layer. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#labelsVisible) */ labelsVisible?: boolean; /** * Maximum search distance to be used while querying the feature service specified in the Oriented Imagery Layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#maximumDistance) */ maximumDistance?: number; /** * The nearest usable distance of the imagery from the camera position. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#nearDistance) */ nearDistance?: number; /** * The name of an `oid` [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#fields) containing a unique value or identifier for each feature in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#objectIdField) */ objectIdField?: string; /** * Semicolon-delimited string used to store standard deviation values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#orientationAccuracy) */ orientationAccuracy?: number[]; /** * String that defines the imagery type used in the particular Oriented Imagery Layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#orientedImageryType) */ orientedImageryType?: "horizontal" | "nadir" | "oblique" | "360" | "inspection"; /** * An array of field names to include in the OrientedImageryLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#outFields) */ outFields?: string[]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#popupEnabled) */ popupEnabled?: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * The portal item referencing the Oriented Imagery layer item from which the OrientedImageryLayer is loaded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#portalItem) */ portalItem?: PortalItemProperties; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#renderer) */ renderer?: RendererProperties; /** * The spatial reference of the layer. * * @default SpatialReference.WGS84 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * Defines the unit of time used in the viewer's time selector tool. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#timeIntervalUnit) */ timeIntervalUnit?: "days" | "hours" | "minutes" | "months" | "weeks" | "years"; /** * The URL of the Oriented Imagery layer service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#url) */ url?: string; /** * The camera's scope in the vertical direction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#verticalFieldOfView) */ verticalFieldOfView?: number; /** * Defines the primary unit to be used for all vertical measurements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#verticalMeasurementUnit) */ verticalMeasurementUnit?: "feet" | "meter"; /** * Prefix used to build the video url path in conjunction with the image attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#videoPathPrefix) */ videoPathPrefix?: string; /** * Suffix used to build the video url path in conjunction with the image attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#videoPathSuffix) */ videoPathSuffix?: string; } /** * The unit of constant elevation value measured in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#ConstantElevation) */ export interface ConstantElevation { /** * The constant associated with the elevation source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#ConstantElevation) */ constantElevation: number; } /** * The elevation source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#ElevationSource) */ export interface ElevationSource { /** * The url of the elevation source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#ElevationSource) */ url: string; /** * The raster function used in the elevation source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#ElevationSource) */ rasterFunction: string; /** * The level of details (LODs) of the elevation source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#ElevationSource) */ lod: string; } export interface OrientedImageryLayerQueryFeaturesOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html#queryFeatures) */ signal?: AbortSignal; } export interface PointCloudFilter extends Accessor, JSONSupport { } export class PointCloudFilter { /** * The field used for applying the filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-pointCloudFilters-PointCloudFilter.html#field) */ field: string; /** * The type of filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-pointCloudFilters-PointCloudFilter.html#type) */ readonly type: "value" | "bitfield" | "return"; /** * Point cloud filters are used to hide points that do not satisfy the filter criteria. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-pointCloudFilters-PointCloudFilter.html) */ constructor(properties?: PointCloudFilterProperties); static fromJSON(json: any): PointCloudFilter; } interface PointCloudFilterProperties { /** * The field used for applying the filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-pointCloudFilters-PointCloudFilter.html#field) */ field?: string; } export class PointCloudReturnFilter extends PointCloudFilter { /** * An array of return types used to filter points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-pointCloudFilters-PointCloudReturnFilter.html#includedReturns) */ includedReturns: ("firstOfMany" | "last" | "lastOfMany" | "single")[]; readonly type: "return"; /** * Laser pulses emitted from a lidar system can have several returns depending on the surfaces that they encounter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-pointCloudFilters-PointCloudReturnFilter.html) */ constructor(properties?: PointCloudReturnFilterProperties); static fromJSON(json: any): PointCloudReturnFilter; } interface PointCloudReturnFilterProperties extends PointCloudFilterProperties { /** * An array of return types used to filter points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-pointCloudFilters-PointCloudReturnFilter.html#includedReturns) */ includedReturns?: ("firstOfMany" | "last" | "lastOfMany" | "single")[]; } export class PointCloudValueFilter extends PointCloudFilter { /** * Whether points should be included or excluded from the filter. * * @default "exclude" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-pointCloudFilters-PointCloudValueFilter.html#mode) */ mode: "include" | "exclude"; readonly type: "value"; /** * An array of numeric values representing the classification codes that the filter should apply. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-pointCloudFilters-PointCloudValueFilter.html#values) */ values: number[]; /** * Every lidar point can have a classification that defines the type of surface that reflected the laser pulse. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-pointCloudFilters-PointCloudValueFilter.html) */ constructor(properties?: PointCloudValueFilterProperties); static fromJSON(json: any): PointCloudValueFilter; } interface PointCloudValueFilterProperties extends PointCloudFilterProperties { /** * Whether points should be included or excluded from the filter. * * @default "exclude" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-pointCloudFilters-PointCloudValueFilter.html#mode) */ mode?: "include" | "exclude"; /** * An array of numeric values representing the classification codes that the filter should apply. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-pointCloudFilters-PointCloudValueFilter.html#values) */ values?: number[]; } export interface PointCloudLayer extends Layer, SceneService, PortalLayer, ScaleRangeLayer, CustomParametersMixin, APIKeyMixin, OperationalLayer { } export class PointCloudLayer { /** * Specifies how points are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#elevationInfo) */ elevationInfo: PointCloudLayerElevationInfo; /** * An array of fields accessible in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#fields) */ fields: Field[]; /** * A convenient property that can be used to make case-insensitive lookups for a field by name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#fieldsIndex) */ readonly fieldsIndex: FieldsIndex; /** * An array of [pointCloudFilters](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-pointCloudFilters-PointCloudFilter.html) used to filter points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#filters) */ filters: (PointCloudValueFilter | PointCloudReturnFilter)[]; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#legendEnabled) */ legendEnabled: boolean; /** * An array of field names from the service to include with each feature. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#outFields) */ outFields: string[]; /** * Indicates whether to display popups when points in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#popupEnabled) */ popupEnabled: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#renderer) */ renderer: PointCloudRenderer; readonly type: "point-cloud"; /** * The PointCloudLayer is designed for visualizing large collections of points in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html) */ constructor(properties?: PointCloudLayerProperties); /** * Creates a default popup template for the layer, populated with all the fields of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#createPopupTemplate) */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate; /** * Returns the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) associated with the given field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#getFieldDomain) */ getFieldDomain(fieldName: string): Domain; /** * Queries cached statistics from the service for a given field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#queryCachedStatistics) */ queryCachedStatistics(fieldName: string, options?: PointCloudLayerQueryCachedStatisticsOptions): any; static fromJSON(json: any): PointCloudLayer; } interface PointCloudLayerProperties extends LayerProperties, SceneServiceProperties, PortalLayerProperties, ScaleRangeLayerProperties, CustomParametersMixinProperties, APIKeyMixinProperties, OperationalLayerProperties { /** * Specifies how points are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#elevationInfo) */ elevationInfo?: PointCloudLayerElevationInfo; /** * An array of fields accessible in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#fields) */ fields?: FieldProperties[]; /** * An array of [pointCloudFilters](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-pointCloudFilters-PointCloudFilter.html) used to filter points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#filters) */ filters?: ( | (PointCloudValueFilterProperties & { type: "value" }) | (PointCloudReturnFilterProperties & { type: "return" }) )[]; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#legendEnabled) */ legendEnabled?: boolean; /** * An array of field names from the service to include with each feature. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#outFields) */ outFields?: string[]; /** * Indicates whether to display popups when points in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#popupEnabled) */ popupEnabled?: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#renderer) */ renderer?: PointCloudRendererProperties; } export interface PointCloudLayerElevationInfo { /** * Defines how the points are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#elevationInfo) */ mode: "absolute-height"; /** * An elevation offset, which is added to the vertical position of each point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#elevationInfo) */ offset?: number; /** * The unit for `offset` values. * * @default meters * * [Read more...](global.html#unit) */ unit?: "feet" | "meters" | "kilometers" | "miles" | "us-feet" | "yards"; } export interface PointCloudLayerQueryCachedStatisticsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#queryCachedStatistics) */ signal?: AbortSignal; } export interface RouteLayer extends Layer, BlendLayer, OperationalLayer, PortalLayer, ScaleRangeLayer { } export class RouteLayer { /** * The default symbol used for new stops and route results generated by [solve()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#solve). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#defaultSymbols) */ defaultSymbols: RouteSymbols; /** * A collection of [DirectionLine](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionLine.html) that represent the linear path between [directionPoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#directionPoints) of the solved route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#directionLines) */ readonly directionLines: Collection; /** * A collection of [DirectionPoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionPoint.html) that represent the turn-by-turn directions along a solved route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#directionPoints) */ readonly directionPoints: Collection; /** * A collection of [PointBarrier](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PointBarrier.html) are used to prevent navigation through the street network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#pointBarriers) */ pointBarriers: Collection; /** * A collection of [PolygonBarrier](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolygonBarrier.html) are used to prevent navigation through the street network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#polygonBarriers) */ polygonBarriers: Collection; /** * A collection of [PolylineBarrier](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolylineBarrier.html) are used to prevent navigation through the street network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#polylineBarriers) */ polylineBarriers: Collection; /** * This property contains the solved route's geometry and other route information like overall time and distance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#routeInfo) */ readonly routeInfo: RouteInfo; /** * A collection of [Stop](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html)s define the start, end, waypoint, or break of the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#stops) */ stops: Collection; readonly type: "route"; /** * The URL of the REST endpoint of the Route service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#url) */ url: string; /** * RouteLayer is a layer for visualizing and solving routes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html) */ constructor(properties?: RouteLayerProperties); /** * Update the currently assigned [portal item](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html) using information in this RouteLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#save) */ save(): Promise; /** * Saves the route layer to a new [portal item](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#saveAs) */ saveAs(portalItem: Promise, options?: RouteLayerSaveAsOptions): Promise; /** * This method will solve the route using the route service referenced by [routeServiceUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#routeServiceUrl) and the network objects [pointBarriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#pointBarriers), [polylineBarriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#polylineBarriers), [polygonBarriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#polygonBarriers), and [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#stops). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#solve) */ solve(routeParameters: RouteParameters, requestOptions?: any): Promise; /** * Updates the layer with the results from a solved route layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#update) */ update(routeLayerSolveResult: RouteLayerUpdateRouteLayerSolveResult): void; static fromJSON(json: any): RouteLayer; } interface RouteLayerProperties extends LayerProperties, BlendLayerProperties, OperationalLayerProperties, PortalLayerProperties, ScaleRangeLayerProperties { /** * The default symbol used for new stops and route results generated by [solve()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#solve). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#defaultSymbols) */ defaultSymbols?: RouteSymbolsProperties; /** * A collection of [PointBarrier](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PointBarrier.html) are used to prevent navigation through the street network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#pointBarriers) */ pointBarriers?: CollectionProperties; /** * A collection of [PolygonBarrier](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolygonBarrier.html) are used to prevent navigation through the street network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#polygonBarriers) */ polygonBarriers?: CollectionProperties; /** * A collection of [PolylineBarrier](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolylineBarrier.html) are used to prevent navigation through the street network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#polylineBarriers) */ polylineBarriers?: CollectionProperties; /** * A collection of [Stop](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html)s define the start, end, waypoint, or break of the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#stops) */ stops?: CollectionProperties; /** * The URL of the REST endpoint of the Route service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#url) */ url?: string; } export interface RouteLayerSaveAsOptions { /** * The folder in which to save the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#saveAs) */ folder?: PortalFolder; } /** * The results of computing a route and directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#RouteLayerSolveResult) */ export interface RouteLayerSolveResult { /** * Represents polyline segments associated with individual direction items. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#RouteLayerSolveResult) */ directionLines: Collection; /** * Represents direction items as points with various display information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#RouteLayerSolveResult) */ directionPoints: Collection; /** * Point barrier(s) to restrict travel along a street network when using a [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#RouteLayerSolveResult) */ pointBarriers?: Collection; /** * Polygon barrier(s) to restrict travel along a street network when using a [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#RouteLayerSolveResult) */ polygonBarriers?: Collection; /** * Polyline barrier(s) to restrict travel along a street network when using a [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#RouteLayerSolveResult) */ polylineBarriers?: Collection; /** * Contains information about a solved route including the routes geometry and overall distance and time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#RouteLayerSolveResult) */ routeInfo: RouteInfo; /** * Respresents the start, end, or midpoint of a route created using the [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#RouteLayerSolveResult) */ stops: Collection; } export interface RouteLayerUpdateRouteLayerSolveResult { /** * Collection of direction polylines associated with line segments between turns. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#update) */ directionLines: Collection; /** * Collection of direction items as points with various display information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#update) */ directionPoints: Collection; /** * Collection of point barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#update) */ readPointBarriers: Collection; /** * Collection of polygon barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#update) */ polygonBarriers: Collection; /** * Collection of polyline barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#update) */ polylineBarriers: Collection; /** * Information about a solved route including the routes geometry and overall distance and time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#update) */ routeInfo: RouteInfo; /** * Collection of stops. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#update) */ stops: Collection; } export interface SceneLayer extends Layer, SceneService, PortalLayer, ScaleRangeLayer, TemporalSceneLayer, CustomParametersMixin, APIKeyMixin, Clonable { } export class SceneLayer { /** * Describes the layer's supported capabilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#capabilities) */ readonly capabilities: SceneLayerCapabilities; /** * The SQL where clause used to filter features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#definitionExpression) */ definitionExpression: string; /** * Describes effective capabilities of the layer taking in to consideration privileges of the currently signed-in user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#effectiveCapabilities) */ readonly effectiveCapabilities: SceneLayerCapabilities; /** * Specifies how features are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#elevationInfo) */ elevationInfo: SceneLayerElevationInfo; /** * List of ObjectIDs not being displayed in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#excludeObjectIds) */ excludeObjectIds: Collection; /** * Configures the method for decluttering overlapping features in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#featureReduction) */ featureReduction: FeatureReductionSelection; /** * An array of fields accessible in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#fields) */ readonly fields: Field[]; /** * A convenient property that can be used to make case-insensitive lookups for a field by name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#fieldsIndex) */ readonly fieldsIndex: FieldsIndex; /** * A collection of polygons [geometries](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SceneFilter.html#geometries) which will mask out different parts of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#filter) */ filter: SceneFilter; /** * When a scene layer is configured as floor-aware, it has a floorInfo property defined. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#floorInfo) */ floorInfo: LayerFloorInfo; /** * The geometry type of features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#geometryType) */ geometryType: "point" | "mesh"; /** * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#labelingInfo) */ labelingInfo: LabelClass[]; /** * Indicates whether to display labels for this layer. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#labelsVisible) */ labelsVisible: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#legendEnabled) */ legendEnabled: boolean; /** * The name of the field containing each graphic's Object ID. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#objectIdField) */ objectIdField: string; /** * An array of field names from the service to include with each feature. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#outFields) */ outFields: string[]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#popupEnabled) */ popupEnabled: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * Array of [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html) set up for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#relationships) */ readonly relationships: Relationship[]; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#renderer) */ renderer: Renderer; /** * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#screenSizePerspectiveEnabled) */ screenSizePerspectiveEnabled: boolean; readonly type: "scene"; /** * The SceneLayer is a layer type designed for on-demand streaming and displaying large amounts of data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) */ constructor(properties?: SceneLayerProperties); /** * Applies edits to the features in the associated [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#applyEdits) */ applyEdits(edits: SceneLayerApplyEditsEdits, options?: SceneLayerApplyEditsOptions): Promise; /** * Converts a file or list of files to mesh geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#convertMesh) */ convertMesh(files: any[], options?: ConvertMeshOptions): Promise; /** * Creates a default popup template for the layer, populated with all the fields of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#createPopupTemplate) */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate; /** * Creates a query object that can be used to fetch features that satisfy the layer's current definition expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#createQuery) */ createQuery(): Query; /** * Returns the [Field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) instance for a field name (case-insensitive). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#getField) */ getField(fieldName: string): Field; /** * Returns the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) associated with the given field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#getFieldDomain) */ getFieldDomain(fieldName: string, options?: SceneLayerGetFieldDomainOptions): Domain; /** * Gets field usage information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#getFieldUsageInfo) */ getFieldUsageInfo(fieldName: string): any; /** * Query information about attachments associated with features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryAttachments) */ queryAttachments(attachmentQuery: AttachmentQuery | AttachmentQueryProperties, options?: SceneLayerQueryAttachmentsOptions): Promise; /** * Queries cached statistics from the service for a given field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryCachedStatistics) */ queryCachedStatistics(fieldName: string, options?: SceneLayerQueryCachedStatisticsOptions): any; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the associated feature service and returns the 2D [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. * * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the associated feature service and returns the 2D [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. At the moment the 3D Extent can be returned by using [SceneLayerView.queryExtent()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#queryExtent), but this will return the 3D extent only for features currently in the view. The query succeeds only if the SceneLayer has an associated feature layer. If an associated feature layer is not available, then an error with the name `scenelayer:query-not-available` is thrown. Read more about queries in the [Querying](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#querying) section of the class description above. [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryExtent) */ queryExtent(query?: Query | QueryProperties, options?: SceneLayerQueryExtentOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the associated feature service and returns the number of features that satisfy the query. * * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the associated feature service and returns the number of features that satisfy the query. The query succeeds only if the layer's `supportsLayerQuery` capability is enabled. Use the [getFieldUsageInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#getFieldUsageInfo) method to check if the layer supports queries. If querying is not enabled, then an error with the name `scenelayer:query-not-available` is thrown. Read more about queries in the [Querying](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#querying) section of the class description above. [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryFeatureCount) */ queryFeatureCount(query?: Query | QueryProperties, options?: SceneLayerQueryFeatureCountOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the associated feature service and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html). * * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the associated feature service and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html). The query succeeds only if the layer's `supportsLayerQuery` capability is enabled. Use the [getFieldUsageInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#getFieldUsageInfo) method to check if the layer supports queries. If querying is not enabled, then an error with the name `scenelayer:query-not-available` is thrown. Read more about queries in the [Querying](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#querying) section of the class description above. [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryFeatures) */ queryFeatures(query?: Query | QueryProperties, options?: SceneLayerQueryFeaturesOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the associated feature service and returns an array of ObjectIDs of the features that satisfy the input query. * * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the associated feature service and returns an array of ObjectIDs of the features that satisfy the input query. The query succeeds only if the layer's `supportsLayerQuery` capability is enabled. Use the [getFieldUsageInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#getFieldUsageInfo) method to check if the layer supports queries. If querying is not enabled, then an error with the name `scenelayer:query-not-available` is thrown. Read more about queries in the [Querying](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#querying) section of the class description above. [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryObjectIds) */ queryObjectIds(query?: Query | QueryProperties, options?: SceneLayerQueryObjectIdsOptions): Promise; /** * Executes a [RelationshipQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html) against the feature service associated with the scene layer and returns [FeatureSets](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html) grouped by source layer or table objectIds. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryRelatedFeatures) */ queryRelatedFeatures(relationshipQuery: RelationshipQuery | RelationshipQueryProperties, options?: SceneLayerQueryRelatedFeaturesOptions): Promise; /** * Executes a [RelationshipQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html) against the feature service associated with the scene layer and when resolved, it returns an `object` containing key value pairs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryRelatedFeaturesCount) */ queryRelatedFeaturesCount(relationshipQuery: RelationshipQuery | RelationshipQueryProperties, options?: SceneLayerQueryRelatedFeaturesCountOptions): Promise; on(name: "edits", eventHandler: SceneLayerEditsEventHandler): IHandle; on(name: "layerview-create", eventHandler: SceneLayerLayerviewCreateEventHandler): IHandle; on(name: "layerview-create-error", eventHandler: SceneLayerLayerviewCreateErrorEventHandler): IHandle; on(name: "layerview-destroy", eventHandler: SceneLayerLayerviewDestroyEventHandler): IHandle; static fromJSON(json: any): SceneLayer; } interface SceneLayerProperties extends LayerProperties, SceneServiceProperties, PortalLayerProperties, ScaleRangeLayerProperties, CustomParametersMixinProperties, APIKeyMixinProperties { /** * The SQL where clause used to filter features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#definitionExpression) */ definitionExpression?: string; /** * Specifies how features are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#elevationInfo) */ elevationInfo?: SceneLayerElevationInfo; /** * List of ObjectIDs not being displayed in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#excludeObjectIds) */ excludeObjectIds?: CollectionProperties; /** * Configures the method for decluttering overlapping features in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#featureReduction) */ featureReduction?: FeatureReductionSelectionProperties; /** * A collection of polygons [geometries](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SceneFilter.html#geometries) which will mask out different parts of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#filter) */ filter?: SceneFilterProperties; /** * When a scene layer is configured as floor-aware, it has a floorInfo property defined. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#floorInfo) */ floorInfo?: LayerFloorInfoProperties; /** * The geometry type of features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#geometryType) */ geometryType?: "point" | "mesh"; /** * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#labelingInfo) */ labelingInfo?: LabelClassProperties[]; /** * Indicates whether to display labels for this layer. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#labelsVisible) */ labelsVisible?: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#legendEnabled) */ legendEnabled?: boolean; /** * The name of the field containing each graphic's Object ID. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#objectIdField) */ objectIdField?: string; /** * An array of field names from the service to include with each feature. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#outFields) */ outFields?: string[]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#popupEnabled) */ popupEnabled?: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#renderer) */ renderer?: RendererProperties; /** * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#screenSizePerspectiveEnabled) */ screenSizePerspectiveEnabled?: boolean; } /** * Describes the layer's supported capabilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ export interface SceneLayerCapabilities { /** * Describes [query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) operations that can be performed on features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ query: SceneLayerCapabilitiesQuery; /** * Indicates if the layer's query operation supports querying features or records related to features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ queryRelated: SceneLayerCapabilitiesQueryRelated; /** * Describes characteristics of the data in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ data: SceneLayerCapabilitiesData; /** * Describes editing capabilities that can be performed on the features in the layer via [applyEdits()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#applyEdits). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ editing: SceneLayerCapabilitiesEditing; /** * Describes operations that can be performed on features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ operations: SceneLayerCapabilitiesOperations; } /** * Options used to configure mesh conversion. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#ConvertMeshOptions) */ export interface ConvertMeshOptions { /** * The location of the origin of the model. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#ConvertMeshOptions) */ location?: Point; /** * An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to abort the loading process. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#ConvertMeshOptions) */ signal?: AbortSignal; } export interface SceneLayerEditsEvent { addedFeatures: FeatureEditResult[]; deletedFeatures: FeatureEditResult[]; exceededTransferLimit: boolean; updatedFeatures: FeatureEditResult[]; } /** * Results returned from the [applyEdits](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#applyEdits) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#EditsResult) */ export interface SceneLayerEditsResult { /** * Result of adding features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#EditsResult) */ addFeatureResults: FeatureEditResult[]; /** * Result of updating features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#EditsResult) */ updateFeatureResults: FeatureEditResult[]; /** * Result of deleting features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#EditsResult) */ deleteFeatureResults: FeatureEditResult[]; } /** * Alternative representation of features to be deleted with applyEdits. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#FeatureIdentifier) */ export interface FeatureIdentifier { /** * The objectId of the feature to be deleted. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#FeatureIdentifier) */ objectId: number | any; /** * The globalId of the feature to be deleted. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#FeatureIdentifier) */ globalId: string | any; } export interface SceneLayerLayerviewCreateErrorEvent { error: Error; view: View; } export interface SceneLayerLayerviewCreateEvent { layerView: LayerView; view: View; } export interface SceneLayerLayerviewDestroyEvent { layerView: LayerView; view: View; } export interface SceneLayerApplyEditsEdits { /** * An array or a [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of features to be added. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#applyEdits) */ addFeatures?: Graphic[] | Collection; /** * An array or a [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of features to be updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#applyEdits) */ updateFeatures?: Graphic[] | Collection; /** * An array or a [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of features, or an array of objects with [globalId](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#globalIdField) of each feature to be deleted. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#applyEdits) */ deleteFeatures?: Graphic[] | Collection | FeatureIdentifier[]; } export interface SceneLayerApplyEditsOptions { /** * Indicates whether the edits should be applied only if all submitted edits succeed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#applyEdits) */ rollbackOnFailureEnabled?: boolean; /** * Indicates whether the edits can be applied using globalIds of features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#applyEdits) */ globalIdUsed?: boolean; } export interface SceneLayerElevationInfo { /** * Defines how the feature is placed with respect to the terrain surface. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#elevationInfo) */ mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; /** * An elevation offset which is added to the vertical position of the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#elevationInfo) */ offset?: number; /** * The unit for `offset` values. * * @default meters * * [Read more...](global.html#unit) */ unit?: "feet" | "meters" | "kilometers" | "miles" | "us-feet" | "yards"; } export interface SceneLayerGetFieldDomainOptions { /** * The feature to which the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) is assigned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#getFieldDomain) */ feature: Graphic; } export interface SceneLayerQueryAttachmentsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryAttachments) */ signal?: AbortSignal; } export interface SceneLayerQueryCachedStatisticsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryCachedStatistics) */ signal?: AbortSignal; } export interface SceneLayerQueryExtentOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryExtent) */ signal?: AbortSignal; } export interface SceneLayerQueryFeatureCountOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryFeatureCount) */ signal?: AbortSignal; } export interface SceneLayerQueryFeaturesOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryFeatures) */ signal?: AbortSignal; } export interface SceneLayerQueryObjectIdsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryObjectIds) */ signal?: AbortSignal; } export interface SceneLayerQueryRelatedFeaturesCountOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryRelatedFeaturesCount) */ signal?: AbortSignal; } export interface SceneLayerQueryRelatedFeaturesOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryRelatedFeatures) */ signal?: AbortSignal; } export interface SceneLayerCapabilitiesData { /** * Indicates if the features in the layer support z-values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsZ: boolean; /** * Indicates if the attachment is enabled on the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsAttachment: boolean; } export interface SceneLayerCapabilitiesEditing { /** * Indicates if the geometry of the features in the layer can be edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsGeometryUpdate: boolean; /** * Indicates if the `globalId` values provided by the client are used in [applyEdits](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#applyEdits). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsGlobalId: boolean; /** * Indicates if the `rollbackOnFailureEnabled` parameter can be set to `true` or `false` when editing features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsRollbackOnFailure: boolean; } export interface SceneLayerCapabilitiesOperations { /** * Indicates if new features can be [added](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#applyEdits) to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsAdd: boolean; /** * Indicates if features can be [deleted](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#applyEdits) from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsDelete: boolean; /** * Indicates if features in the layer can be [updated](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#applyEdits). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsUpdate: boolean; /** * Indicates if features in the layer can be [edited](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#applyEdits). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsEditing: boolean; /** * Indicates if features in the layer can be [queried](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryFeatures). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsQuery: boolean; /** * Indicates if the layer supports [REST API queryAttachments](https://developers.arcgis.com/rest/services-reference/query-attachments-feature-service-layer-.htm) operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsQueryAttachments: boolean; } export interface SceneLayerCapabilitiesQuery { /** * The maximum number of records that will be returned for a given query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ maxRecordCount: number; /** * Indicates if the geometry centroid associated with each polygon feature can be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsCentroid: boolean; /** * Indicates if the layer's query operation supports a buffer distance for input geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsDistance: boolean; /** * Indicates if the layer supports queries for distinct values based on fields specified in the [outFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#outFields). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsDistinct: boolean; /** * Indicates if the query operation supports `disjoint` [spatial relationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#spatialRelationship). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsDisjointSpatialRelationship: boolean; /** * Indicates if the query operation supports a [cache hint](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#cacheHint). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsCacheHint: boolean; /** * Indicates if the layer's query response includes the extent of features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsExtent: boolean; /** * Indicates if the layer's query response contains geometry attributes, including shape area and length attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsGeometryProperties: boolean; /** * Indicates if the layer supports the [having](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#having) clause on the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsHavingClause: boolean; /** * Indicates if features returned in the query response can be ordered by one or more fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsOrderBy: boolean; /** * Indicates if the query response supports pagination. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsPagination: boolean; /** * Indicates if the layer supports [percentile statisticType](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-StatisticDefinition.html#statisticType). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsPercentileStatistics: boolean; /** * Indicates if the query response includes the [query geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html#queryGeometry). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsQueryGeometry: boolean; /** * Indicates if the query operation supports the projection of geometries onto a virtual grid. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsQuantization: boolean; /** * Indicates if the query operation supports quantization designed to be used in edit mode (highest resolution at the given spatial reference). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsQuantizationEditMode: boolean; /** * Indicates if the number of features returned by the query operation can be controlled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsResultType: boolean; /** * Indicates if the query operation supports SQL expressions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsSqlExpression: boolean; /** * Indicates if the query operation supports using standardized queries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsStandardizedQueriesOnly: boolean; /** * Indicates if the layer supports field-based statistical functions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsStatistics: boolean; /** * Indicates if the layer supports historic moment query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsHistoricMoment: boolean; } export interface SceneLayerCapabilitiesQueryRelated { /** * Indicates if the [relationship query operation](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html) supports a cache hint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsCacheHint: boolean; /** * Indicates if the layer's query response includes the number of features or records related to features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsCount: boolean; /** * Indicates if the related features or records returned in the query response can be ordered by one or more fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsOrderBy: boolean; /** * Indicates if the query response supports pagination for related features or records. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#Capabilities) */ supportsPagination: boolean; } export interface StreamLayer extends Layer, ScaleRangeLayer, TemporalLayer, BlendLayer, FeatureEffectLayer, FeatureReductionLayer, OperationalLayer, Clonable { } export class StreamLayer { /** * Copyright information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#copyright) */ copyright: string; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#customParameters) */ customParameters: any; /** * The SQL where clause used to filter features based on their attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#definitionExpression) */ definitionExpression: string; /** * The name of the layer's primary display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#displayField) */ displayField: string; /** * Specifies how features are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#elevationInfo) */ elevationInfo: StreamLayerElevationInfo; /** * An array of fields in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#fields) */ fields: Field[]; /** * A convenient property that can be used to make case-insensitive lookups for a field by name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#fieldsIndex) */ readonly fieldsIndex: FieldsIndex; /** * An [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) object used to filter features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#geometryDefinition) */ geometryDefinition: Extent; /** * The geometry type of features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#geometryType) */ geometryType: "point" | "polygon" | "polyline" | "multipoint"; /** * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#labelingInfo) */ labelingInfo: LabelClass[]; /** * Indicates whether to display labels for this layer. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#labelsVisible) */ labelsVisible: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#legendEnabled) */ legendEnabled: boolean; /** * The maximum number of attempts to reconnect. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#maxReconnectionAttempts) */ maxReconnectionAttempts: number; /** * The maximum time to wait in seconds between attempts to reconnect. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#maxReconnectionInterval) */ maxReconnectionInterval: number; /** * The name of an `oid` [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#fields) containing a unique value or identifier for each feature in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#objectIdField) */ objectIdField: string; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#popupEnabled) */ popupEnabled: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * Options for purging stale features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#purgeOptions) */ purgeOptions: StreamLayerPurgeOptions; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#renderer) */ renderer: Renderer; /** * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#screenSizePerspectiveEnabled) */ screenSizePerspectiveEnabled: boolean; /** * The [stream service's metadata JSON](https://developers.arcgis.com/rest/services-reference/stream-service.htm) exposed by the ArcGIS REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#sourceJSON) */ sourceJSON: any; /** * The spatial reference of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#spatialReference) */ spatialReference: SpatialReference; /** * For [StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html) the type is `stream`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#type) */ readonly type: "stream"; /** * The minimum rate (ms) at which to poll for updates over the websocket connection. * * @default 300 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#updateInterval) */ updateInterval: number; /** * The URL of the stream service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#url) */ url: string; /** * The URL of a websocket connection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#webSocketUrl) */ webSocketUrl: string; /** * StreamLayer connects to a [stream service](https://enterprise.arcgis.com/en/geoevent) or a [custom WebSocket service](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#streamlayer-from-websocket), displaying the observation streams associated with a set of [tracked objects](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#track-aware) in real-time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html) */ constructor(properties?: StreamLayerProperties); /** * Establishes a connection to a web socket that satisfy the specified connection parameters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#connect) */ connect(parameters?: ConnectionParameters): Promise; /** * Creates a [ConnectionParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#ConnectionParameters) object that can be used to establish a connection to a web socket that satisfies the layer's configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#createConnectionParameters) */ createConnectionParameters(): ConnectionParameters; /** * Creates a popup template for the layer, populated with all the fields of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#createPopupTemplate) */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate; /** * Returns the [Field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) instance for a field name (case-insensitive). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#getField) */ getField(fieldName: string): Field; /** * Returns the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) associated with the given field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#getFieldDomain) */ getFieldDomain(fieldName: string, options?: StreamLayerGetFieldDomainOptions): Domain; /** * Saves the layer to its existing portal item in the [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html) authenticated within the user's current session. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#save) */ save(options?: StreamLayerSaveOptions): Promise; /** * Saves the layer to a new portal item in the [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html) authenticated within the user's current session. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#saveAs) */ saveAs(portalItem: PortalItem | PortalItemProperties, options?: StreamLayerSaveAsOptions): Promise; /** * Sends client-side only messages. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#sendMessageToClient) */ sendMessageToClient(message: any): void; /** * Sends a message over the websocket to the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#sendMessageToSocket) */ sendMessageToSocket(message: any): void; static fromJSON(json: any): StreamLayer; } interface StreamLayerProperties extends LayerProperties, ScaleRangeLayerProperties, TemporalLayerProperties, BlendLayerProperties, FeatureEffectLayerProperties, FeatureReductionLayerProperties, OperationalLayerProperties { /** * Copyright information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#copyright) */ copyright?: string; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#customParameters) */ customParameters?: any; /** * The SQL where clause used to filter features based on their attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#definitionExpression) */ definitionExpression?: string; /** * The name of the layer's primary display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#displayField) */ displayField?: string; /** * Specifies how features are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#elevationInfo) */ elevationInfo?: StreamLayerElevationInfo; /** * An array of fields in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#fields) */ fields?: FieldProperties[]; /** * An [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) object used to filter features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#geometryDefinition) */ geometryDefinition?: ExtentProperties; /** * The geometry type of features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#geometryType) */ geometryType?: "point" | "polygon" | "polyline" | "multipoint"; /** * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#labelingInfo) */ labelingInfo?: LabelClassProperties[]; /** * Indicates whether to display labels for this layer. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#labelsVisible) */ labelsVisible?: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#legendEnabled) */ legendEnabled?: boolean; /** * The maximum number of attempts to reconnect. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#maxReconnectionAttempts) */ maxReconnectionAttempts?: number; /** * The maximum time to wait in seconds between attempts to reconnect. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#maxReconnectionInterval) */ maxReconnectionInterval?: number; /** * The name of an `oid` [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#fields) containing a unique value or identifier for each feature in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#objectIdField) */ objectIdField?: string; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#popupEnabled) */ popupEnabled?: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * Options for purging stale features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#purgeOptions) */ purgeOptions?: StreamLayerPurgeOptions; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#renderer) */ renderer?: RendererProperties; /** * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#screenSizePerspectiveEnabled) */ screenSizePerspectiveEnabled?: boolean; /** * The [stream service's metadata JSON](https://developers.arcgis.com/rest/services-reference/stream-service.htm) exposed by the ArcGIS REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#sourceJSON) */ sourceJSON?: any; /** * The spatial reference of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * The minimum rate (ms) at which to poll for updates over the websocket connection. * * @default 300 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#updateInterval) */ updateInterval?: number; /** * The URL of the stream service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#url) */ url?: string; /** * The URL of a websocket connection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#webSocketUrl) */ webSocketUrl?: string; } /** * The connection parameters that can be used to establish a connection to a web socket when the [connect()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#connect) method is called. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#ConnectionParameters) */ export interface ConnectionParameters { /** * The spatial reference of the geometries emitted by the connection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#ConnectionParameters) */ spatialReference?: string; /** * A list of custom parameters appended to the URL of the stream service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#ConnectionParameters) */ customParameters?: any; /** * The SQL where clause used to filter features based on their attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#ConnectionParameters) */ definitionExpression?: string; /** * An [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) object used to filter features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#ConnectionParameters) */ geometryDefinition?: Extent; /** * The maximum number of attempts to reconnect. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#ConnectionParameters) */ maxReconnectionAttempts?: number; /** * The maximum time to wait in seconds between attempts to reconnect. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#ConnectionParameters) */ maxReconnectionInterval?: number; } export interface StreamLayerElevationInfo { /** * Defines how the feature is placed with respect to the terrain surface or 3D objects in the scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#elevationInfo) */ mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; /** * An elevation offset, which is added to the vertical position of the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#elevationInfo) */ offset?: number; /** * Defines how to override a feature's Z-value based on its attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#elevationInfo) */ featureExpressionInfo?: StreamLayerElevationInfoFeatureExpressionInfo; /** * The unit for `featureExpressionInfo` and `offset` values. * * [Read more...](global.html#unit) */ unit?: "feet" | "meters" | "kilometers" | "miles" | "us-feet" | "yards"; } export interface StreamLayerElevationInfoFeatureExpressionInfo { /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Feature Z Profile](https://developers.arcgis.com/javascript/latest/arcade/#z-values). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#elevationInfo) */ expression?: string; } export interface StreamLayerGetFieldDomainOptions { /** * The feature to which the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) is assigned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#getFieldDomain) */ feature: Graphic; } export interface StreamLayerPurgeOptions { /** * Specifies the maximum age of a feature in minutes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#purgeOptions) */ age?: number; /** * Specifies the maximum age of a feature in minutes since it arrived in the application. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#purgeOptions) */ ageReceived?: number; /** * Controls the overall maximum number of features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#purgeOptions) */ displayCount?: number; /** * Controls the maximum number of observations to show within a [track](https://enterprise.arcgis.com/en/geoevent/latest/get-started/essential-geoevent-server-vocabulary.htm#ESRI_SECTION1_F45BBCE9ADFA4E57AF38DD225921EFCD). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#purgeOptions) */ maxObservations?: number; } export interface StreamLayerSaveAsOptions { /** * The portal folder where the layer's portal item will be saved. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#saveAs) */ folder?: PortalFolder; /** * Options for validating the save operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#saveAs) */ validationOptions?: StreamLayerSaveAsOptionsValidationOptions; } export interface StreamLayerSaveAsOptionsValidationOptions { /** * Indicates whether to ignore saving unsupported layers or layers with unsupported content, such as unsupported symbology. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#saveAs) */ ignoreUnsupported?: boolean; } export interface StreamLayerSaveOptions { /** * Options for validating the save operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#save) */ validationOptions?: StreamLayerSaveOptionsValidationOptions; } export interface StreamLayerSaveOptionsValidationOptions { /** * Indicates whether to ignore saving unsupported layers or layers with unsupported content, such as unsupported symbology. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#save) */ ignoreUnsupported?: boolean; } export interface SubtypeGroupLayer extends Layer, PortalLayer, ScaleRangeLayer, RefreshableLayer, TemporalLayer, BlendLayer, CustomParametersMixin, FeatureLayerBase, OperationalLayer, Clonable { } export class SubtypeGroupLayer { /** * Determines if the layer is editable. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html#editingEnabled) */ editingEnabled: boolean; /** * An array of fields in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html#fields) */ fields: Field[]; /** * An array of field names from the service to include with each feature. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html#outFields) */ outFields: string[]; /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [SubtypeSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html) objects that allow you to alter the properties of one or more sublayers of the SubtypeGroupLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html#sublayers) */ sublayers: Collection; readonly type: "subtype-group"; /** * The SubtypeGroupLayer is a single layer that automatically creates a [SubtypeSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html) for each subtype in its corresponding [feature service](https://enterprise.arcgis.com/en/server/latest/publish-services/windows/what-is-a-feature-service-.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html) */ constructor(properties?: SubtypeGroupLayerProperties); /** * Creates query parameter object that can be used to fetch features that satisfy the layer's configurations such as [definitionExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html#definitionExpression), [gdbVersion](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html#gdbVersion), and [historicMoment](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html#historicMoment). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html#createQuery) */ createQuery(): Query; /** * Returns the sublayer to which the given feature belongs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html#findSublayerForFeature) */ findSublayerForFeature(feature: Graphic): SubtypeSublayer; /** * Returns the sublayer with the [subtypeCode](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#subtypeCode) that matches the number passed as an argument. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html#findSublayerForSubtypeCode) */ findSublayerForSubtypeCode(subtypeCode: number): SubtypeSublayer; /** * Loads all of the sublayers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html#loadAll) */ loadAll(): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the feature service and returns the [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html#queryExtent) */ queryExtent(query?: Query | QueryProperties, options?: SubtypeGroupLayerQueryExtentOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the feature service and returns the number of features that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html#queryFeatureCount) */ queryFeatureCount(query?: Query | QueryProperties, options?: SubtypeGroupLayerQueryFeatureCountOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the feature service and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html), which can be accessed using the `.then()` method once the promise resolves. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html#queryFeatures) */ queryFeatures(query?: Query | QueryProperties, options?: SubtypeGroupLayerQueryFeaturesOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the feature service and returns an array of Object IDs for features that satisfy the input query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html#queryObjectIds) */ queryObjectIds(query?: Query | QueryProperties, options?: SubtypeGroupLayerQueryObjectIdsOptions): Promise; on(name: "refresh", eventHandler: SubtypeGroupLayerRefreshEventHandler): IHandle; on(name: "edits", eventHandler: SubtypeGroupLayerEditsEventHandler): IHandle; on(name: "layerview-create", eventHandler: SubtypeGroupLayerLayerviewCreateEventHandler): IHandle; on(name: "layerview-create-error", eventHandler: SubtypeGroupLayerLayerviewCreateErrorEventHandler): IHandle; on(name: "layerview-destroy", eventHandler: SubtypeGroupLayerLayerviewDestroyEventHandler): IHandle; static fromJSON(json: any): SubtypeGroupLayer; } interface SubtypeGroupLayerProperties extends LayerProperties, PortalLayerProperties, ScaleRangeLayerProperties, RefreshableLayerProperties, TemporalLayerProperties, BlendLayerProperties, CustomParametersMixinProperties, FeatureLayerBaseProperties, OperationalLayerProperties { /** * Determines if the layer is editable. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html#editingEnabled) */ editingEnabled?: boolean; /** * An array of fields in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html#fields) */ fields?: FieldProperties[]; /** * An array of field names from the service to include with each feature. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html#outFields) */ outFields?: string[]; /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [SubtypeSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html) objects that allow you to alter the properties of one or more sublayers of the SubtypeGroupLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html#sublayers) */ sublayers?: CollectionProperties; } export interface SubtypeGroupLayerEditsEvent { addedAttachments: FeatureEditResult[]; addedFeatures: FeatureEditResult[]; deletedAttachments: FeatureEditResult[]; deletedFeatures: FeatureEditResult[]; updatedAttachments: FeatureEditResult[]; updatedFeatures: FeatureEditResult[]; } export interface SubtypeGroupLayerLayerviewCreateErrorEvent { error: Error; view: View; } export interface SubtypeGroupLayerLayerviewCreateEvent { layerView: LayerView; view: View; } export interface SubtypeGroupLayerLayerviewDestroyEvent { layerView: LayerView; view: View; } export interface SubtypeGroupLayerRefreshEvent { dataChanged: boolean; } export interface SubtypeGroupLayerQueryExtentOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html#queryExtent) */ signal?: AbortSignal; } export interface SubtypeGroupLayerQueryFeatureCountOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html#queryFeatureCount) */ signal?: AbortSignal; } export interface SubtypeGroupLayerQueryFeaturesOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html#queryFeatures) */ signal?: AbortSignal; } export interface SubtypeGroupLayerQueryObjectIdsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html#queryObjectIds) */ signal?: AbortSignal; } export interface AggregateField extends Accessor, JSONSupport { } export class AggregateField { /** * The display name that describes the aggregate field in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html), [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html), and other UI elements. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#alias) */ alias: string; /** * Indicates whether the field was created internally by the JS API's rendering engine for default [FeatureReductionCluster](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html) visualizations. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#isAutoGenerated) */ isAutoGenerated: boolean; /** * The name of the aggregate field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#name) */ name: string; /** * An object containing an [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression, which evaluates for each child feature represented by the aggregate graphic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#onStatisticExpression) */ onStatisticExpression: supportExpressionInfo; /** * The name of the [layer field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#fields) to summarize with the given [statisticType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#statisticType). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#onStatisticField) */ onStatisticField: string; /** * Defines the type of statistic used to aggregate data returned from [onStatisticField](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#onStatisticField) or [onStatisticExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#onStatisticExpression). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#statisticType) */ statisticType: "avg" | "count" | "max" | "min" | "mode" | "sum"; /** * Defines the aggregate fields used in a layer visualized with [FeatureReductionBinning](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html) or [FeatureReductionCluster](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html) */ constructor(properties?: AggregateFieldProperties); /** * Creates a deep clone of the AggregateField object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#clone) */ clone(): AggregateField; static fromJSON(json: any): AggregateField; } interface AggregateFieldProperties { /** * The display name that describes the aggregate field in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html), [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html), and other UI elements. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#alias) */ alias?: string; /** * Indicates whether the field was created internally by the JS API's rendering engine for default [FeatureReductionCluster](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html) visualizations. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#isAutoGenerated) */ isAutoGenerated?: boolean; /** * The name of the aggregate field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#name) */ name?: string; /** * An object containing an [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression, which evaluates for each child feature represented by the aggregate graphic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#onStatisticExpression) */ onStatisticExpression?: supportExpressionInfoProperties; /** * The name of the [layer field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#fields) to summarize with the given [statisticType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#statisticType). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#onStatisticField) */ onStatisticField?: string; /** * Defines the type of statistic used to aggregate data returned from [onStatisticField](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#onStatisticField) or [onStatisticExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#onStatisticExpression). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#statisticType) */ statisticType?: "avg" | "count" | "max" | "min" | "mode" | "sum"; } /** * Contains convenience methods for getting Arcade expressions defined on a layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-arcadeUtils.html) */ interface arcadeUtils { /** * Returns all Arcade expressions defined on a given layer and provides metadata describing the context for which each expression was authored. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-arcadeUtils.html#getExpressionsFromLayer) */ getExpressionsFromLayer(layer: CSVLayer | FeatureLayer | GeoJSONLayer | Sublayer | OGCFeatureLayer | SceneLayer | WFSLayer): arcadeUtilsExpressionInfo[]; } export const arcadeUtils: arcadeUtils; /** * Represents the result of the [getExpressionsFromLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-arcadeUtils.html#getExpressionsFromLayer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-arcadeUtils.html#ExpressionInfo) */ export interface arcadeUtilsExpressionInfo { /** * An Arcade expression defined on a layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-arcadeUtils.html#ExpressionInfo) */ expression: string; /** * The name of the expression used when referencing it in popup and form templates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-arcadeUtils.html#ExpressionInfo) */ name?: string; /** * The expression's title, describing it in the legend and other UI elements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-arcadeUtils.html#ExpressionInfo) */ title?: string; /** * Information about the profile, or environment, where the expression was defined. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-arcadeUtils.html#ExpressionInfo) */ profileInfo: ExpressionInfoProfileInfo; } /** * Describes the context for which an Arcade expression was defined using the Feature Z profile. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-arcadeUtils.html#FeatureZProfileContext) */ export type FeatureZProfileContext = "order-by" | "elevation-info"; /** * Describes the context for which an Arcade expression was defined using the popup or popup element profile. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-arcadeUtils.html#PopupProfileContext) */ export type PopupProfileContext = "popup-template" | "popup-expression-content"; /** * Describes the context for which an Arcade expression was defined. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-arcadeUtils.html#ProfileContext) */ export type ProfileContext = | VisualizationProfileContext | PopupProfileContext | FeatureZProfileContext | "label-class" | "form-template"; /** * Describes the context for which an Arcade expression was defined using the visualization profile. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-arcadeUtils.html#VisualizationProfileContext) */ export type VisualizationProfileContext = | "unique-value-renderer" | "class-breaks-renderer" | "dot-density-renderer" | "heatmap-renderer" | "pie-chart-renderer" | "color-variable" | "size-variable" | "opacity-variable" | "rotation-variable"; export interface ExpressionInfoProfileInfo { /** * Indicates which [profile](https://developers.arcgis.com/arcade/profiles/) is used to execute the expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-arcadeUtils.html#ExpressionInfo) */ name: | "form-constraint" | "feature-z" | "field-calculation" | "form-calculation" | "labeling" | "popup" | "popup-element" | "feature-reduction-popup" | "feature-reduction-popup-element" | "visualization"; /** * Describes the context (i.e. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-arcadeUtils.html#ExpressionInfo) */ context: ProfileContext; /** * Indicates the data source used to hydrate the expression's profile variables. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-arcadeUtils.html#ExpressionInfo) */ source: "layer" | "feature-reduction"; /** * The return type of the expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-arcadeUtils.html#ExpressionInfo) */ returnType?: "boolean" | "date" | "number" | "string" | "dictionary"; } export interface BuildingFilter extends Accessor, JSONSupport { } export class BuildingFilter { /** * Description of the filter for display in UIs, for example when the filter is edited in ArcGIS Pro. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingFilter.html#description) */ description: string; /** * Filter blocks define which features should be visible in the affected [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html) and how the filtered features are drawn. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingFilter.html#filterBlocks) */ filterBlocks: Collection; /** * Unique filter id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingFilter.html#id) */ readonly id: string; /** * Name of the filter for display in UIs, for example when the filter is edited in ArcGIS Pro. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingFilter.html#name) */ name: string; /** * The `BuildingFilter` class defines a set of conditions that can be used to show or hide specific features of a [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html) in the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingFilter.html) */ constructor(properties?: BuildingFilterProperties); static fromJSON(json: any): BuildingFilter; } interface BuildingFilterProperties { /** * Description of the filter for display in UIs, for example when the filter is edited in ArcGIS Pro. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingFilter.html#description) */ description?: string; /** * Filter blocks define which features should be visible in the affected [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html) and how the filtered features are drawn. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingFilter.html#filterBlocks) */ filterBlocks?: CollectionProperties; /** * Name of the filter for display in UIs, for example when the filter is edited in ArcGIS Pro. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingFilter.html#name) */ name?: string; } /** * Object contained in the [filterBlocks](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingFilter.html#filterBlocks) collection: * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingFilter.html#BuildingFilterBlock) */ export interface BuildingFilterBlock { /** * The SQL where clause used to match features to this filter block. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingFilter.html#BuildingFilterBlock) */ filterExpression: string; /** * This object contains information about the filter mode of the filter block. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingFilter.html#BuildingFilterBlock) */ filterMode?: BuildingFilterBlockFilterMode; /** * Title of the filter for display in UIs, for example when the filter block is edited in ArcGIS Pro. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingFilter.html#BuildingFilterBlock) */ title?: string; } export interface BuildingFilterBlockFilterMode { /** * Defines how features are drawn while the filter is active. * * @default solid * * [Read more...](global.html#type) */ type?: "solid" | "wire-frame" | "x-ray"; /** * Defines the type of edges used to display a [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html) filtered in `wire-frame` mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingFilter.html#BuildingFilterBlock) */ edges?: SolidEdges3D | SketchEdges3D; } export interface BuildingSummaryStatistics extends Accessor, Loadable, JSONSupport { } export class BuildingSummaryStatistics { /** * An array of statistics on all fields in all sublayers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingSummaryStatistics.html#fields) */ fields: BuildingFieldStatistics[]; /** * Contains statistics about the fields in all sublayers of a [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingSummaryStatistics.html) */ constructor(properties?: BuildingSummaryStatisticsProperties); static fromJSON(json: any): BuildingSummaryStatistics; } interface BuildingSummaryStatisticsProperties extends LoadableProperties { /** * An array of statistics on all fields in all sublayers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingSummaryStatistics.html#fields) */ fields?: BuildingFieldStatistics[]; } /** * Summary statistics for a field in a [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingSummaryStatistics.html#BuildingFieldStatistics) */ export interface BuildingFieldStatistics { /** * Name of the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingSummaryStatistics.html#BuildingFieldStatistics) */ fieldName: string; /** * Model Name of the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingSummaryStatistics.html#BuildingFieldStatistics) */ modelName: string; /** * Label of the field. * * [Read more...](global.html) */ label: string; /** * Minimum value of the field for numeric values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingSummaryStatistics.html#BuildingFieldStatistics) */ min: number; /** * Maximum value of the field for numeric values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingSummaryStatistics.html#BuildingFieldStatistics) */ max: number; /** * List of the most frequent values of the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingSummaryStatistics.html#BuildingFieldStatistics) */ mostFrequentValues: string[] | number[]; /** * List of sublayer ids where this field is available. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-BuildingSummaryStatistics.html#BuildingFieldStatistics) */ subLayerIds: number[]; } export class CodedValueDomain extends Domain { /** * An array of the coded values in the domain. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CodedValueDomain.html#codedValues) */ codedValues: CodedValue[]; readonly type: "coded-value"; /** * Information about the coded values belonging to the domain. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CodedValueDomain.html) */ constructor(properties?: CodedValueDomainProperties); /** * Returns the name of the coded-value associated with the specified code. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CodedValueDomain.html#getName) */ getName(code: string | number): string; static fromJSON(json: any): CodedValueDomain; } interface CodedValueDomainProperties extends DomainProperties { /** * An array of the coded values in the domain. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CodedValueDomain.html#codedValues) */ codedValues?: CodedValue[]; } /** * The coded value in a domain. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CodedValueDomain.html#CodedValue) */ export interface CodedValue { /** * The name of the coded value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CodedValueDomain.html#CodedValue) */ name: string; /** * The value of the code. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CodedValueDomain.html#CodedValue) */ code: string | number; } export class ControlPointsGeoreference extends Accessor { /** * An array of two, three, or four [controlPoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ControlPointsGeoreference.html#controlPoints) positions the media element. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ControlPointsGeoreference.html#controlPoints) */ controlPoints: ControlPoint[]; /** * Defines the size of the element displayed, typically the element's height in pixels. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ControlPointsGeoreference.html#height) */ height: number; type: "control-points"; /** * Defines the size of the element displayed, typically the element's width in pixels. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ControlPointsGeoreference.html#width) */ width: number; /** * ControlPointsGeoreference is used to set the [geographic location](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html#georeference) of the [ImageElement](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html) or [VideoElement](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VideoElement.html) referenced in the [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html) using the [controlPoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ControlPointsGeoreference.html#controlPoints), [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ControlPointsGeoreference.html#width), and [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ControlPointsGeoreference.html#height) parameters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ControlPointsGeoreference.html) */ constructor(properties?: ControlPointsGeoreferenceProperties); /** * Converts the given [sourcePoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ControlPointsGeoreference.html#SourcePoint) to a [mapPoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ControlPointsGeoreference.html#toMap) */ toMap(sourcePoint: SourcePoint): Point; /** * Converts the given [mapPoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) to a [sourcePoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ControlPointsGeoreference.html#SourcePoint). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ControlPointsGeoreference.html#toSource) */ toSource(point: Point): SourcePoint; } interface ControlPointsGeoreferenceProperties { /** * An array of two, three, or four [controlPoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ControlPointsGeoreference.html#controlPoints) positions the media element. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ControlPointsGeoreference.html#controlPoints) */ controlPoints?: ControlPoint[]; /** * Defines the size of the element displayed, typically the element's height in pixels. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ControlPointsGeoreference.html#height) */ height?: number; type?: "control-points"; /** * Defines the size of the element displayed, typically the element's width in pixels. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ControlPointsGeoreference.html#width) */ width?: number; } /** * A control point object in the [controlPoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ControlPointsGeoreference.html#controlPoints) array. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ControlPointsGeoreference.html#ControlPoint) */ export interface ControlPoint { /** * The coordinate of the control point in the image coordinate space. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ControlPointsGeoreference.html#ControlPoint) */ sourcePoint?: SourcePoint; /** * The coordinate of the the control point in the map coordinate space. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ControlPointsGeoreference.html#ControlPoint) */ mapPoint?: Point; } /** * An object representing a point on the element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ControlPointsGeoreference.html#SourcePoint) */ export interface SourcePoint { /** * The x coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ControlPointsGeoreference.html#SourcePoint) */ x: number; /** * The y coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ControlPointsGeoreference.html#SourcePoint) */ y: number; } export class CornersGeoreference extends Accessor { /** * The bottom left [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) of the bounding box representing the geographic location of the image or video element being added to the [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CornersGeoreference.html#bottomLeft) */ bottomLeft: Point; /** * The bottom right [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) of the bounding box representing the geographic location of the image or video element being added to the [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CornersGeoreference.html#bottomRight) */ bottomRight: Point; /** * The top left [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) of the bounding box representing the geographic location of the image or video element being added to the [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CornersGeoreference.html#topLeft) */ topLeft: Point; /** * The top right [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) of the bounding box representing the geographic location of the image or video element being added to the [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CornersGeoreference.html#topRight) */ topRight: Point; /** * The georeference type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CornersGeoreference.html#type) */ readonly type: "corners"; /** * CornersGeoreference is used to set the [geographic location](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html#georeference) of the [image](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html) or [element](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VideoElement.html) referenced in the [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html) using corner points of a bounding box. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CornersGeoreference.html) */ constructor(properties?: CornersGeoreferenceProperties); } interface CornersGeoreferenceProperties { /** * The bottom left [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) of the bounding box representing the geographic location of the image or video element being added to the [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CornersGeoreference.html#bottomLeft) */ bottomLeft?: PointProperties; /** * The bottom right [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) of the bounding box representing the geographic location of the image or video element being added to the [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CornersGeoreference.html#bottomRight) */ bottomRight?: PointProperties; /** * The top left [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) of the bounding box representing the geographic location of the image or video element being added to the [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CornersGeoreference.html#topLeft) */ topLeft?: PointProperties; /** * The top right [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) of the bounding box representing the geographic location of the image or video element being added to the [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CornersGeoreference.html#topRight) */ topRight?: PointProperties; } export interface DimensionalDefinition extends Accessor, JSONSupport { } export class DimensionalDefinition { /** * The dimension associated with the variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-DimensionalDefinition.html#dimensionName) */ dimensionName: string; /** * Indicates whether the values indicate slices (rather than ranges). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-DimensionalDefinition.html#isSlice) */ isSlice: boolean; /** * An array of single values or tuples [min, max] each defining a range of valid values along the specified dimension. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-DimensionalDefinition.html#values) */ values: (number | number[])[]; /** * The required variable name by which to filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-DimensionalDefinition.html#variableName) */ variableName: string; /** * A dimensional definition defines a filter based on one variable and one dimension. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-DimensionalDefinition.html) */ constructor(properties?: DimensionalDefinitionProperties); /** * Creates a clone of the DimensionalDefinition object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-DimensionalDefinition.html#clone) */ clone(): DimensionalDefinition; static fromJSON(json: any): DimensionalDefinition; } interface DimensionalDefinitionProperties { /** * The dimension associated with the variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-DimensionalDefinition.html#dimensionName) */ dimensionName?: string; /** * Indicates whether the values indicate slices (rather than ranges). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-DimensionalDefinition.html#isSlice) */ isSlice?: boolean; /** * An array of single values or tuples [min, max] each defining a range of valid values along the specified dimension. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-DimensionalDefinition.html#values) */ values?: (number | number[])[]; /** * The required variable name by which to filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-DimensionalDefinition.html#variableName) */ variableName?: string; } export interface Domain extends Accessor, JSONSupport { } export class Domain { /** * The domain name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html#name) */ name: string; /** * The domain type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html#type) */ type: "range" | "coded-value" | "inherited"; /** * Domains define constraints on a [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) */ constructor(properties?: DomainProperties); static fromJSON(json: any): Domain; } interface DomainProperties { /** * The domain name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html#name) */ name?: string; /** * The domain type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html#type) */ type?: "range" | "coded-value" | "inherited"; } export class ElevationSampler { /** * The minimum and maximum resolution of the data in the sampler. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ElevationSampler.html#demResolution) */ readonly demResolution: ElevationSamplerDemResolution; /** * The extent within which the sampler can be queried. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ElevationSampler.html#extent) */ readonly extent: Extent; /** * The value that is used to represent areas where there is no data available. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ElevationSampler.html#noDataValue) */ readonly noDataValue: number; /** * The spatial reference of the sampler. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ElevationSampler.html#spatialReference) */ readonly spatialReference: SpatialReference; /** * Get elevation for a coordinate specified in the spatial reference of the sampler. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ElevationSampler.html#elevationAt) */ elevationAt(x: number, y: number): number; /** * Query elevation for a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html), [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) or [Multipoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html) geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ElevationSampler.html#queryElevation) */ queryElevation(geometry: Point | Multipoint | Polyline): Point | Multipoint | Polyline; on(name: "changed", eventHandler: ElevationSamplerChangedEventHandler): IHandle; } export interface ElevationSamplerChangedEvent { } export interface ElevationSamplerDemResolution { /** * The minimum resolution. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ElevationSampler.html#demResolution) */ min: number; /** * The maximum resolution. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ElevationSampler.html#demResolution) */ max: number; } export interface supportExpressionInfo extends Accessor, JSONSupport, Clonable { } export class supportExpressionInfo { /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ExpressionInfo.html#expression) */ expression: string; /** * Indicates the return type of the Arcade expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ExpressionInfo.html#returnType) */ returnType: "string" | "number"; /** * The title used to describe the value returned by the expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ExpressionInfo.html#title) */ title: string; /** * The `ExpressionInfo` class references an [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ExpressionInfo.html) */ constructor(properties?: supportExpressionInfoProperties); static fromJSON(json: any): supportExpressionInfo; } interface supportExpressionInfoProperties { /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ExpressionInfo.html#expression) */ expression?: string; /** * Indicates the return type of the Arcade expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ExpressionInfo.html#returnType) */ returnType?: "string" | "number"; /** * The title used to describe the value returned by the expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ExpressionInfo.html#title) */ title?: string; } export class ExtentAndRotationGeoreference extends Accessor { /** * An extent of the image or video element representing its geographic location when added to the [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ExtentAndRotationGeoreference.html#extent) */ extent: Extent; /** * A rotation of the image or video element when added to the [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html). * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ExtentAndRotationGeoreference.html#rotation) */ rotation: number; /** * The georeference type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ExtentAndRotationGeoreference.html#type) */ readonly type: "extent-and-rotation"; /** * ExtentAndRotationGeoreference is used to set the [geographic location](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html#georeference) of the [image](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html) or [element](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VideoElement.html) referenced in the [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html) using the [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ExtentAndRotationGeoreference.html#extent) and [rotation](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ExtentAndRotationGeoreference.html#rotation) parameters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ExtentAndRotationGeoreference.html) */ constructor(properties?: ExtentAndRotationGeoreferenceProperties); } interface ExtentAndRotationGeoreferenceProperties { /** * An extent of the image or video element representing its geographic location when added to the [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ExtentAndRotationGeoreference.html#extent) */ extent?: ExtentProperties; /** * A rotation of the image or video element when added to the [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html). * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ExtentAndRotationGeoreference.html#rotation) */ rotation?: number; } export interface FacilityLayerInfo extends Accessor, JSONSupport { } export class FacilityLayerInfo { /** * The field name from the layer that defines the facility unique ID for a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FacilityLayerInfo.html#facilityIdField) */ facilityIdField: string; /** * Identifies an operational layer in a map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FacilityLayerInfo.html#layerId) */ layerId: string; /** * The field name from the layer that defines the facility name for a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FacilityLayerInfo.html#nameField) */ nameField: string; /** * The field name from the layer that records the unique ID of a feature's associated site and can be used to identify a feature's associated site feature in floor-aware maps. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FacilityLayerInfo.html#siteIdField) */ siteIdField: string; /** * This value references the numeric ID of the sublayer if the Facility layer is a map service sublayer instead of a feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FacilityLayerInfo.html#sublayerId) */ sublayerId: number; /** * The FacilityLayerInfo describes the footprints of managed buildings and other structures. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FacilityLayerInfo.html) */ constructor(properties?: FacilityLayerInfoProperties); static fromJSON(json: any): FacilityLayerInfo; } interface FacilityLayerInfoProperties { /** * The field name from the layer that defines the facility unique ID for a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FacilityLayerInfo.html#facilityIdField) */ facilityIdField?: string; /** * Identifies an operational layer in a map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FacilityLayerInfo.html#layerId) */ layerId?: string; /** * The field name from the layer that defines the facility name for a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FacilityLayerInfo.html#nameField) */ nameField?: string; /** * The field name from the layer that records the unique ID of a feature's associated site and can be used to identify a feature's associated site feature in floor-aware maps. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FacilityLayerInfo.html#siteIdField) */ siteIdField?: string; /** * This value references the numeric ID of the sublayer if the Facility layer is a map service sublayer instead of a feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FacilityLayerInfo.html#sublayerId) */ sublayerId?: number; } export interface FeatureEffect extends Accessor, JSONSupport { } export class FeatureEffect { /** * The [effect](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html#Effect) applied to features that do not meet the [filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html#filter) requirements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html#excludedEffect) */ excludedEffect: Effect; /** * Indicates if labels are visible for features that are [excluded](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html#excludedEffect) from the [filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html#filter). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html#excludedLabelsVisible) */ excludedLabelsVisible: boolean; /** * The [filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html) that drives the effect. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html#filter) */ filter: FeatureFilter; /** * The [effect](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html#Effect) applied to features that meet the [filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html#filter) requirements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html#includedEffect) */ includedEffect: Effect; /** * FeatureEffect allows you to emphasize or deemphasize features that satisfy a [filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html#filter) in 2D [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html) */ constructor(properties?: FeatureEffectProperties); /** * Creates a deep clone of FeatureEffect object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html#clone) */ clone(): FeatureEffect; static fromJSON(json: any): FeatureEffect; } interface FeatureEffectProperties { /** * The [effect](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html#Effect) applied to features that do not meet the [filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html#filter) requirements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html#excludedEffect) */ excludedEffect?: any[] | string; /** * Indicates if labels are visible for features that are [excluded](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html#excludedEffect) from the [filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html#filter). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html#excludedLabelsVisible) */ excludedLabelsVisible?: boolean; /** * The [filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html) that drives the effect. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html#filter) */ filter?: FeatureFilterProperties; /** * The [effect](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html#Effect) applied to features that meet the [filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html#filter) requirements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html#includedEffect) */ includedEffect?: any[] | string; } /** * Effect provides various filter functions that can be performed on a layer or a layerView to achieve different visual effects similar to how image filters (photo apps) work. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html#Effect) */ export type Effect = any[] | string; export interface FeatureFilter extends Accessor, JSONSupport { } export class FeatureFilter { /** * Specifies a search distance from a given [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#geometry) in a spatial filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#distance) */ distance: number; /** * The geometry to apply to the spatial filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#geometry) */ geometry: Geometry; /** * An array of objectIds of the features to be filtered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#objectIds) */ objectIds: number[]; /** * For spatial filters, this parameter defines the spatial relationship to filter features in the layer view against the filter [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#geometry). * * @default intersects * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#spatialRelationship) */ spatialRelationship: string; /** * A range of time with start and end date. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#timeExtent) */ timeExtent: TimeExtent; /** * The unit for calculating the buffer distance when [distance](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#distance) is specified in a spatial filter. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#units) */ units: "feet" | "miles" | "nautical-miles" | "us-nautical-miles" | "meters" | "kilometers"; /** * A where clause for the feature filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#where) */ where: string; /** * This class defines parameters for setting a client-side filter on a [featureEffect](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#featureEffect) or [layer view](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html#filter). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html) */ constructor(properties?: FeatureFilterProperties); /** * Creates a deep clone of the FeatureFilter object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#clone) */ clone(): FeatureFilter; /** * Creates [query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) parameters that can be used to fetch features that satisfy the layer's current filters and definitions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#createQuery) */ createQuery(): Query; static fromJSON(json: any): FeatureFilter; } interface FeatureFilterProperties { /** * Specifies a search distance from a given [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#geometry) in a spatial filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#distance) */ distance?: number; /** * The geometry to apply to the spatial filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#geometry) */ geometry?: GeometryProperties; /** * An array of objectIds of the features to be filtered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#objectIds) */ objectIds?: number[]; /** * For spatial filters, this parameter defines the spatial relationship to filter features in the layer view against the filter [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#geometry). * * @default intersects * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#spatialRelationship) */ spatialRelationship?: string; /** * A range of time with start and end date. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#timeExtent) */ timeExtent?: TimeExtentProperties; /** * The unit for calculating the buffer distance when [distance](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#distance) is specified in a spatial filter. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#units) */ units?: "feet" | "miles" | "nautical-miles" | "us-nautical-miles" | "meters" | "kilometers"; /** * A where clause for the feature filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#where) */ where?: string; } export interface FeatureReductionBinning extends Accessor, JSONSupport { } export class FeatureReductionBinning { /** * An array of aggregate fields that summarize layer [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#fields) from features contained within each bin. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#fields) */ fields: AggregateField[]; /** * The fixed geohash level used to create bins. * * @default 3 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#fixedBinLevel) */ fixedBinLevel: number; /** * Defines labels for bins as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#labelingInfo) */ labelingInfo: LabelClass[]; /** * Indicates whether to display labels for the bins. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#labelsVisible) */ labelsVisible: boolean; /** * Defines the maximum [view scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) at which binning is enabled. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#maxScale) */ maxScale: number; /** * Indicates whether to display a popup when a user clicks or touches a bin. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#popupEnabled) */ popupEnabled: boolean; /** * The [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) to apply to bins. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * The renderer used to style the bins. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#renderer) */ renderer: Renderer; /** * The feature reduction type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#type) */ type: "binning"; /** * This class configures binning as a means of reducing and summarizing point features in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html), [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html), [WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html), or [OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html) */ constructor(properties?: FeatureReductionBinningProperties); /** * Creates a deep clone of the FeatureReductionBinning object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#clone) */ clone(): FeatureReductionBinning; static fromJSON(json: any): FeatureReductionBinning; } interface FeatureReductionBinningProperties { /** * An array of aggregate fields that summarize layer [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#fields) from features contained within each bin. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#fields) */ fields?: AggregateFieldProperties[]; /** * The fixed geohash level used to create bins. * * @default 3 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#fixedBinLevel) */ fixedBinLevel?: number; /** * Defines labels for bins as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#labelingInfo) */ labelingInfo?: LabelClassProperties[]; /** * Indicates whether to display labels for the bins. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#labelsVisible) */ labelsVisible?: boolean; /** * Defines the maximum [view scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) at which binning is enabled. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#maxScale) */ maxScale?: number; /** * Indicates whether to display a popup when a user clicks or touches a bin. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#popupEnabled) */ popupEnabled?: boolean; /** * The [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) to apply to bins. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * The renderer used to style the bins. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#renderer) */ renderer?: RendererProperties; /** * The feature reduction type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#type) */ type?: "binning"; } export interface FeatureReductionCluster extends Accessor, JSONSupport { } export class FeatureReductionCluster { /** * Defines the symbol size of the largest cluster in points (or pixels if specified). * * @default 37.5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterMaxSize) */ clusterMaxSize: number; /** * Defines the symbol size of the smallest cluster in points (or pixels if specified). * * @default 9 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterMinSize) */ clusterMinSize: number; /** * Defines the radius in points (or pixels if specified) of the area in which multiple points will be grouped and visualized as a single cluster. * * @default 60 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterRadius) */ clusterRadius: number; /** * An array of aggregate fields that summarize layer [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#fields) from features contained within each cluster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#fields) */ fields: AggregateField[]; /** * Defines labels for clusters as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#labelingInfo) */ labelingInfo: LabelClass[]; /** * Indicates whether to display labels for the clusters. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#labelsVisible) */ labelsVisible: boolean; /** * Defines the maximum [view scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) at which clustering is enabled. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#maxScale) */ maxScale: number; /** * Indicates whether to display the cluster popup. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupEnabled) */ popupEnabled: boolean; /** * The [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) to apply to clustered graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * The renderer used to override the default style of the clusters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#renderer) */ renderer: Renderer; /** * A symbol used to override the default cluster style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#symbol) */ symbol: MarkerSymbol | CIMSymbol | WebStyleSymbol; /** * The feature reduction type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#type) */ type: "cluster"; /** * This class configures clustering as a means of reducing and summarizing point features in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html), [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html), [WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html), or [OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html) */ constructor(properties?: FeatureReductionClusterProperties); /** * Creates a deep clone of the FeatureReductionCluster object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clone) */ clone(): FeatureReductionCluster; static fromJSON(json: any): FeatureReductionCluster; } interface FeatureReductionClusterProperties { /** * Defines the symbol size of the largest cluster in points (or pixels if specified). * * @default 37.5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterMaxSize) */ clusterMaxSize?: number | string; /** * Defines the symbol size of the smallest cluster in points (or pixels if specified). * * @default 9 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterMinSize) */ clusterMinSize?: number | string; /** * Defines the radius in points (or pixels if specified) of the area in which multiple points will be grouped and visualized as a single cluster. * * @default 60 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterRadius) */ clusterRadius?: number | string; /** * An array of aggregate fields that summarize layer [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#fields) from features contained within each cluster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#fields) */ fields?: AggregateFieldProperties[]; /** * Defines labels for clusters as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#labelingInfo) */ labelingInfo?: LabelClassProperties[]; /** * Indicates whether to display labels for the clusters. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#labelsVisible) */ labelsVisible?: boolean; /** * Defines the maximum [view scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) at which clustering is enabled. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#maxScale) */ maxScale?: number; /** * Indicates whether to display the cluster popup. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupEnabled) */ popupEnabled?: boolean; /** * The [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) to apply to clustered graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * The renderer used to override the default style of the clusters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#renderer) */ renderer?: RendererProperties; /** * A symbol used to override the default cluster style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#symbol) */ symbol?: | MarkerSymbolProperties | (CIMSymbolProperties & { type: "cim" }) | (WebStyleSymbolProperties & { type: "web-style" }); /** * The feature reduction type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#type) */ type?: "cluster"; } export interface FeatureReductionSelection extends Accessor, JSONSupport { } export class FeatureReductionSelection { /** * The feature reduction type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionSelection.html#type) */ type: "selection"; /** * Declutters points in the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) by thinning overlapping features so no features intersect on screen. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionSelection.html) */ constructor(properties?: FeatureReductionSelectionProperties); static fromJSON(json: any): FeatureReductionSelection; } interface FeatureReductionSelectionProperties { /** * The feature reduction type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionSelection.html#type) */ type?: "selection"; } export interface FeatureTemplate extends Accessor, JSONSupport, Clonable { } export class FeatureTemplate { /** * Description of the feature template. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#description) */ description: string; /** * Name of the default drawing tool defined for the template to create a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#drawingTool) */ drawingTool: | "auto-complete-polygon" | "circle" | "ellipse" | "freehand" | "line" | "none" | "point" | "polygon" | "rectangle" | "arrow" | "triangle" | "left-arrow" | "right-arrow" | "up-arrow" | "down-arrow"; /** * Name of the feature template. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#name) */ name: string; /** * An instance of the prototypical feature described by the [feature template](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#prototype) */ prototype: any; /** * An object used to create a thumbnail image that represents a feature type in the feature template. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#thumbnail) */ thumbnail: FeatureTemplateThumbnail; /** * Feature templates define all the information required to create a new feature in a [feature layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html) */ constructor(properties?: FeatureTemplateProperties); static fromJSON(json: any): FeatureTemplate; } interface FeatureTemplateProperties { /** * Description of the feature template. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#description) */ description?: string; /** * Name of the default drawing tool defined for the template to create a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#drawingTool) */ drawingTool?: | "auto-complete-polygon" | "circle" | "ellipse" | "freehand" | "line" | "none" | "point" | "polygon" | "rectangle" | "arrow" | "triangle" | "left-arrow" | "right-arrow" | "up-arrow" | "down-arrow"; /** * Name of the feature template. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#name) */ name?: string; /** * An instance of the prototypical feature described by the [feature template](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#prototype) */ prototype?: any; /** * An object used to create a thumbnail image that represents a feature type in the feature template. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#thumbnail) */ thumbnail?: FeatureTemplateThumbnail; } export interface FeatureTemplateThumbnail { /** * The MIME type of the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#thumbnail) */ contentType: "image" | "png" | "jpg" | "jpeg"; /** * The [base64EncodedImageData](https://developer.mozilla.org/en-US/docs/Web/API/WindowBase64/Base64_encoding_and_decoding) presenting the thumbnail image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#thumbnail) */ imageData: string; /** * The height of the thumbnail. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#thumbnail) */ height: number; /** * The width of the thumbnail. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#thumbnail) */ width: number; } export interface FeatureType extends Accessor, JSONSupport, Clonable { } export class FeatureType { /** * Domains associated with the feature type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html#domains) */ domains: HashMap; /** * The feature type identifier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html#id) */ id: number | string; /** * The feature type name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html#name) */ name: string; /** * Array of [feature templates](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html) associated with the feature type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html#templates) */ templates: FeatureTemplate[]; /** * FeatureType is a subset of features defined in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) that share the same attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html) */ constructor(properties?: FeatureTypeProperties); static fromJSON(json: any): FeatureType; } interface FeatureTypeProperties { /** * Domains associated with the feature type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html#domains) */ domains?: HashMap< | (CodedValueDomainProperties & { type: "coded-value" }) | (RangeDomainProperties & { type: "range" }) | (InheritedDomainProperties & { type: "inherited" }) >; /** * The feature type identifier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html#id) */ id?: number | string; /** * The feature type name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html#name) */ name?: string; /** * Array of [feature templates](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html) associated with the feature type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html#templates) */ templates?: FeatureTemplateProperties[]; } export interface Field extends Accessor, JSONSupport { } export class Field { /** * The display name for the field. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#alias) */ alias: string; /** * The default value set for the field. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#defaultValue) */ defaultValue: number | string | null | undefined; /** * Contains information describing the purpose of each field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#description) */ description: string; /** * The domain associated with the field. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#domain) */ domain: CodedValueDomain | RangeDomain | InheritedDomain; /** * Indicates whether the field is editable. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#editable) */ editable: boolean; /** * The field length. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#length) */ length: number | undefined; /** * The name of the field. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#name) */ name: string; /** * Indicates if the field can accept `null` values. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#nullable) */ nullable: boolean; /** * The data type of the field. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#type) */ type: | "small-integer" | "integer" | "big-integer" | "single" | "double" | "long" | "string" | "date" | "date-only" | "time-only" | "timestamp-offset" | "oid" | "geometry" | "blob" | "raster" | "guid" | "global-id" | "xml"; /** * The types of values that can be assigned to a field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#valueType) */ valueType: | "binary" | "coordinate" | "count-or-amount" | "date-and-time" | "description" | "location-or-place-name" | "measurement" | "name-or-title" | "none" | "ordered-or-ranked" | "percentage-or-ratio" | "type-or-category" | "unique-identifier"; /** * Information about each field in a layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) */ constructor(properties?: FieldProperties); static fromJSON(json: any): Field; } interface FieldProperties { /** * The display name for the field. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#alias) */ alias?: string; /** * The default value set for the field. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#defaultValue) */ defaultValue?: number | string | null | undefined; /** * Contains information describing the purpose of each field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#description) */ description?: string; /** * The domain associated with the field. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#domain) */ domain?: | (CodedValueDomainProperties & { type: "coded-value" }) | (RangeDomainProperties & { type: "range" }) | (InheritedDomainProperties & { type: "inherited" }); /** * Indicates whether the field is editable. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#editable) */ editable?: boolean; /** * The field length. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#length) */ length?: number | undefined; /** * The name of the field. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#name) */ name?: string; /** * Indicates if the field can accept `null` values. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#nullable) */ nullable?: boolean; /** * The data type of the field. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#type) */ type?: | "small-integer" | "integer" | "big-integer" | "single" | "double" | "long" | "string" | "date" | "date-only" | "time-only" | "timestamp-offset" | "oid" | "geometry" | "blob" | "raster" | "guid" | "global-id" | "xml"; /** * The types of values that can be assigned to a field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#valueType) */ valueType?: | "binary" | "coordinate" | "count-or-amount" | "date-and-time" | "description" | "location-or-place-name" | "measurement" | "name-or-title" | "none" | "ordered-or-ranked" | "percentage-or-ratio" | "type-or-category" | "unique-identifier"; } export class FieldsIndex { /** * An array of date fields or field json objects. * * @default [] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FieldsIndex.html#dateFields) */ dateFields: Field[] | any[]; constructor(properties?: any); /** * Returns a field with the specified field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FieldsIndex.html#get) */ get(fieldName: string): Field; /** * Returns a [time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for a field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FieldsIndex.html#getTimeZone) */ getTimeZone(fieldOrFieldName: string | Field): string | null; /** * Checks if a field with the specified field name exists in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FieldsIndex.html#has) */ has(fieldName: string): boolean; /** * Checks if a field with the specified field name is a date field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FieldsIndex.html#isDateField) */ isDateField(fieldName: string): boolean; } /** * Convenience methods for getting field names used for feature layer [labeling](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#labelingInfo), [elevation](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#elevationInfo), [editor tracking](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#editFieldsInfo) and time span. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-fieldUtils.html) */ interface fieldUtils { /** * Gets the appropriate display field name to label a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-fieldUtils.html#getDisplayFieldName) */ getDisplayFieldName(layer: FeatureLayer | CSVLayer | GeoJSONLayer | OGCFeatureLayer | SceneLayer | StreamLayer): string; /** * Returns an array of field names used in the Arcade expression for calculating the z-values of features in the given feature layer's [FeatureLayer.elevationInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#elevationInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-fieldUtils.html#getElevationFields) */ getElevationFields(layer: FeatureLayer): Promise; /** * Returns an array of field names referenced in one or more [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expressions to be set on the given layer in either the renderer, labels, or popup template. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-fieldUtils.html#getExpressionFields) */ getExpressionFields(layer: FeatureLayer | CSVLayer | GeoJSONLayer | SceneLayer | StreamLayer, expressions: string[]): Promise; /** * Returns an array of editor tracking field names for a given feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-fieldUtils.html#getFeatureEditFields) */ getFeatureEditFields(layer: FeatureLayer): string[]; /** * Returns an array of geometry field names for a given feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-fieldUtils.html#getFeatureGeometryFields) */ getFeatureGeometryFields(layer: FeatureLayer): string[]; /** * Returns an array of field names used in the Arcade expression for labeling features in the given feature layer's [FeatureLayer.labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#labelingInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-fieldUtils.html#getLabelingFields) */ getLabelingFields(layer: FeatureLayer): Promise; /** * Returns an array of field names related to time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-fieldUtils.html#getTimeFields) */ getTimeFields(layer: FeatureLayer): Promise; } export const fieldUtils: fieldUtils; export interface GeometryFieldsInfo extends Accessor, JSONSupport { } export class GeometryFieldsInfo { /** * The name of the field that stores the feature's area, e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-GeometryFieldsInfo.html#shapeAreaField) */ readonly shapeAreaField: string; /** * The name of the field that stores the feature's length, e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-GeometryFieldsInfo.html#shapeLengthField) */ readonly shapeLengthField: string; /** * The units of measure for the area and length field values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-GeometryFieldsInfo.html#units) */ readonly units: string; /** * The `GeometryFieldsInfo` class returns information about the system maintained geometry information associated with a specific feature in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-GeometryFieldsInfo.html) */ constructor(properties?: GeometryFieldsInfoProperties); static fromJSON(json: any): GeometryFieldsInfo; } interface GeometryFieldsInfoProperties { } export interface ImageElement extends Accessor, MediaElementBase { } export class ImageElement { /** * The animation options for the image element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html#animationOptions) */ animationOptions: AnimationOptions; /** * The image content referenced in the image element instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html#content) */ readonly content: HTMLImageElement | HTMLCanvasElement | ImageData; /** * The image element to be added to the [media layer's source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#source). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html#image) */ image: string | HTMLImageElement | HTMLCanvasElement | ImageData; /** * The element type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html#type) */ readonly type: "image"; /** * Represents an image element referenced in the MediaLayer's [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#source). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html) */ constructor(properties?: ImageElementProperties); } interface ImageElementProperties extends MediaElementBaseProperties { /** * The animation options for the image element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html#animationOptions) */ animationOptions?: AnimationOptions; /** * The image element to be added to the [media layer's source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#source). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html#image) */ image?: string | HTMLImageElement | HTMLCanvasElement | ImageData; } /** * Represents animation options, a collection of properties that apply when the [image](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html#image) is an animated GIF or APNG. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html#AnimationOptions) */ export interface AnimationOptions { /** * Indicates whether the animated image should play its animation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html#AnimationOptions) */ playing?: boolean; /** * Represents the number of seconds it takes to play through the layer's animation once. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html#AnimationOptions) */ duration?: number; /** * Determines how to repeat the animation of a layer when the animation cycle ends. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html#AnimationOptions) */ repeatType?: "none" | "loop" | "oscillate"; /** * Represents the number of seconds to delay before repeating an animation cycle. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html#AnimationOptions) */ repeatDelay?: number; } export class InheritedDomain extends Domain { /** * The domain type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-InheritedDomain.html#type) */ readonly type: "inherited"; /** * This is a subclass of [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-InheritedDomain.html) */ constructor(properties?: InheritedDomainProperties); static fromJSON(json: any): InheritedDomain; } interface InheritedDomainProperties extends DomainProperties { } export interface KMLSublayer extends Accessor, JSONSupport { } export class KMLSublayer { /** * Description for the KML sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#description) */ description: string; /** * The id for the KML sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#id) */ id: number; /** * The [KMLLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html) to which the sublayer belongs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#layer) */ layer: KMLLayer; /** * Network link info for the current layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#networkLink) */ networkLink: any; /** * The parent layer to which the sublayer belongs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#parent) */ parent: KMLSublayer | KMLLayer; /** * The raw KML data for this sublayer, in JSON format, as returned by the [KML utility service](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#kmlServiceUrl). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#sourceJSON) */ sourceJSON: any; /** * A collection of [KMLSublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#sublayers) */ sublayers: Collection; /** * The title of the KML sublayer used to identify it in places such as the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) and [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widgets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#title) */ title: string; /** * Indicates if the sublayer is visible in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#visible) */ visible: boolean; /** * Represents a sublayer in a [KMLLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html) */ constructor(properties?: KMLSublayerProperties); static fromJSON(json: any): KMLSublayer; } interface KMLSublayerProperties { /** * Description for the KML sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#description) */ description?: string; /** * The id for the KML sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#id) */ id?: number; /** * The [KMLLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html) to which the sublayer belongs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#layer) */ layer?: KMLLayerProperties; /** * Network link info for the current layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#networkLink) */ networkLink?: any; /** * The parent layer to which the sublayer belongs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#parent) */ parent?: KMLSublayerProperties | (KMLLayerProperties & { type: "kml" }); /** * The raw KML data for this sublayer, in JSON format, as returned by the [KML utility service](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#kmlServiceUrl). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#sourceJSON) */ sourceJSON?: any; /** * A collection of [KMLSublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#sublayers) */ sublayers?: CollectionProperties; /** * The title of the KML sublayer used to identify it in places such as the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) and [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widgets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#title) */ title?: string; /** * Indicates if the sublayer is visible in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#visible) */ visible?: boolean; } export interface LabelClass extends Accessor, JSONSupport { } export class LabelClass { /** * Specifies whether or not a polyline label can overrun the feature being labeled. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#allowOverrun) */ allowOverrun: boolean; /** * Defines how labels should be placed relative to one another. * * @default static * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#deconflictionStrategy) */ deconflictionStrategy: "none" | "static"; /** * Defines the labels for a [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpression) */ labelExpression: string; /** * Defines the labels for a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpressionInfo) */ labelExpressionInfo: LabelClassLabelExpressionInfo; /** * The position of the label. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelPlacement) */ labelPlacement: | "above-center" | "above-left" | "above-right" | "below-center" | "below-left" | "below-right" | "center-center" | "center-left" | "center-right" | "above-after" | "above-along" | "above-before" | "above-start" | "above-end" | "below-after" | "below-along" | "below-before" | "below-start" | "below-end" | "center-after" | "center-along" | "center-before" | "center-start" | "center-end" | "always-horizontal"; /** * Specifies the orientation of the label position of a polyline label. * * @default "curved" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelPosition) */ labelPosition: "curved" | "parallel"; /** * The maximum scale (most zoomed in) at which labels are visible in the view. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#maxScale) */ maxScale: number; /** * The minimum scale (most zoomed out) at which labels are visible in the view. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#minScale) */ minScale: number; /** * Indicates whether or not to repeat the label along the polyline feature. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#repeatLabel) */ repeatLabel: boolean; /** * The size in points of the distance between labels on a polyline. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#repeatLabelDistance) */ repeatLabelDistance: number; /** * Defines the symbol used for rendering the label. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#symbol) */ symbol: TextSymbol | LabelSymbol3D; /** * Indicates whether to use domain names if the fields in the [labelExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpression) or [labelExpressionInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpressionInfo) have domains. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#useCodedValues) */ useCodedValues: boolean; /** * A SQL where clause used to determine the features to which the label class should be applied. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#where) */ where: string; /** * Defines label expressions, symbols, scale ranges, label priorities, and label placement options for labels on a layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html) */ constructor(properties?: LabelClassProperties); /** * Creates a deep clone of the LabelClass. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#clone) */ clone(): LabelClass; static fromJSON(json: any): LabelClass; } interface LabelClassProperties { /** * Specifies whether or not a polyline label can overrun the feature being labeled. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#allowOverrun) */ allowOverrun?: boolean; /** * Defines how labels should be placed relative to one another. * * @default static * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#deconflictionStrategy) */ deconflictionStrategy?: "none" | "static"; /** * Defines the labels for a [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpression) */ labelExpression?: string; /** * Defines the labels for a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpressionInfo) */ labelExpressionInfo?: LabelClassLabelExpressionInfo; /** * The position of the label. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelPlacement) */ labelPlacement?: | "above-center" | "above-left" | "above-right" | "below-center" | "below-left" | "below-right" | "center-center" | "center-left" | "center-right" | "above-after" | "above-along" | "above-before" | "above-start" | "above-end" | "below-after" | "below-along" | "below-before" | "below-start" | "below-end" | "center-after" | "center-along" | "center-before" | "center-start" | "center-end" | "always-horizontal"; /** * Specifies the orientation of the label position of a polyline label. * * @default "curved" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelPosition) */ labelPosition?: "curved" | "parallel"; /** * The maximum scale (most zoomed in) at which labels are visible in the view. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#maxScale) */ maxScale?: number; /** * The minimum scale (most zoomed out) at which labels are visible in the view. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#minScale) */ minScale?: number; /** * Indicates whether or not to repeat the label along the polyline feature. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#repeatLabel) */ repeatLabel?: boolean; /** * The size in points of the distance between labels on a polyline. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#repeatLabelDistance) */ repeatLabelDistance?: number | string; /** * Defines the symbol used for rendering the label. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#symbol) */ symbol?: (TextSymbolProperties & { type: "text" }) | (LabelSymbol3DProperties & { type: "label-3d" }); /** * Indicates whether to use domain names if the fields in the [labelExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpression) or [labelExpressionInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpressionInfo) have domains. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#useCodedValues) */ useCodedValues?: boolean; /** * A SQL where clause used to determine the features to which the label class should be applied. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#where) */ where?: string; } export interface LabelClassLabelExpressionInfo { /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Labeling Profile](https://developers.arcgis.com/javascript/latest/arcade/#labeling). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpressionInfo) */ expression: string; /** * The title of the label expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpressionInfo) */ title?: string; } export interface LayerFloorInfo extends Accessor, JSONSupport { } export class LayerFloorInfo { /** * The field name derived from a floor-aware layer and used to filter features by floor level. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LayerFloorInfo.html#floorField) */ floorField: string; /** * LayerFloorInfo contains properties that allow a layer to be floor-aware. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LayerFloorInfo.html) */ constructor(properties?: LayerFloorInfoProperties); /** * Creates a deep clone of LayerFloorInfo object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LayerFloorInfo.html#clone) */ clone(): LayerFloorInfo; static fromJSON(json: any): LayerFloorInfo; } interface LayerFloorInfoProperties { /** * The field name derived from a floor-aware layer and used to filter features by floor level. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LayerFloorInfo.html#floorField) */ floorField?: string; } export interface LevelLayerInfo extends Accessor, JSONSupport { } export class LevelLayerInfo { /** * The field name from the layer that defines the unique ID of a feature's associated facility. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LevelLayerInfo.html#facilityIdField) */ facilityIdField: string; /** * The id for an operational layer in the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LevelLayerInfo.html#layerId) */ layerId: string; /** * The field name from the layer that defines a unique ID for the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LevelLayerInfo.html#levelIdField) */ levelIdField: string; /** * The field name from the layer that defines the level floor number in a particular facility. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LevelLayerInfo.html#levelNumberField) */ levelNumberField: string; /** * The field name from the layer that defines the level name of a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LevelLayerInfo.html#longNameField) */ longNameField: string; /** * The field name from the layer that defines the level short name of a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LevelLayerInfo.html#shortNameField) */ shortNameField: string; /** * This value references the numeric ID of the sublayer if the Level layer is a map service sublayer instead of a feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LevelLayerInfo.html#sublayerId) */ sublayerId: number; /** * The field name from the layer that defines the order of display and reference to floors in the [Indoor Positioning System](https://doc.arcgis.com/en/indoors/android/configure-indoor-positioning.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LevelLayerInfo.html#verticalOrderField) */ verticalOrderField: string; /** * The LevelLayerInfo class describes the footprint of each occupiable floor contained in a managed facility. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LevelLayerInfo.html) */ constructor(properties?: LevelLayerInfoProperties); static fromJSON(json: any): LevelLayerInfo; } interface LevelLayerInfoProperties { /** * The field name from the layer that defines the unique ID of a feature's associated facility. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LevelLayerInfo.html#facilityIdField) */ facilityIdField?: string; /** * The id for an operational layer in the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LevelLayerInfo.html#layerId) */ layerId?: string; /** * The field name from the layer that defines a unique ID for the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LevelLayerInfo.html#levelIdField) */ levelIdField?: string; /** * The field name from the layer that defines the level floor number in a particular facility. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LevelLayerInfo.html#levelNumberField) */ levelNumberField?: string; /** * The field name from the layer that defines the level name of a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LevelLayerInfo.html#longNameField) */ longNameField?: string; /** * The field name from the layer that defines the level short name of a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LevelLayerInfo.html#shortNameField) */ shortNameField?: string; /** * This value references the numeric ID of the sublayer if the Level layer is a map service sublayer instead of a feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LevelLayerInfo.html#sublayerId) */ sublayerId?: number; /** * The field name from the layer that defines the order of display and reference to floors in the [Indoor Positioning System](https://doc.arcgis.com/en/indoors/android/configure-indoor-positioning.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LevelLayerInfo.html#verticalOrderField) */ verticalOrderField?: string; } export class LocalMediaElementSource extends Accessor { /** * [Image](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html) and [video](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VideoElement.html) elements referenced in the [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LocalMediaElementSource.html#elements) */ elements: Collection; /** * The LocalMediaElementSource is the default [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#source) for the MediaLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LocalMediaElementSource.html) */ constructor(properties?: LocalMediaElementSourceProperties); } interface LocalMediaElementSourceProperties { /** * [Image](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html) and [video](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VideoElement.html) elements referenced in the [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LocalMediaElementSource.html#elements) */ elements?: | CollectionProperties< (ImageElementProperties & { type: "image" }) | (VideoElementProperties & { type: "video" }) > | ((ImageElementProperties & { type: "image" }) | (VideoElementProperties & { type: "video" }))[]; } /** * Image and video elements referenced in the MediaLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LocalMediaElementSource.html#MediaElement) */ export type MediaElement = ImageElement | VideoElement; export interface LOD extends Accessor, JSONSupport { } export class LOD { /** * ID for each level. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LOD.html#level) */ level: number; /** * String to be used when constructing a URL to access a tile from this LOD. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LOD.html#levelValue) */ levelValue: string; /** * Resolution in map units of each pixel in a tile for each level. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LOD.html#resolution) */ resolution: number; /** * Scale for each level. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LOD.html#scale) */ scale: number; /** * A [TileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html) has a number of LODs (Levels of Detail). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LOD.html) */ constructor(properties?: LODProperties); static fromJSON(json: any): LOD; } interface LODProperties { /** * ID for each level. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LOD.html#level) */ level?: number; /** * String to be used when constructing a URL to access a tile from this LOD. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LOD.html#levelValue) */ levelValue?: string; /** * Resolution in map units of each pixel in a tile for each level. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LOD.html#resolution) */ resolution?: number; /** * Scale for each level. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LOD.html#scale) */ scale?: number; } export interface MapImage extends Accessor, JSONSupport { } export class MapImage { /** * The extent of the exported map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#extent) */ extent: Extent; /** * The requested image height in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#height) */ height: number; /** * URL to the returned image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#href) */ href: "gif" | "jpg" | "png" | "bmp"; /** * The opacity of the image. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#opacity) */ opacity: number; /** * Scale of the requested dynamic map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#scale) */ scale: number; /** * Indicates if the requested image is visible in the view. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#visible) */ visible: boolean; /** * The requested image width in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#width) */ width: number; /** * Represents the data object for the dynamically generated map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html) */ constructor(properties?: MapImageProperties); static fromJSON(json: any): MapImage; } interface MapImageProperties { /** * The extent of the exported map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#extent) */ extent?: ExtentProperties; /** * The requested image height in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#height) */ height?: number; /** * URL to the returned image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#href) */ href?: "gif" | "jpg" | "png" | "bmp"; /** * The opacity of the image. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#opacity) */ opacity?: number; /** * Scale of the requested dynamic map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#scale) */ scale?: number; /** * Indicates if the requested image is visible in the view. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#visible) */ visible?: boolean; /** * The requested image width in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#width) */ width?: number; } export class MediaElementBase { /** * The geographic location of the image or video element to be placed on the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MediaElementBase.html#georeference) */ georeference: ExtentAndRotationGeoreference | CornersGeoreference | ControlPointsGeoreference; /** * The opacity of the element. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MediaElementBase.html#opacity) */ opacity: number; } interface MediaElementBaseProperties { /** * The geographic location of the image or video element to be placed on the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MediaElementBase.html#georeference) */ georeference?: | (ExtentAndRotationGeoreferenceProperties & { type: "extent-and-rotation" }) | (CornersGeoreferenceProperties & { type: "corners" }) | (ControlPointsGeoreferenceProperties & { type: "control-points" }); /** * The opacity of the element. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MediaElementBase.html#opacity) */ opacity?: number; } export interface MosaicRule extends Accessor, JSONSupport { } export class MosaicRule { /** * Indicates whether the sort should be ascending. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#ascending) */ ascending: boolean; /** * The raster function applied on items before mosaicking. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#itemRasterFunction) */ itemRasterFunction: RasterFunction; /** * The raster function applied on items before mosaicking. * * @deprecated since version 4.27. Use {@link module:esri/layers/support/MosaicRule#itemRasterFunction itemRasterFunction} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#itemRenderingRule) */ itemRenderingRule: void; /** * An array of raster Ids. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#lockRasterIds) */ lockRasterIds: number[]; /** * The mosaic method determines how the selected rasters are ordered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#method) */ method: "none" | "center" | "nadir" | "viewpoint" | "attribute" | "lock-raster" | "northwest" | "seamline"; /** * The multidimensional definitions associated with the [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#mosaicRule). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#multidimensionalDefinition) */ multidimensionalDefinition: DimensionalDefinition[]; /** * Defines a selection using a set of ObjectIDs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#objectIds) */ objectIds: number[]; /** * Defines the mosaic operation used to resolve overlapping pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#operation) */ operation: "first" | "last" | "min" | "max" | "mean" | "blend" | "sum"; /** * The name of the attribute field that is used with a constant sortValue to define the mosaicking order when the mosaic [method](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#method) is set to `attribute`. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#sortField) */ sortField: string; /** * A constant value defining a reference or base value for the sort field when the mosaic [method](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#method) is set to `attribute`. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#sortValue) */ sortValue: string | number; /** * Defines the viewpoint location on which the ordering is defined based on the distance from the viewpoint and the nadir of rasters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#viewpoint) */ viewpoint: Point; /** * The where clause determines which rasters will participate in the mosaic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#where) */ where: string; /** * Specifies the mosaic rule when defining how individual images should be mosaicked. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html) */ constructor(properties?: MosaicRuleProperties); /** * Creates a clone of the MosaicRule object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#clone) */ clone(): MosaicRule; static fromJSON(json: any): MosaicRule; } interface MosaicRuleProperties { /** * Indicates whether the sort should be ascending. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#ascending) */ ascending?: boolean; /** * The raster function applied on items before mosaicking. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#itemRasterFunction) */ itemRasterFunction?: RasterFunctionProperties; /** * The raster function applied on items before mosaicking. * * @deprecated since version 4.27. Use {@link module:esri/layers/support/MosaicRule#itemRasterFunction itemRasterFunction} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#itemRenderingRule) */ itemRenderingRule?: void; /** * An array of raster Ids. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#lockRasterIds) */ lockRasterIds?: number[]; /** * The mosaic method determines how the selected rasters are ordered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#method) */ method?: "none" | "center" | "nadir" | "viewpoint" | "attribute" | "lock-raster" | "northwest" | "seamline"; /** * The multidimensional definitions associated with the [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#mosaicRule). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#multidimensionalDefinition) */ multidimensionalDefinition?: DimensionalDefinitionProperties[]; /** * Defines a selection using a set of ObjectIDs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#objectIds) */ objectIds?: number[]; /** * Defines the mosaic operation used to resolve overlapping pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#operation) */ operation?: "first" | "last" | "min" | "max" | "mean" | "blend" | "sum"; /** * The name of the attribute field that is used with a constant sortValue to define the mosaicking order when the mosaic [method](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#method) is set to `attribute`. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#sortField) */ sortField?: string; /** * A constant value defining a reference or base value for the sort field when the mosaic [method](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#method) is set to `attribute`. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#sortValue) */ sortValue?: string | number; /** * Defines the viewpoint location on which the ordering is defined based on the distance from the viewpoint and the nadir of rasters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#viewpoint) */ viewpoint?: PointProperties; /** * The where clause determines which rasters will participate in the mosaic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#where) */ where?: string; } export interface MultidimensionalSubset extends Accessor, JSONSupport { } export class MultidimensionalSubset { /** * The spatial area of interest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MultidimensionalSubset.html#areaOfInterest) */ areaOfInterest: Extent | Polygon; /** * The aggregated dimension names and their extents or ranges computed from the [subsetDefinitions](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MultidimensionalSubset.html#subsetDefinitions). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MultidimensionalSubset.html#dimensions) */ readonly dimensions: SubsetDimension[]; /** * The variable and dimension subset definitions to set the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MultidimensionalSubset.html#subsetDefinitions) */ subsetDefinitions: DimensionalDefinition[]; /** * The aggregated variables list computed from the [subsetDefinitions](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MultidimensionalSubset.html#subsetDefinitions). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MultidimensionalSubset.html#variables) */ readonly variables: string[]; /** * A subset of multidimensional raster data created by slicing the data along defined variables and dimensions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MultidimensionalSubset.html) */ constructor(properties?: MultidimensionalSubsetProperties); /** * Creates a deep clone of the MultidimensionalSubset object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MultidimensionalSubset.html#clone) */ clone(): MultidimensionalSubset; static fromJSON(json: any): MultidimensionalSubset; } interface MultidimensionalSubsetProperties { /** * The spatial area of interest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MultidimensionalSubset.html#areaOfInterest) */ areaOfInterest?: (ExtentProperties & { type: "extent" }) | (PolygonProperties & { type: "polygon" }); /** * The variable and dimension subset definitions to set the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MultidimensionalSubset.html#subsetDefinitions) */ subsetDefinitions?: DimensionalDefinitionProperties[]; } /** * Dimension name and its extent or range computed from the [subsetDefinitions](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MultidimensionalSubset.html#subsetDefinitions) and it is added to [dimensions](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MultidimensionalSubset.html#dimensions). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MultidimensionalSubset.html#SubsetDimension) */ export interface SubsetDimension { /** * The dimension name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MultidimensionalSubset.html#SubsetDimension) */ name: string; /** * The computed extent or ranges for the given dimension. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MultidimensionalSubset.html#SubsetDimension) */ extent: number[]; } export class PixelBlock extends Accessor { /** * The height (or number of rows) of the PixelBlock in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#height) */ height: number; /** * An array of nodata mask. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#mask) */ mask: number[] | Uint8Array; /** * Indicates whether mask should be used as alpha values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#maskIsAlpha) */ maskIsAlpha: boolean; /** * A two dimensional array representing the pixels from the Image Service displayed on the client. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixels) */ pixels: | number[][] | Int8Array[] | Uint8Array[] | Uint8ClampedArray[] | Int16Array[] | Uint16Array[] | Int32Array[] | Uint32Array[] | Float32Array[] | Float64Array[]; /** * The pixel type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixelType) */ pixelType: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; /** * An array of objects containing numeric statistical properties. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#statistics) */ statistics: PixelBlockStatistics[]; /** * Number of valid pixels * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#validPixelCount) */ validPixelCount: number; /** * The width (or number of columns) of the PixelBlock in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#width) */ width: number; /** * An object representing the pixel arrays in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html) */ constructor(properties?: PixelBlockProperties); /** * Adds another plane to the PixelBlock. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#addData) */ addData(planeData: PixelBlockAddDataPlaneData): void; /** * Returns pixels and masks using a single array in bip format (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#getAsRGBA) */ getAsRGBA(): Uint8ClampedArray; /** * Similar to [getAsRGBA](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#getAsRGBA), but returns floating point data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#getAsRGBAFloat) */ getAsRGBAFloat(): Float32Array; /** * Returns the plane band count of the PixelBlock. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#getPlaneCount) */ getPlaneCount(): number; } interface PixelBlockProperties { /** * The height (or number of rows) of the PixelBlock in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#height) */ height?: number; /** * An array of nodata mask. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#mask) */ mask?: number[] | Uint8Array; /** * Indicates whether mask should be used as alpha values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#maskIsAlpha) */ maskIsAlpha?: boolean; /** * A two dimensional array representing the pixels from the Image Service displayed on the client. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixels) */ pixels?: | number[][] | Int8Array[] | Uint8Array[] | Uint8ClampedArray[] | Int16Array[] | Uint16Array[] | Int32Array[] | Uint32Array[] | Float32Array[] | Float64Array[]; /** * The pixel type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixelType) */ pixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; /** * An array of objects containing numeric statistical properties. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#statistics) */ statistics?: PixelBlockStatistics[]; /** * Number of valid pixels * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#validPixelCount) */ validPixelCount?: number; /** * The width (or number of columns) of the PixelBlock in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#width) */ width?: number; } export interface PixelBlockAddDataPlaneData { /** * A two dimensional array representing the pixels to add. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#addData) */ pixels: number[][]; /** * An array of objects containing numeric statistical properties. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#addData) */ statistics: any[]; } export interface PixelBlockStatistics { /** * The maximum pixel value in the [pixels](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixels) array. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#statistics) */ maxValue?: number; /** * The minimum pixel value in the [pixels](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixels) array. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#statistics) */ minValue?: number; /** * Value representing areas of no data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#statistics) */ noDataValue?: number; } export class PublishingInfo extends Accessor { /** * Layer's publishing status while the layer is being published to the portal. * * @default "unknown" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PublishingInfo.html#status) */ readonly status: "unknown" | "unavailable" | "publishing" | "published"; /** * Indicates if the layer's status is still being updated. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PublishingInfo.html#updating) */ readonly updating: boolean; /** * This stops when the status has been determined or when the layer is destroyed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PublishingInfo.html) */ constructor(properties?: PublishingInfoProperties); } interface PublishingInfoProperties { } export class RangeDomain extends Domain { /** * The maximum valid value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RangeDomain.html#maxValue) */ maxValue: number | string; /** * The minimum valid value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RangeDomain.html#minValue) */ minValue: number | string; /** * The domain type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RangeDomain.html#type) */ readonly type: "range"; /** * Range domains specify a valid [minimum](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RangeDomain.html#minValue) and [maximum](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RangeDomain.html#maxValue) valid value that can be stored in numeric and date [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#type). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RangeDomain.html) */ constructor(properties?: RangeDomainProperties); static fromJSON(json: any): RangeDomain; } interface RangeDomainProperties extends DomainProperties { /** * The maximum valid value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RangeDomain.html#maxValue) */ maxValue?: number | string; /** * The minimum valid value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RangeDomain.html#minValue) */ minValue?: number | string; } export interface RasterBandInfo extends Accessor, JSONSupport { } export class RasterBandInfo { /** * The maximum wavelength of the band. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterBandInfo.html#maxWavelength) */ maxWavelength: number; /** * The minimum wavelength of the band. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterBandInfo.html#minWavelength) */ minWavelength: number; /** * The name of the band. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterBandInfo.html#name) */ name: string; /** * The radiance bias of the band. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterBandInfo.html#radianceBias) */ radianceBias: number; /** * The radiance gain of the band. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterBandInfo.html#radianceGain) */ radianceGain: number; /** * The reflectance bias of the band. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterBandInfo.html#reflectanceBias) */ reflectanceBias: number; /** * The reflectance gain of the band. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterBandInfo.html#reflectanceGain) */ reflectanceGain: number; /** * The solar irradiance of the band. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterBandInfo.html#solarIrradiance) */ solarIrradiance: number; /** * referenced by [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#serviceRasterInfo) or [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#rasterInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterBandInfo.html) */ constructor(properties?: RasterBandInfoProperties); /** * Creates a deep clone of the raster band info object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterBandInfo.html#clone) */ clone(): RasterBandInfo; static fromJSON(json: any): RasterBandInfo; } interface RasterBandInfoProperties { /** * The maximum wavelength of the band. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterBandInfo.html#maxWavelength) */ maxWavelength?: number; /** * The minimum wavelength of the band. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterBandInfo.html#minWavelength) */ minWavelength?: number; /** * The name of the band. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterBandInfo.html#name) */ name?: string; /** * The radiance bias of the band. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterBandInfo.html#radianceBias) */ radianceBias?: number; /** * The radiance gain of the band. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterBandInfo.html#radianceGain) */ radianceGain?: number; /** * The reflectance bias of the band. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterBandInfo.html#reflectanceBias) */ reflectanceBias?: number; /** * The reflectance gain of the band. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterBandInfo.html#reflectanceGain) */ reflectanceGain?: number; /** * The solar irradiance of the band. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterBandInfo.html#solarIrradiance) */ solarIrradiance?: number; } export interface RasterFunction extends Accessor, JSONSupport { } export class RasterFunction { /** * The arguments for the raster function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html#functionArguments) */ functionArguments: any; /** * The raster function name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html#functionName) */ functionName: string; /** * Defines the pixel type of the output image. * * @default unknown * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html#outputPixelType) */ outputPixelType: | "c128" | "c64" | "f32" | "f64" | "s16" | "s32" | "s8" | "u1" | "u16" | "u2" | "u32" | "u4" | "u8" | "unknown"; /** * Property where Raster Function template is passed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html#rasterFunctionDefinition) */ rasterFunctionDefinition: any; /** * The variable name for the raster function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html#variableName) */ variableName: string; /** * Raster functions specify processing to be done to the image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html) */ constructor(properties?: RasterFunctionProperties); /** * Creates a deep clone of the raster function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html#clone) */ clone(): RasterFunction; static fromJSON(json: any): RasterFunction; } interface RasterFunctionProperties { /** * The arguments for the raster function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html#functionArguments) */ functionArguments?: any; /** * The raster function name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html#functionName) */ functionName?: string; /** * Defines the pixel type of the output image. * * @default unknown * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html#outputPixelType) */ outputPixelType?: | "c128" | "c64" | "f32" | "f64" | "s16" | "s32" | "s8" | "u1" | "u16" | "u2" | "u32" | "u4" | "u8" | "unknown"; /** * Property where Raster Function template is passed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html#rasterFunctionDefinition) */ rasterFunctionDefinition?: any; /** * The variable name for the raster function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html#variableName) */ variableName?: string; } /** * Various constant values used by different raster functions when setting [ImageryTileLayer.rasterFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#rasterFunction) or [ImageryLayer.rasterFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#rasterFunction) properties. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html) */ interface rasterFunctionConstants { /** * Method name constants used by the [band index raster functions](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#ESRI_SECTION1_4D75298B90D94E6B87B0C9F28D5AE269). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ readonly bandIndexType: rasterFunctionConstantsBandIndexType; /** * The local cell statistics operations type constants. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#cellStatisticalOperation) */ readonly cellStatisticalOperation: rasterFunctionConstantsCellStatisticalOperation; /** * Predefined raster color map name constants used for the [Colormap raster function](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#GUID-5DDFC961-A857-445F-A983-13AF67D45833). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colormapName) */ readonly colormapName: rasterFunctionConstantsColormapName; /** * Predefined raster color ramp name constants used for the [Colormap raster function](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#GUID-5DDFC961-A857-445F-A983-13AF67D45833). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ readonly colorRampName: rasterFunctionConstantsColorRampName; /** * Kernel type constants used for the [Convolution raster function](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#ESRI_SECTION1_B69A71FDFD7C46A6860A7302A9AD3B17). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ readonly convolutionKernel: rasterFunctionConstantsConvolutionKernel; /** * The local arithmetic operations types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localArithmeticOperation) */ localArithmeticOperation: rasterFunctionConstantsLocalArithmeticOperation; /** * The local conditional operations type constants. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localConditionalOperation) */ readonly localConditionalOperation: rasterFunctionConstantsLocalConditionalOperation; /** * The local logical operations type constants. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localLogicalOperation) */ readonly localLogicalOperation: rasterFunctionConstantsLocalLogicalOperation; /** * The local trigonometric operations type constants. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localTrigonometricOperation) */ readonly localTrigonometricOperation: rasterFunctionConstantsLocalTrigonometricOperation; /** * The missing band action constants available for the [Extract band raster function](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#ESRI_SECTION1_2FC6FEAA2801446B9578A7C90B1DD6AB). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#missingBandAction) */ readonly missingBandAction: rasterFunctionConstantsMissingBandAction; /** * The NoData interpretation constants used for the [Mask raster function](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#ESRI_SECTION1_5515B13D320B408B9F70B9B8344028FF). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#noDataInterpretation) */ readonly noDataInterpretation: rasterFunctionConstantsNoDataInterpretation; /** * Slope type constants used for the [slope raster function](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#ESRI_SECTION1_641F092319AE46D1A9441F8D1FDF186C). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#slopeType) */ readonly slopeType: rasterFunctionConstantsSlopeType; /** * Stretch type constants used for the [stretch raster function](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#ESRI_SECTION1_7545363F0B8A4B7B931A54B3C4189D9D). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#stretchType) */ readonly stretchType: rasterFunctionConstantsStretchType; } export const rasterFunctionConstants: rasterFunctionConstants; export interface rasterFunctionConstantsBandIndexType { /** * User defined method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ userDefined: number; /** * The Normalized Difference Vegetation Index (NDVI) method is a standardized index allowing you to generate an image displaying greenness (relative biomass). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ NDVI: number; /** * The Red-Edge NDVI (NDVIre) method is a vegetation index for estimating vegetation health using the red-edge band. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ NDVIRe: number; /** * The Burn Area Index (BAI) uses the reflectance values in the red and NIR portion of the spectrum to identify the areas of the terrain affected by fire. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ BAI: number; /** * The Normalized Burn Ratio Index (NBRI) uses the NIR and SWIR bands to emphasize burned areas, while mitigating illumination and atmospheric effects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ NBR: number; /** * The Normalized Difference Built-up Index (NDBI) uses the NIR and SWIR bands to emphasize manufactured built-up areas. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ NDBI: number; /** * The Normalized Difference Moisture Index (NDMI) is sensitive to the moisture levels in vegetation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ NDMI: number; /** * The Normalized Difference Snow Index (NDSI) is designed to use MODIS (band 4 and band 6) and Landsat TM (band 2 and band 5) for identification of snow cover while ignoring cloud cover. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ NDSI: number; /** * The Global Environmental Monitoring Index (GEMI) method is a nonlinear vegetation index for global environmental monitoring from satellite imagery. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ GEMI: number; /** * The Green Vegetation Index (GVI) method was originally designed from Landsat MSS imagery and has been modified for Landsat TM imagery. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ GVITM: number; /** * The Perpendicular Vegetation Index (PVI) method is similar to a difference vegetation index; however, it is sensitive to atmospheric variations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ PVI: string; /** * The Sultan's process takes a six-band 8-bit image and uses the Sultan's Formula method to produce a three-band 8-bit image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ Sultan: number; /** * The Visible Atmospherically Resistant Index (VARI) method is a vegetation index for estimating vegetation fraction quantitatively with only the visible range of the spectrum. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ VARI: number; /** * The Green Normalized Difference Vegetation Index (GNDVI) method is a vegetation index for estimating photo synthetic activity and is a commonly used vegetation index to determine water and nitrogen uptake into the plant canopy. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ GNDVI: number; /** * The Soil-Adjusted Vegetation Index (SAVI) method is a vegetation index that attempts to minimize soil brightness influences using a soil-brightness correction factor. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ SAVI: number; /** * The Transformed Soil Adjusted Vegetation Index (TSAVI) method is a vegetation index that minimizes soil brightness influences by assuming the soil line has an arbitrary slope and intercept. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ TSAVI: number; /** * The Modified Soil Adjusted Vegetation Index (MSAVI) method minimizes the effect of bare soil on the SAVI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ MSAVI: number; /** * The Simple Ratio (SR) method is a common vegetation index for estimating the amount of vegetation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ SR: number; /** * The Red-Edge Simple Ratio (SRre) method is a vegetation index for estimating the amount of healthy and stressed vegetation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ SRRe: number; /** * The Modified Triangular Vegetation Index (MTVI2) method is a vegetation index for detecting leaf chlorophyll content at the canopy scale while being relatively insensitive to leaf area index. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ MTVI2: number; /** * The Red-Edge Triangulated Vegetation Index (RTVICore) method is a vegetation index for estimating leaf area index and biomass. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ RTVICore: number; /** * The Chlorophyll Index - Red-Edge (CIre) method is a vegetation index for estimating the chlorophyll content in leaves using the ratio of reflectivity in the NIR and red-edge bands. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ CIRe: number; /** * Chlorophyll index - Green (CIG) method is a vegetation index for estimating the chlorophyll content in leaves using the ratio of reflectivity in the NIR and green bands. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ CIG: number; /** * The Enhanced Vegetation Index (EVI) method is an optimized vegetation index that accounts for atmospheric influences and vegetation background signal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ EVI: number; /** * The Iron Oxide (ironOxide) ratio method is a geological index for identifying rock features that have experienced oxidation of iron-bearing sulfides using the red and blue bands. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ ironOxide: number; /** * The Ferrous Minerals (ferrousMinerals) ratio method is a geological index for identifying rock features containing some quantity of iron-bearing minerals using the SWIR and NIR bands. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ ferrousMinerals: number; /** * The Clay Minerals (clayMinerals) ratio method is a geological index for identifying mineral features containing clay and alunite using two shortwave infrared (SWIR) bands. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ clayMinerals: number; /** * The Normalized Difference Water Index (NDWI) method is an index for delineating and monitoring content changes in surface water. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ NDWI: number; /** * The Weighted Normalized Difference Water Index (WNDWI) method is a water index developed to reduce errors typically encountered in other water indices, including water turbidity, small water bodies, or shadow in remote sensing scenes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ WNDWI: number; /** * The Modified Normalized Difference Water Index (MNDWI) uses green and SWIR bands for the enhancement of open water features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#bandIndexType) */ MNDWI: number; } export interface rasterFunctionConstantsCellStatisticalOperation { /** * Determines the majority (value that occurs most often) of the inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#cellStatisticalOperation) */ majority: number; /** * Determines the maximum (largest value) of the inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#cellStatisticalOperation) */ max: number; /** * Determines the mean (average value) of the inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#cellStatisticalOperation) */ mean: number; /** * Calculates the median of the inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#cellStatisticalOperation) */ med: number; /** * Determines the minimum (smallest value) of the inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#cellStatisticalOperation) */ min: number; /** * Determines the minority (value that occurs least often) of the inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#cellStatisticalOperation) */ minority: number; /** * Calculates the range (difference between largest and smallest value) of the inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#cellStatisticalOperation) */ range: number; /** * Calculates the standard deviation of the inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#cellStatisticalOperation) */ stddev: number; /** * Calculates the sum (total of all values) of the inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#cellStatisticalOperation) */ sum: number; /** * Calculates the variety (number of unique values) of the inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#cellStatisticalOperation) */ variety: number; /** * Determines the majority (value that occurs most often) of the inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#cellStatisticalOperation) */ majorityIgnoreNoData: number; /** * Determines the maximum (largest value) of the inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#cellStatisticalOperation) */ maxIgnoreNoData: number; /** * Determines the mean (average value) of the inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#cellStatisticalOperation) */ meanIgnoreNoData: number; /** * Determines the median of the inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#cellStatisticalOperation) */ medIgnoreNoData: number; /** * Determines the minimum (smallest value) of the inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#cellStatisticalOperation) */ minIgnoreNoData: number; /** * Determines the minority (value that occurs least often) of the inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#cellStatisticalOperation) */ minorityIgnoreNoData: number; /** * Calculates the range (difference between largest and smallest value) of the inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#cellStatisticalOperation) */ rangeIgnoreNoData: number; /** * Calculates the standard deviation of the inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#cellStatisticalOperation) */ stddevIgnoreNoData: number; /** * Calculates the sum (total of all values) of the inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#cellStatisticalOperation) */ sumIgnoreNoData: number; /** * Calculates the variety (number of unique values) of the inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#cellStatisticalOperation) */ varietyIgnoreNoData: number; } export interface rasterFunctionConstantsColormapName { /** * A random colormap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colormapName) */ random: string; /** * colormap to visualize vegetation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colormapName) */ NDVI: string; /** * A colormap to visualize vegetation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colormapName) */ NDVI2: string; /** * A colormap to visualize vegetation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colormapName) */ NDVI3: string; /** * A color map that gradually changes from cyan to purple to black. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colormapName) */ elevation: string; /** * A color map that gradually changes from black to white. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colormapName) */ gray: string; /** * A colormap to visualize a hillshade product. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colormapName) */ hillshade: string; } export interface rasterFunctionConstantsColorRampName { /** * Aspect. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ aspect: string; /** * Black to White. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ blackToWhite: string; /** * Blue Bright. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ blueBright: string; /** * Blue Light to Dark. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ blueLightToDark: string; /** * Blue-Green Bright. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ blueGreenBright: string; /** * Blue-Green Light to Dark. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ blueGreenLightToDark: string; /** * Brown Light to Dark. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ brownLightToDark: string; /** * Brown to Blue Green Diverging. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ brownToBlueGreenDivergingBright: string; /** * Brown to Blue Green Diverging. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ brownToBlueGreenDivergingDark: string; /** * Coefficient Bias. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ coefficientBias: string; /** * Cold to Hot Diverging. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ coldToHotDiverging: string; /** * Condition Number. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ conditionNumber: string; /** * Cyan to Purple. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ cyanToPurple: string; /** * Cyan-Light to Blue-Dark. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ cyanLightToBlueDark: string; /** * Distance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ distance: string; /** * Elevation #1. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ elevation1: string; /** * Elevation #2. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ elevation2: string; /** * Errors. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ errors: string; /** * Gray Light to Dark. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ grayLightToDark: string; /** * Green Bright. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ greenBright: string; /** * Green Light to Dark. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ greenLightToDark: string; /** * Green to Blue. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ greenToBlue: string; /** * Orange Bright. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ orangeBright: string; /** * Orange Light to Dark. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ orangeLightToDark: string; /** * Partial Spectrum. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ partialSpectrum: string; /** * Partial Spectrum 1 Diverging. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ partialSpectrum1Diverging: string; /** * Partial Spectrum 2 Diverging. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ partialSpectrum2Diverging: string; /** * Pink to YellowGreen Diverging. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ pinkToYellowGreenDivergingBright: string; /** * Pink to YellowGreen Diverging. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ pinkToYellowGreenDivergingDark: string; /** * Precipitation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ precipitation: string; /** * Prediction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ prediction: string; /** * Purple Bright. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ purpleBright: string; /** * Purple to Green Diverging. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ purpleToGreenDivergingBright: string; /** * Purple to Green Diverging. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ purpleToGreenDivergingDark: string; /** * Purple-Blue Bright. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ purpleBlueBright: string; /** * Purple-Blue Light to Dark. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ purpleBlueLightToDark: string; /** * Purple-Red Bright. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ purpleRedBright: string; /** * Purple-Red Light to Dark. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ purpleRedLightToDark: string; /** * Red Bright. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ redBright: string; /** * Red Light to Dark. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ redLightToDark: string; /** * Red to Blue Diverging. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ redToBlueDivergingBright: string; /** * Red to Blue Diverging. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ redToBlueDivergingDark: string; /** * Red to Green. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ redToGreen: string; /** * Red to Green Diverging. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ redToGreenDivergingBright: string; /** * Red to Green Diverging. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ redToGreenDivergingDark: string; /** * Slope. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ slope: string; /** * Spectrum-Full Bright. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ spectrumFullBright: string; /** * Spectrum-Full Dark. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ spectrumFullDark: string; /** * Spectrum-Full Light. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ spectrumFullLight: string; /** * Surface. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ surface: string; /** * Temperature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ temperature: string; /** * White to Black. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ whiteToBlack: string; /** * Yellow to Dark Red. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ yellowToDarkRed: string; /** * Yellow to Green to Dark Blue. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ yellowToGreenToDarkBlue: string; /** * Yellow to Red. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ yellowToRed: string; /** * Yellow-Green Bright. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ yellowGreenBright: string; /** * Yellow-Green Light to Dark. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#colorRampName) */ yellowGreenLightToDark: string; } export interface rasterFunctionConstantsConvolutionKernel { /** * User defined kernel type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ userDefined: number; /** * Horizontal line detection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ lineDetectionHorizontal: number; /** * Vertical line detection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ lineDetectionVertical: number; /** * Left diagonal line detection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ lineDetectionLeftDiagonal: number; /** * Right diagonal line detection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ lineDetectionRightDiagonal: number; /** * North gradient detection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ gradientNorth: number; /** * West gradient detection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ gradientWest: number; /** * East gradient detection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ gradientEast: number; /** * South gradient detection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ gradientSouth: number; /** * North east gradient detection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ gradientNorthEast: number; /** * North west gradient detection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ gradientNorthWest: number; /** * Smooths the data by reducing local variation and removing noise. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ smoothArithmeticMean: number; /** * Smooths (low-pass) the data by reducing local variation and removing noise. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ smoothing3x3: number; /** * Smooths (low-pass) the data by reducing local variation and removing noise. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ smoothing5x5: number; /** * Sharpens the date by calculating the focal sum statistic for each cell of the input using a weighted kernel neighborhood. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ sharpen: number; /** * Sharpens the date by calculating the focal sum statistic for each cell of the input using a weighted kernel neighborhood. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ sharpen2: number; /** * Sharpens the date by calculating the focal sum statistic for each cell of the input using a weighted kernel neighborhood. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ sharpening3x3: number; /** * Sharpens the date by calculating the focal sum statistic for each cell of the input using a weighted kernel neighborhood. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ sharpening5x5: number; /** * Laplacian filters are often used for edge detection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ laplacian3x3: number; /** * Laplacian filters are often used for edge detection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ laplacian5x5: number; /** * The horizontal Sobel filter is used for edge detection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ sobelHorizontal: number; /** * The vertical Sobel filter is used for edge detection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ sobelVertical: number; /** * The point spread function portrays the distribution of light from a point source through a lense. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ pointSpread: number; /** * No kernel type is specified. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#convolutionKernel) */ none: number; } export interface rasterFunctionConstantsLocalArithmeticOperation { /** * Adds (sums) the values of two rasters on a cell-by-cell basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localArithmeticOperation) */ plus: number; /** * Subtracts the value of the second input raster from the value of the first input raster on a cell-by-cell basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localArithmeticOperation) */ minus: number; /** * Multiplies the values of two rasters on a cell-by-cell basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localArithmeticOperation) */ times: number; /** * Calculates the square root of the cell values in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localArithmeticOperation) */ sqrt: number; /** * Raises the cell values in a raster to the power of the values found in another raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localArithmeticOperation) */ power: number; /** * Calculates the absolute value of the cells in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localArithmeticOperation) */ abs: number; /** * Divides the values of two rasters on a cell-by-cell basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localArithmeticOperation) */ divide: number; /** * Calculates the base e exponential of the cells in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localArithmeticOperation) */ exp: number; /** * Calculates the base 10 exponential of the cells in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localArithmeticOperation) */ exp10: number; /** * Calculates the base 2 exponential of the cells in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localArithmeticOperation) */ exp2: number; /** * Converts each cell value of a raster to an integer by truncation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localArithmeticOperation) */ int: number; /** * Converts each cell value of a raster into a floating-point representation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localArithmeticOperation) */ float: number; /** * Calculates the natural logarithm (base e) of cells in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localArithmeticOperation) */ ln: number; /** * Calculates the base 10 logarithm of cells in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localArithmeticOperation) */ log10: number; /** * Calculates the base 2 logarithm of cells in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localArithmeticOperation) */ log2: number; /** * Finds the remainder (modulo) of the first raster when divided by the second raster on a cell-by-cell basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localArithmeticOperation) */ mod: number; /** * Changes the sign (multiplies by -1) of the cell values of the input raster on a cell-by-cell basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localArithmeticOperation) */ negate: number; /** * Returns the next lower integer value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localArithmeticOperation) */ roundDown: number; /** * Returns the next higher integer value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localArithmeticOperation) */ roundUp: number; /** * Calculates the square of the cell values in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localArithmeticOperation) */ square: number; } export interface rasterFunctionConstantsLocalConditionalOperation { /** * Set Null sets identified cell locations to NoData based on a specified criteria. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localConditionalOperation) */ setNull: number; /** * Performs a conditional If, Then, Else operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localConditionalOperation) */ conditional: number; } export interface rasterFunctionConstantsLocalLogicalOperation { /** * Performs a Bitwise And operation on the binary values of two input rasters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localLogicalOperation) */ bitwiseAnd: number; /** * Performs a Bitwise Left Shift operation on the binary values of two input rasters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localLogicalOperation) */ bitwiseLeftShift: number; /** * Performs a Bitwise Not (complement) operation on the binary value of an input raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localLogicalOperation) */ bitwiseNot: number; /** * Performs a Bitwise Or operation on the binary values of two input rasters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localLogicalOperation) */ bitwiseOr: number; /** * Performs a Bitwise Right Shift operation on the binary values of two input rasters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localLogicalOperation) */ bitwiseRightShift: number; /** * Performs a Bitwise eXclusive Or operation on the binary values of two input rasters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localLogicalOperation) */ bitwiseXOr: number; /** * Performs a Boolean And operation on the cell values of two input rasters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localLogicalOperation) */ booleanAnd: number; /** * Performs a Boolean Not (complement) operation on the cell values of the input raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localLogicalOperation) */ booleanNot: number; /** * Performs a Boolean Or operation on the cell values of two input rasters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localLogicalOperation) */ booleanOr: number; /** * Performs a Boolean eXclusive Or operation on the cell values of two input rasters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localLogicalOperation) */ booleanXOr: number; /** * Performs a Relational equal-to operation on two inputs on a cell-by-cell basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localLogicalOperation) */ equalTo: number; /** * Performs a Relational greater-than operation on two inputs on a cell-by-cell basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localLogicalOperation) */ greaterThan: number; /** * Performs a Relational greater-than-or-equal-to operation on two inputs on a cell-by-cell basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localLogicalOperation) */ greaterThanEqual: number; /** * Performs a Relational less-than operation on two inputs on a cell-by-cell basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localLogicalOperation) */ lessThan: number; /** * Performs a Relational less-than-or-equal-to operation on two inputs on a cell-by-cell basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localLogicalOperation) */ lessThanEqual: number; /** * Determines which values from the input raster are NoData on a cell-by-cell basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localLogicalOperation) */ isNull: number; /** * Performs a Relational not-equal-to operation on two inputs on a cell-by-cell basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localLogicalOperation) */ notEqual: number; } export interface rasterFunctionConstantsLocalTrigonometricOperation { /** * Calculates the inverse cosine of cells in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localTrigonometricOperation) */ acos: number; /** * Calculates the inverse sine of cells in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localTrigonometricOperation) */ asin: number; /** * Calculates the inverse tangent of cells in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localTrigonometricOperation) */ atan: number; /** * Calculates the inverse hyperbolic tangent of cells in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localTrigonometricOperation) */ atanh: number; /** * Calculates the cosine of cells in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localTrigonometricOperation) */ cos: number; /** * Calculates the hyperbolic cosine of cells in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localTrigonometricOperation) */ cosh: number; /** * Calculates the sine of cells in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localTrigonometricOperation) */ sin: number; /** * Calculates the hyperbolic sine of cells in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localTrigonometricOperation) */ sinh: number; /** * Calculates the tangent of cells in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localTrigonometricOperation) */ tan: number; /** * Calculates the hyperbolic tangent of cells in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localTrigonometricOperation) */ tanh: number; /** * Calculates the inverse hyperbolic cosine of cells in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localTrigonometricOperation) */ acosh: number; /** * Calculates the inverse hyperbolic sine of cells in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localTrigonometricOperation) */ asinh: number; /** * Calculates the inverse tangent (based on x,y) of cells in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#localTrigonometricOperation) */ atan2: number; } export interface rasterFunctionConstantsMissingBandAction { /** * Finds the best available band to use in place of the missing band based on wavelength. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#missingBandAction) */ bestMatch: number; /** * If the input dataset is missing any band specified in the Band parameter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#missingBandAction) */ fail: number; } export interface rasterFunctionConstantsNoDataInterpretation { /** * If the NoData value you specify occurs for a cell in a specified band. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#noDataInterpretation) */ matchAny: number; /** * The NoData values you specify for each band must occur in the same pixel for the output image to contain the NoData pixel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#noDataInterpretation) */ matchAll: number; } export interface rasterFunctionConstantsSlopeType { /** * The inclination of slope is calculated in degrees. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#slopeType) */ degree: number; /** * The inclination of slope is calculated as percentage values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#slopeType) */ percentRise: number; /** * The inclination of slope is calculated the same as DEGREE. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#slopeType) */ adjusted: number; } export interface rasterFunctionConstantsStretchType { /** * If the stretch type is None. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#stretchType) */ none: number; /** * The standard deviation stretch type applies a linear stretch between the values defined by the standard deviation (n) value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#stretchType) */ standardDeviation: number; /** * The histogram equalization stretch type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#stretchType) */ histogramEqualization: number; /** * The minMax stretch type applies a linear stretch based on the output minimum and output maximum pixel values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#stretchType) */ minMax: number; /** * The percent clip stretch type applies a linear stretch between the defined percent clip minimum and percent clip maximum pixel values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#stretchType) */ percentClip: number; /** * The Sigmoid contrast stretch is designed to highlight moderate pixel values in your imagery while maintaining sufficient contrast at the extremes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionConstants.html#stretchType) */ sigmoid: number; } /** * Various utility functions that create [RasterFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html) for imagery processing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html) */ interface rasterFunctionUtils { /** * A token representing the image service raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#defaultRaster) */ readonly defaultRaster: "$$"; /** * Creates a raster function that calculates the absolute value of the pixels in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#abs) */ abs(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the inverse cosine of the pixels in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#acos) */ acos(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the inverse hyperbolic cosine of the pixels in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#acosh) */ acosh(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the inverse sine of the pixels in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#asin) */ asin(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the inverse hyperbolic sine of the pixels in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#asinh) */ asinh(parameters: Math1RasterParameters): RasterFunction; /** * Creates a Aspect function to identify the downslope direction of the maximum rate of change in value from each cell to its neighbors. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#aspect) */ aspect(parameters: rasterFunctionUtilsAspectParameters): RasterFunction; /** * Creates a raster function that calculates the inverse tangent of the pixels in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#atan) */ atan(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the inverse tangent (based on x,y) of the pixels in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#atan2) */ atan2(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that calculates the inverse hyperbolic tangent of the pixels in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#atanh) */ atanh(parameters: Math1RasterParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate BAI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticBAI) */ bandArithmeticBAI(parameters: rasterFunctionUtilsBandArithmeticBAIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate CIg. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticCIg) */ bandArithmeticCIg(parameters: rasterFunctionUtilsBandArithmeticCIgParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate CIre. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticCIre) */ bandArithmeticCIre(parameters: rasterFunctionUtilsBandArithmeticCIreParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate ClayMinerals. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticClayMinerals) */ bandArithmeticClayMinerals(parameters: rasterFunctionUtilsBandArithmeticClayMineralsParameters): RasterFunction; /** * Creates a custom Band Arithmetic function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticCustom) */ bandArithmeticCustom(parameters: rasterFunctionUtilsBandArithmeticCustomParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate EVI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticEVI) */ bandArithmeticEVI(parameters: rasterFunctionUtilsBandArithmeticEVIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate FerrousMinerals. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticFerrousMinerals) */ bandArithmeticFerrousMinerals(parameters: rasterFunctionUtilsBandArithmeticFerrousMineralsParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate GEMI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticGEMI) */ bandArithmeticGEMI(parameters: rasterFunctionUtilsBandArithmeticGEMIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate GNDVI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticGNDVI) */ bandArithmeticGNDVI(parameters: rasterFunctionUtilsBandArithmeticGNDVIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate GVITM. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticGVITM) */ bandArithmeticGVITM(parameters: rasterFunctionUtilsBandArithmeticGVITMParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate IronOxide. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticIronOxide) */ bandArithmeticIronOxide(parameters: rasterFunctionUtilsBandArithmeticIronOxideParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate MNDWI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticMNDWI) */ bandArithmeticMNDWI(parameters: rasterFunctionUtilsBandArithmeticMNDWIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate MSAVI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticMSAVI) */ bandArithmeticMSAVI(parameters: rasterFunctionUtilsBandArithmeticMSAVIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate MTVI2. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticMTVI2) */ bandArithmeticMTVI2(parameters: rasterFunctionUtilsBandArithmeticMTVI2Parameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate NBR. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNBR) */ bandArithmeticNBR(parameters: rasterFunctionUtilsBandArithmeticNBRParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate NDBI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDBI) */ bandArithmeticNDBI(parameters: rasterFunctionUtilsBandArithmeticNDBIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate NDMI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDMI) */ bandArithmeticNDMI(parameters: rasterFunctionUtilsBandArithmeticNDMIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate NDSI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDSI) */ bandArithmeticNDSI(parameters: rasterFunctionUtilsBandArithmeticNDSIParameters): RasterFunction; /** * Creates a NDVI function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDVI) */ bandArithmeticNDVI(parameters: rasterFunctionUtilsBandArithmeticNDVIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate NDVIre. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDVIre) */ bandArithmeticNDVIre(parameters: rasterFunctionUtilsBandArithmeticNDVIreParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate NDWI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDWI) */ bandArithmeticNDWI(parameters: rasterFunctionUtilsBandArithmeticNDWIParameters): RasterFunction; /** * CCreates a Band Arithmetic function to calculate PVI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticPVI) */ bandArithmeticPVI(parameters: rasterFunctionUtilsBandArithmeticPVIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate RTVICore. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticRTVICore) */ bandArithmeticRTVICore(parameters: rasterFunctionUtilsBandArithmeticRTVICoreParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate SAVI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticSAVI) */ bandArithmeticSAVI(parameters: rasterFunctionUtilsBandArithmeticSAVIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate SR. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticSR) */ bandArithmeticSR(parameters: rasterFunctionUtilsBandArithmeticSRParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate SRre. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticSRre) */ bandArithmeticSRre(parameters: rasterFunctionUtilsBandArithmeticSRreParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate Sultan index. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticSultan) */ bandArithmeticSultan(parameters: rasterFunctionUtilsBandArithmeticSultanParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate TSAVI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticTSAVI) */ bandArithmeticTSAVI(parameters: rasterFunctionUtilsBandArithmeticTSAVIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate VARI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticVARI) */ bandArithmeticVARI(parameters: rasterFunctionUtilsBandArithmeticVARIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate WNDWI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticWNDWI) */ bandArithmeticWNDWI(parameters: rasterFunctionUtilsBandArithmeticWNDWIParameters): RasterFunction; /** * Creates a raster function that performs a Bitwise And operation on the binary values of two input rasters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bitwiseAnd) */ bitwiseAnd(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that performs a Bitwise Left Shift operation on the binary values of two input rasters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bitwiseLeftShift) */ bitwiseLeftShift(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that performs a Bitwise Not (complement) operation on the binary value of an input raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bitwiseNot) */ bitwiseNot(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that performs a Bitwise Or operation on the binary values of two input rasters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bitwiseOr) */ bitwiseOr(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that performs a Bitwise Right Shift operation on the binary values of two input rasters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bitwiseRightShift) */ bitwiseRightShift(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that performs a Bitwise Xor operation on the binary values of two input rasters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bitwiseXor) */ bitwiseXor(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that performs a Boolean And operation on the pixel values of two input rasters See [Boolean And function](https://pro.arcgis.com/en/pro-app/latest/help/analysis/raster-functions/boolean-and-function.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#booleanAnd) */ booleanAnd(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that performs a Boolean Not (complement) operation on the pixel values of the input raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#booleanNot) */ booleanNot(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that performs a Boolean Or operation on the pixel values of two input rasters See [Boolean Or function](https://pro.arcgis.com/en/pro-app/latest/help/analysis/raster-functions/boolean-or-function.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#booleanOr) */ booleanOr(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that performs a Boolean Xor operation on the pixel values of two input rasters See [Boolean Xor function](https://pro.arcgis.com/en/pro-app/latest/help/analysis/raster-functions/boolean-xor-function.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#booleanXor) */ booleanXor(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that calculates a statistic from multiple rasters, on a pixel-by-pixel basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#cellStatistics) */ cellStatistics(parameters: rasterFunctionUtilsCellStatisticsParameters): RasterFunction; /** * Extracts a portion of an image based on an [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) or a [polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#clip) */ clip(parameters: rasterFunctionUtilsClipParameters): RasterFunction; /** * Creates a Colormap function to define a colormap for a raster by specifying a corresponding color for each pixel value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#colormap) */ colormap(parameters: RasterColormapByMapParameters | RasterColormapByNameParameters | RasterColormapByRampParameters): RasterFunction; /** * Creates a Composite Bands function to combine multiple inputs into one multiband raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#compositeBands) */ compositeBands(parameters: rasterFunctionUtilsCompositeBandsParameters): RasterFunction; /** * Creates a raster function that sets the truthy pixels (value is not 0) to the pixel value from a true raster, and falsy pixels (value is 0) to the pixel value of the false raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#conditional) */ conditional(parameters: ConditionalParameters): RasterFunction; /** * Creates a Contrast And Brightness function that enhances the appearance of raster data by modifying the brightness and contrast within the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#contrastBrightness) */ contrastBrightness(parameters: rasterFunctionUtilsContrastBrightnessParameters): RasterFunction; /** * Creates a Convolution function that performs filtering using the given kernel to enhance the image, e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#convolution) */ convolution(parameters: rasterFunctionUtilsConvolutionParameters): RasterFunction; /** * Creates a raster function that calculates the cosine of the pixels in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#cos) */ cos(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the hyperbolic cosine of the pixels in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#cosh) */ cosh(parameters: Math1RasterParameters): RasterFunction; /** * Creates a Curvature function that calculates the shape or curvature of the slope. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#curvature) */ curvature(parameters: rasterFunctionUtilsCurvatureParameters): RasterFunction; /** * Creates a raster function that divides the values of two rasters on a pixel-by-pixel basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#divide) */ divide(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that performs an equal-to operation on two rasters on a pixel-by-pixel basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#equalTo) */ equalTo(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that calculates the base e exponential of the pixels in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#exp) */ exp(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the base 10 exponential of the pixels in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#exp10) */ exp10(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the base 2 exponential of the pixels in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#exp2) */ exp2(parameters: Math1RasterParameters): RasterFunction; /** * Creates an Extract Band function to extract one or more bands from a multiband raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#extractBand) */ extractBand(parameters: | ExtractBandByIdParameters | ExtractBandByNameParameters | ExtractBandByWavelengthParameters | rasterFunctionUtilsExtractBandParameters): RasterFunction; /** * Creates a raster function that converts each pixel value of a raster into a floating-point representation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#float) */ float(parameters: Math1RasterParameters): RasterFunction; /** * Converts a multiband image into a single-band grayscale image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#grayscale) */ grayscale(parameters: rasterFunctionUtilsGrayscaleParameters): RasterFunction; /** * Creates a raster function that performs a relational greater-than operation on two rasters on a pixel-by-pixel basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#greaterThan) */ greaterThan(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that performs a relational greater-than-or-equal-to operation on two rasters on a pixel-by-pixel basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#greaterThanEqual) */ greaterThanEqual(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that converts each pixel value of a raster to an integer by truncation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#int) */ int(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that determines which values from the input raster are NoData on a pixel-by-pixel basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#isNull) */ isNull(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that performs a relational less-than operation on two rasters on a pixel-by-pixel basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#lessThan) */ lessThan(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that performs a relational less-than-or-equal-to operation on two rasters on a pixel-by-pixel basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#lessThanEqual) */ lessThanEqual(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that calculates the natural logarithm (base e) of each pixel in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#log) */ log(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the base 10 logarithm of each pixel in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#log10) */ log10(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the base 2 logarithm of each pixel in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#log2) */ log2(parameters: Math1RasterParameters): RasterFunction; /** * Creates a Mask function to specify one or more NoData values, or a range of valid pixel values, to be removed from an output raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#mask) */ mask(parameters: rasterFunctionUtilsMaskParameters): RasterFunction; /** * Creates a raster function that subtracts the value of the second input raster from the value of the first input raster on a pixel-by-pixel basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#minus) */ minus(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that finds the remainder (modulo) of the first raster when divided by the second raster on a pixel-by-pixel basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#mod) */ mod(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that finds the changes the sign (multiplies by -1) of the pixel values of the input raster on a pixel-by-pixel basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#negate) */ negate(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that performs a relational not-equal-to operation on two rasters on a pixel-by-pixel basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#notEqual) */ notEqual(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that adds (sums) the values of two rasters on a pixel-by-pixel basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#plus) */ plus(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that raises the pixel values in a raster to the power of the values found in another raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#power) */ power(parameters: Math2RastersParameters): RasterFunction; /** * Creates a Remap function to change or reclassify the pixel values of the raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#remap) */ remap(parameters: rasterFunctionUtilsRemapParameters): RasterFunction; /** * Creates a raster function that returns the next lower integer, as a floating-point value, for each pixel in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#roundDown) */ roundDown(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that returns the next higher integer, as a floating-point value, for each pixel in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#roundUp) */ roundUp(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that sets the truthy pixels (value is not 0) to NoData, and falsy pixels (value is 0) to the pixel value of the false raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#setNull) */ setNull(parameters: SetNullParameters): RasterFunction; /** * Creates a raster function that calculates the sine of the pixels in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#sin) */ sin(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the hyperbolic sine of the pixels in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#sinh) */ sinh(parameters: Math1RasterParameters): RasterFunction; /** * Creates a Slope function that calculates the rate of change of elevation for each digital elevation model (DEM) cell. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#slope) */ slope(parameters: rasterFunctionUtilsSlopeParameters): RasterFunction; /** * Creates a raster function that calculates the square root of the pixel values in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#sqrt) */ sqrt(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the square of the pixel values in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#square) */ square(parameters: Math1RasterParameters): RasterFunction; /** * Creates a Statistics function that calculates focal statistics for each pixel of an image based on a defined focal neighborhood. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#statistics) */ statistics(parameters: rasterFunctionUtilsStatisticsParameters): RasterFunction; /** * Creates a Statistics And Histogram function to define the statistics and histogram of a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#statisticsHistogram) */ statisticsHistogram(parameters: rasterFunctionUtilsStatisticsHistogramParameters): RasterFunction; /** * Creates a Stretch function using min-max stretch type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchMinMax) */ stretchMinMax(parameters: rasterFunctionUtilsStretchMinMaxParameters): RasterFunction; /** * Creates a Stretch function using percent-clip stretch type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchPercentClip) */ stretchPercentClip(parameters: rasterFunctionUtilsStretchPercentClipParameters): RasterFunction; /** * Creates a Stretch function using standard-deviation stretch type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchStandardDeviation) */ stretchStandardDeviation(parameters: rasterFunctionUtilsStretchStandardDeviationParameters): RasterFunction; /** * Creates an Attribute Table function to specify an attribute table for the input categorical raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#table) */ table(parameters: rasterFunctionUtilsTableParameters): RasterFunction; /** * Creates a raster function that calculates the tangent of the pixels in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#tan) */ tan(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the hyperbolic tangent of the pixels in a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#tanh) */ tanh(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that multiplies the values of two rasters on a pixel-by-pixel basis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#times) */ times(parameters: Math2RastersParameters): RasterFunction; } export const rasterFunctionUtils: rasterFunctionUtils; /** * Conditional parameters * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#ConditionalParameters) */ export interface ConditionalParameters { /** * The input raster. * * [Read more...](global.html#raster) */ raster: RasterArgument; /** * The true raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#ConditionalParameters) */ trueRaster: RasterArgument; /** * The false raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#ConditionalParameters) */ falseRaster: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#ConditionalParameters) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } /** * Extract bands parameters specified using band ids. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#ExtractBandByIdParameters) */ export interface ExtractBandByIdParameters { /** * The 0-based band ids. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#ExtractBandByIdParameters) */ bandIds: number[]; /** * Indicate whether to use best possible matching band when the requested band is missing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#ExtractBandByIdParameters) */ missingBandAction?: "fail" | "best-match"; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#ExtractBandByIdParameters) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } /** * Extract bands parameters specified using band wavelengths. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#ExtractBandByNameParameters) */ export interface ExtractBandByNameParameters { /** * The band wavelengths. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#ExtractBandByNameParameters) */ bandWavelengths: number[]; /** * Indicate whether to use best possible matching band when the requested band is missing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#ExtractBandByNameParameters) */ missingBandAction?: "fail" | "best-match"; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#ExtractBandByNameParameters) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } /** * Extract bands parameters specified using band names. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#ExtractBandByWavelengthParameters) */ export interface ExtractBandByWavelengthParameters { /** * The band names. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#ExtractBandByWavelengthParameters) */ bandNames: string[]; /** * Indicate whether to use best possible matching band when the requested band is missing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#ExtractBandByWavelengthParameters) */ missingBandAction?: "fail" | "best-match"; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#ExtractBandByWavelengthParameters) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } /** * Input parameters for performing math operations on one input raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#Math1RasterParameters) */ export interface Math1RasterParameters { /** * The first raster. * * [Read more...](global.html#raster) */ raster: RasterArgument; /** * The output pixel type, default is `unknown`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#Math1RasterParameters) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } /** * Input parameters for perform math operations between two rasters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#Math2RastersParameters) */ export interface Math2RastersParameters { /** * The first raster input. * * [Read more...](global.html#raster) */ raster: RasterArgument; /** * The second raster input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#Math2RastersParameters) */ raster2: RasterArgument; /** * The output pixel type, default is `unknown`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#Math2RastersParameters) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } /** * Range map pixel values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#PixelValueRangeMap) */ export interface PixelValueRangeMap { /** * The pixel value range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#PixelValueRangeMap) */ range: number[]; /** * The mapped pixel value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#PixelValueRangeMap) */ output: number; } /** * Raster argument used to specify raster(s) used in raster processing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#RasterArgument) */ export type RasterArgument = RasterFunction | string | number; /** * Raster colormap input parameters specified using a colormap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#RasterColormapByMapParameters) */ export interface RasterColormapByMapParameters { /** * The colormap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#RasterColormapByMapParameters) */ colormap: RasterValueToColor[] | number[][]; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#RasterColormapByMapParameters) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } /** * Raster colormap input parameters specified using colormap name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#RasterColormapByNameParameters) */ export interface RasterColormapByNameParameters { /** * The name of a predefined colorramp or colormap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#RasterColormapByNameParameters) */ colorRampName: | "aspect" | "black-to-white" | "blue-bright" | "blue-light-to-dark" | "blue-green-bright" | "blue-green-light-to-dark" | "brown-light-to-dark" | "brown-to-blue-green-diverging-right" | "brown-to-blue-green-diverging-dark" | "coefficient-bias" | "cold-to-hot-diverging" | "condition-number" | "cyan-to-purple" | "cyan-light-to-blue-dark" | "distance" | "elevation1" | "elevation2" | "errors" | "gray-light-to-dark" | "green-bright" | "green-light-to-dark" | "green-to-blue" | "orange-bright" | "orange-light-to-dark" | "partial-spectrum" | "partial-spectrum-1-diverging" | "partial-spectrum-2-diverging" | "pink-to-yellow-green-diverging-bright" | "pink-to-yellow-green-diverging-dark" | "precipitation" | "prediction" | "purple-bright" | "purple-to-green-diverging-bright" | "purple-to-green-diverging-dark" | "purple-blue-bright" | "purple-blue-light-to-dark" | "purple-red-bright" | "purple-red-light-to-dark" | "red-bright" | "red-light-to-dark" | "red-to-blue-diverging-bright" | "red-to-blue-diverging-dark" | "red-to-green" | "red-to-green-diverging-bright" | "red-to-green-diverging-dark" | "slope" | "spectrum-full-bright" | "spectrum-full-dark" | "spectrum-full-light" | "surface" | "temperature" | "white-to-black" | "yellow-to-dark-red" | "yellow-to-green-to-dark-blue" | "yellow-to-red" | "yellow-green-bright" | "yellow-green-light-to-dark" | "random" | "elevation" | "gray" | "hillshade" | "ndvi" | "ndvi2" | "ndvi3"; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#RasterColormapByNameParameters) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } /** * Raster colormap input parameters specified using a colorramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#RasterColormapByRampParameters) */ export interface RasterColormapByRampParameters { /** * A colorramp * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#RasterColormapByRampParameters) */ colorRamp: AlgorithmicColorRamp | MultipartColorRamp; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#RasterColormapByRampParameters) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsAspectParameters { /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#aspect) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticBAIParameters { /** * The 0-based red band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticBAI) */ redBandId: number; /** * The 0-based near infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticBAI) */ nirBandId: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticBAI) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticCIgParameters { /** * The 0-based near infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticCIg) */ nirBandId: number; /** * The 0-based green band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticCIg) */ greenBandId: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticCIg) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticCIreParameters { /** * The 0-based near infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticCIre) */ nirBandId: number; /** * The 0-based red edge band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticCIre) */ reBandId: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticCIre) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticClayMineralsParameters { /** * The 0-based shortwave infrared band id centering around 1.5—1.75µm. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticClayMinerals) */ swir1BandId: number; /** * The 0-based shortwave infrared band id centering around 2.08—2.35µm. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticClayMinerals) */ swir2BandId: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticClayMinerals) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticCustomParameters { /** * The custom band index, e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticCustom) */ bandIndexes: string; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticCustom) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticEVIParameters { /** * The 0-based near infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticEVI) */ nirBandId: number; /** * The 0-based red band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticEVI) */ redBandId: number; /** * The 0-based blue band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticEVI) */ blueBandId: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticEVI) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticFerrousMineralsParameters { /** * The 0-based shortwave infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticFerrousMinerals) */ swir1BandId: number; /** * The 0-based near infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticFerrousMinerals) */ nirBandId: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticFerrousMinerals) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticGEMIParameters { /** * The 0-based near infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticGEMI) */ nirBandId: number; /** * The 0-based red band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticGEMI) */ redBandId: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticGEMI) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticGNDVIParameters { /** * The 0-based near infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticGNDVI) */ nirBandId: number; /** * The 0-based green band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticGNDVI) */ greenBandId: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticGNDVI) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticGVITMParameters { /** * The bandIds array representing Landsat band 1, 2, 3, 4, 5, 7. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticGVITM) */ bandIds: number[]; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticGVITM) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticIronOxideParameters { /** * The 0-based red band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticIronOxide) */ redBandId: number; /** * The 0-based blue band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticIronOxide) */ blueBandId: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticIronOxide) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticMNDWIParameters { /** * The 0-based green band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticMNDWI) */ greenBandId: number; /** * The 0-based shortwave infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticMNDWI) */ swirBandId: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticMNDWI) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticMSAVIParameters { /** * The 0-based near infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticMSAVI) */ nirBandId: number; /** * The 0-based red band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticMSAVI) */ redBandId: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticMSAVI) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticMTVI2Parameters { /** * The 0-based near infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticMTVI2) */ nirBandId: number; /** * The 0-based red band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticMTVI2) */ redBandId: number; /** * The 0-based green band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticMTVI2) */ greenBandId: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticMTVI2) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticNBRParameters { /** * The 0-based near infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNBR) */ nirBandId: number; /** * The 0-based shortwave infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNBR) */ swirBandId: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNBR) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticNDBIParameters { /** * The 0-based shortwave infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDBI) */ swirBandId: number; /** * The 0-based near infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDBI) */ nirBandId: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDBI) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticNDMIParameters { /** * The 0-based near infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDMI) */ nirBandId: number; /** * The 0-based shortwave infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDMI) */ swirBandId: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDMI) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticNDSIParameters { /** * The 0-based green band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDSI) */ greenBandId: number; /** * The 0-based shortwave infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDSI) */ swirBandId: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDSI) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticNDVIParameters { /** * The 0-based near infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDVI) */ nirBandId: number; /** * The 0-based red band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDVI) */ redBandId: number; /** * Output values are linearly scaled to 0 to 200 when scientificOutput is false. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDVI) */ scientificOutput?: boolean; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDVI) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticNDVIreParameters { /** * The 0-based near infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDVIre) */ nirBandId: number; /** * The 0-based red edge band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDVIre) */ reBandId: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDVIre) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticNDWIParameters { /** * The 0-based near infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDWI) */ nirBandId: number; /** * The 0-based green band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDWI) */ greenBandId: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticNDWI) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticPVIParameters { /** * The 0-based near infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticPVI) */ nirBandId: number; /** * The 0-based red band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticPVI) */ redBandId: number; /** * The soil line slope. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticPVI) */ slope?: boolean; /** * The soil line gradient. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticPVI) */ gradient?: boolean; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticPVI) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticRTVICoreParameters { /** * The 0-based near infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticRTVICore) */ nirBandId: number; /** * The 0-based red edge band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticRTVICore) */ reBandId: number; /** * The 0-based green band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticRTVICore) */ greenBandId: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticRTVICore) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticSAVIParameters { /** * The 0-based near infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticSAVI) */ nirBandId: number; /** * The 0-based red band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticSAVI) */ redBandId: number; /** * The amount of green vegetation cover from 0 to 1. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticSAVI) */ factor?: boolean; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticSAVI) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticSRParameters { /** * The 0-based near infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticSR) */ nirBandId: number; /** * The 0-based red band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticSR) */ redBandId: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticSR) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticSRreParameters { /** * The 0-based near infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticSRre) */ nirBandId: number; /** * The 0-based red edge band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticSRre) */ reBandId: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticSRre) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticSultanParameters { /** * The bandIds array representing band 1, 3, 4, 5, 6. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticSultan) */ bandIds: number[]; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticSultan) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticTSAVIParameters { /** * The 0-based near infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticTSAVI) */ nirBandId: number; /** * The 0-based red band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticTSAVI) */ redBandId: number; /** * The soil line slope. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticTSAVI) */ slope?: boolean; /** * The soil line intercept. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticTSAVI) */ intercept?: boolean; /** * The adjustment factor to minimize soil noise. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticTSAVI) */ factor?: boolean; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticTSAVI) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticVARIParameters { /** * The 0-based red band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticVARI) */ redBandId: number; /** * The 0-based green band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticVARI) */ greenBandId: number; /** * The 0-based blue band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticVARI) */ blueBandId: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticVARI) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsBandArithmeticWNDWIParameters { /** * The 0-based green band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticWNDWI) */ greenBandId: number; /** * The 0-based near infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticWNDWI) */ nirBandId: number; /** * The 0-based shortwave infrared band id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticWNDWI) */ swirBandId: number; /** * A weighted coefficient ranging from 0 to 1. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticWNDWI) */ alpha?: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#bandArithmeticWNDWI) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsCellStatisticsParameters { /** * The input rasters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#cellStatistics) */ rasters: RasterArgument[]; /** * The true raster, if the first input is a raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#cellStatistics) */ statType: "min" | "max" | "majority" | "mean" | "minority" | "range" | "stddev" | "sum" | "variety" | "median"; /** * When true, process the single input raster as multiple bands. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#cellStatistics) */ processAsMultiband?: boolean; /** * The output pixel type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#cellStatistics) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsClipParameters { /** * An extent or a polygon geometry to define the clip shape. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#clip) */ geometry: Polygon | Extent; /** * When `false`, the imagery within the clip geometry will be kept in the output. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#clip) */ keepOutside?: boolean; /** * The output pixel type. * * @default "unknown" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#clip) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsCompositeBandsParameters { /** * The input raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#compositeBands) */ rasters?: RasterArgument[]; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#compositeBands) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsContrastBrightnessParameters { /** * Contrast offset from -100 to 100. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#contrastBrightness) */ contrastOffset: number; /** * Brightness offset from -100 to 100. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#contrastBrightness) */ brightnessOffset: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#contrastBrightness) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsConvolutionParameters { /** * Choose a predefined kernel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#convolution) */ convolutionType: | "user-defined" | "line-detection-horizontal" | "line-detection-vertical" | "line-detection-left-diagonal" | "line-detection-right-diagonal" | "gradient-north" | "gradient-west" | "gradient-east" | "gradient-south" | "gradient-north-east" | "gradient-north-west" | "smooth-arithmetic-mean" | "smoothing3x3" | "smoothing5x5" | "sharpening3x3" | "sharpening5x5" | "laplacian3x3" | "laplacian5x5" | "sobel-horizontal" | "sobel-vertical" | "sharpen" | "sharpen2" | "point-spread" | "none"; /** * The number of rows, only needed for user-defined kernel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#convolution) */ rows?: number; /** * The number of columns, only needed for user-defined kernel * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#convolution) */ cols?: number; /** * The kernel size of rows x columns arranged in row-major order. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#convolution) */ kernel?: number[]; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#convolution) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsCurvatureParameters { /** * The curvature type * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#curvature) */ curvatureType: "standard" | "platform" | "profile"; /** * A ratio of z unit / xy unit, with optional exaggeration factored in. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#curvature) */ zFactor: number; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#curvature) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsExtractBandParameters { /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#extractBand) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsGrayscaleParameters { /** * The weights applied to each input band. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#grayscale) */ weights: number[]; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#grayscale) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsMaskParameters { /** * The included values for each band. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#mask) */ includedRanges: number[][]; /** * The nodata values for each band. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#mask) */ noDataValues: number[][]; /** * Result is no data if all bands are nodata when match-all is specified, any if any band is nodata when match-any is specified. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#mask) */ noDataInterpretation?: "match-any" | "match-all"; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#mask) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsRemapParameters { /** * Range maps. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#remap) */ rangeMaps: PixelValueRangeMap[]; /** * Unmatched pixel values are passed through when true, or set to NoData when false. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#remap) */ allowUnmatched?: boolean; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#remap) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsSlopeParameters { /** * The slope type * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#slope) */ slopeType: "degree" | "percent-rise" | "adjusted"; /** * A ratio of z unit / xy unit, with optional exaggeration factored in. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#slope) */ zFactor: number; /** * Pixel size factor accounts for changes in scale as the viewer zooms in and out on the map display. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#slope) */ pixelSizePower?: number; /** * Pixel Size Power accounts for the altitude changes (or scale) as the viewer zooms in and out on the map display. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#slope) */ pixelSizeZFactor?: number; /** * Remove edge effect when true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#slope) */ removeEdgeEffect?: boolean; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#slope) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsStatisticsHistogramParameters { /** * The statistics parameter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#statisticsHistogram) */ statistics?: RasterBandStatistics[]; /** * The histogram parameter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#statisticsHistogram) */ histograms?: RasterHistogram[]; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#statisticsHistogram) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsStatisticsParameters { /** * The statistics type * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#statistics) */ statisticsType: "min" | "max" | "majority" | "mean" | "minority" | "stddev" | "median"; /** * Number of rows. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#statistics) */ rows: number; /** * Number of columns. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#statistics) */ cols: number; /** * When true only fills noData pixels * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#statistics) */ fillNoDataOnly?: boolean; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#statistics) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsStretchMinMaxParameters { /** * Default is the input data source's statistics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchMinMax) */ statistics?: RasterBandStatistics[]; /** * The minimum output value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchMinMax) */ outputMin?: number; /** * The maximum output value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchMinMax) */ outputMax?: number; /** * When true, gamma stretch is applied. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchMinMax) */ useGamma?: boolean; /** * The gamma values used for each band, needed when useGamma is true. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchMinMax) */ gamma?: number[]; /** * When true, perform dynamic range adjustment (not supported on client side). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchMinMax) */ dynamicRangeAdjustment?: boolean; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchMinMax) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsStretchPercentClipParameters { /** * Percentage of the lowest pixel values to be excluded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchPercentClip) */ minPercent: number; /** * Percentage of the highest pixel values to be excluded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchPercentClip) */ maxPercent: number; /** * The minimum output value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchPercentClip) */ outputMin?: number; /** * The maximum output value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchPercentClip) */ outputMax?: number; /** * When true, gamma stretch is applied. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchPercentClip) */ useGamma?: boolean; /** * The gamma values used for each band, needed when useGamma is true. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchPercentClip) */ gamma?: number[]; /** * When true, perform dynamic range adjustment (not supported on client side) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchPercentClip) */ dynamicRangeAdjustment?: boolean; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchPercentClip) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsStretchStandardDeviationParameters { /** * Values with in the given number of standard deviations are stretched to [outputMin, outputMax], those fall outside are clamped. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchStandardDeviation) */ numberOfStandardDeviations: number; /** * The minimum output value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchStandardDeviation) */ outputMin?: number; /** * The maximum output value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchStandardDeviation) */ outputMax?: number; /** * When true, gamma stretch is applied. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchStandardDeviation) */ useGamma?: boolean; /** * The gamma values used for each band, needed when useGamma is true. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchStandardDeviation) */ gamma?: number[]; /** * The avg and stddev in each band's statistics is used along with numberOfStandardDeviations to calculate the cut off pixels values beling stretched. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchStandardDeviation) */ statistics?: RasterBandStatistics[]; /** * When true, perform dynamic range adjustment (not supported on client side). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchStandardDeviation) */ dynamicRangeAdjustment?: boolean; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#stretchStandardDeviation) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface rasterFunctionUtilsTableParameters { /** * The attribute table represented using a feature set. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#table) */ attributeTable: FeatureSet; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#table) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } /** * A pixel value to color mapping. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#RasterValueToColor) */ export interface RasterValueToColor { /** * Pixel value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#RasterValueToColor) */ value: number; /** * Color represented using [r,g,b] or [r,g,b,a], or the color's name or hex string. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#RasterValueToColor) */ color: number[] | string; /** * The input raster. * * [Read more...](global.html#raster) */ raster?: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#RasterValueToColor) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } /** * SetNull parameters * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#SetNullParameters) */ export interface SetNullParameters { /** * The input raster. * * [Read more...](global.html#raster) */ raster: RasterArgument; /** * The false raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#SetNullParameters) */ falseRaster: RasterArgument; /** * The output pixel type, default is unknown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-rasterFunctionUtils.html#SetNullParameters) */ outputPixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; } export interface RasterInfo extends Accessor, JSONSupport { } export class RasterInfo { /** * The raster attribute table associated with an imagery layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#attributeTable) */ attributeTable: FeatureSet; /** * Raster band count. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#bandCount) */ bandCount: number; /** * This property provides additional information for each band in the raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#bandInfos) */ bandInfos: RasterBandInfo[]; /** * Raster colormap that can be used to display the imagery layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#colormap) */ colormap: number[][]; /** * Raster data type controls how the data is rendered by default. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#dataType) */ dataType: | "generic" | "elevation" | "thematic" | "processed" | "scientific" | "vector-uv" | "vector-u" | "vector-v" | "vector-magdir" | "vector-magnitude" | "vector-direction" | "standard-time"; /** * The minimum and maximum X and Y coordinates of a bounding box containing all the raster data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#extent) */ extent: Extent; /** * Indicates whether the source multidimensional data has been transposed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#hasMultidimensionalTranspose) */ hasMultidimensionalTranspose: boolean; /** * Raster height (row count) in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#height) */ height: number; /** * Raster histograms return basic name-value pairs for number of bins, min and max bounding values, counts of pixels in each bin. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#histograms) */ histograms: any[]; /** * Raster key properties. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#keyProperties) */ keyProperties: any; /** * Returns the multidimensional information associated with the raster service referenced in an imagery layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#multidimensionalInfo) */ multidimensionalInfo: RasterMultidimensionalInfo; /** * The pixel value representing no available information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#noDataValue) */ noDataValue: number | number[]; /** * Raster pixel size. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#pixelSize) */ pixelSize: RasterInfoPixelSize; /** * Pixel type for the raster data source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#pixelType) */ pixelType: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; /** * The sensor information associated with an image service referenced by a layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#sensorInfo) */ sensorInfo: RasterSensorInfo; /** * The spatial reference of the raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#spatialReference) */ spatialReference: SpatialReference; /** * Raster band statistics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#statistics) */ statistics: RasterInfoStatistics[]; /** * Raster width (column count) in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#width) */ width: number; /** * Describes general raster data information exposed by the ArcGIS REST API for [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html), [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html) and [WCSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html) */ constructor(properties?: RasterInfoProperties); static fromJSON(json: any): RasterInfo; } interface RasterInfoProperties { /** * The raster attribute table associated with an imagery layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#attributeTable) */ attributeTable?: FeatureSetProperties; /** * Raster band count. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#bandCount) */ bandCount?: number; /** * This property provides additional information for each band in the raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#bandInfos) */ bandInfos?: RasterBandInfoProperties[]; /** * Raster colormap that can be used to display the imagery layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#colormap) */ colormap?: number[][]; /** * Raster data type controls how the data is rendered by default. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#dataType) */ dataType?: | "generic" | "elevation" | "thematic" | "processed" | "scientific" | "vector-uv" | "vector-u" | "vector-v" | "vector-magdir" | "vector-magnitude" | "vector-direction" | "standard-time"; /** * The minimum and maximum X and Y coordinates of a bounding box containing all the raster data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#extent) */ extent?: ExtentProperties; /** * Indicates whether the source multidimensional data has been transposed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#hasMultidimensionalTranspose) */ hasMultidimensionalTranspose?: boolean; /** * Raster height (row count) in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#height) */ height?: number; /** * Raster histograms return basic name-value pairs for number of bins, min and max bounding values, counts of pixels in each bin. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#histograms) */ histograms?: any[]; /** * Raster key properties. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#keyProperties) */ keyProperties?: any; /** * Returns the multidimensional information associated with the raster service referenced in an imagery layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#multidimensionalInfo) */ multidimensionalInfo?: RasterMultidimensionalInfo; /** * The pixel value representing no available information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#noDataValue) */ noDataValue?: number | number[]; /** * Raster pixel size. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#pixelSize) */ pixelSize?: RasterInfoPixelSize; /** * Pixel type for the raster data source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#pixelType) */ pixelType?: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; /** * The sensor information associated with an image service referenced by a layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#sensorInfo) */ sensorInfo?: RasterSensorInfoProperties; /** * The spatial reference of the raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * Raster band statistics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#statistics) */ statistics?: RasterInfoStatistics[]; /** * Raster width (column count) in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#width) */ width?: number; } export interface RasterInfoPixelSize { /** * Pixel size along the x axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#pixelSize) */ x: number; /** * Pixel size along the y axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#pixelSize) */ y: number; } export interface RasterInfoStatistics { /** * The minimum pixel value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#statistics) */ min: number; /** * The maximum pixel value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#statistics) */ max: number; /** * The standard deviation of calculated pixel values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#statistics) */ stddev: number; /** * The average of calculated pixel values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#statistics) */ avg: number; } /** * RasterMultidimensionalInfo contains dimensions for each variable in the service describing information about the images collected at multiple times, depths, or heights. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#RasterMultidimensionalInfo) */ export interface RasterMultidimensionalInfo { /** * The multi dimensional variables. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#RasterMultidimensionalInfo) */ variables: RasterMultidimensionalInfoVariables[]; } export interface RasterMultidimensionalInfoVariables { /** * Variable name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#RasterMultidimensionalInfo) */ name: string; /** * Variable description. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#RasterMultidimensionalInfo) */ description?: string; /** * Unit of the variable measured in. * * [Read more...](global.html#unit) */ unit?: string; /** * A dimension may be used to represent real physical dimensions such as time or depth/height. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#RasterMultidimensionalInfo) */ dimensions: RasterMultidimensionalInfoVariablesDimensions[]; /** * Variable statistics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#RasterMultidimensionalInfo) */ statistics?: RasterBandStatistics[]; /** * Variable histograms. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#RasterMultidimensionalInfo) */ histograms?: RasterHistogram[]; } export interface RasterMultidimensionalInfoVariablesDimensions { /** * Dimension name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#RasterMultidimensionalInfo) */ name: string; /** * Dimension description. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#RasterMultidimensionalInfo) */ description?: string; /** * Dimension unit. * * [Read more...](global.html#unit) */ unit?: string; /** * An array of single values or tuples [min, max] each defining a range of valid values along the specified dimension. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#RasterMultidimensionalInfo) */ values?: number[] | number[][]; /** * Indicates if the dimension is recorded at regular intervals. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#RasterMultidimensionalInfo) */ hasRegularIntervals?: boolean; /** * Dimension interval. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#RasterMultidimensionalInfo) */ interval?: number; /** * Dimension interval unit. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#RasterMultidimensionalInfo) */ intervalUnit?: string; /** * The extent of dimension values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterInfo.html#RasterMultidimensionalInfo) */ extent?: number[]; } export interface RasterSensorInfo extends Accessor, JSONSupport { } export class RasterSensorInfo { /** * The acquisition date. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterSensorInfo.html#acquisitionDate) */ acquisitionDate: Date; /** * The cloud coverage (0-1). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterSensorInfo.html#cloudCover) */ cloudCover: number; /** * The satellite product name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterSensorInfo.html#productName) */ productName: string; /** * The sensor azimuth. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterSensorInfo.html#sensorAzimuth) */ sensorAzimuth: number; /** * The sensor elevation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterSensorInfo.html#sensorElevation) */ sensorElevation: number; /** * The sensor name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterSensorInfo.html#sensorName) */ sensorName: string; /** * The sun azimuth. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterSensorInfo.html#sunAzimuth) */ sunAzimuth: number; /** * The sun elevation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterSensorInfo.html#sunElevation) */ sunElevation: number; /** * The `RasterSensorInfo` class provides additional information on the raster sensor associated with an image service referenced by [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#serviceRasterInfo) or [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#rasterInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterSensorInfo.html) */ constructor(properties?: RasterSensorInfoProperties); /** * Creates a deep clone of the raster sensor info object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterSensorInfo.html#clone) */ clone(): RasterSensorInfo; static fromJSON(json: any): RasterSensorInfo; } interface RasterSensorInfoProperties { /** * The acquisition date. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterSensorInfo.html#acquisitionDate) */ acquisitionDate?: DateProperties; /** * The cloud coverage (0-1). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterSensorInfo.html#cloudCover) */ cloudCover?: number; /** * The satellite product name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterSensorInfo.html#productName) */ productName?: string; /** * The sensor azimuth. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterSensorInfo.html#sensorAzimuth) */ sensorAzimuth?: number; /** * The sensor elevation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterSensorInfo.html#sensorElevation) */ sensorElevation?: number; /** * The sensor name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterSensorInfo.html#sensorName) */ sensorName?: string; /** * The sun azimuth. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterSensorInfo.html#sunAzimuth) */ sunAzimuth?: number; /** * The sun elevation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterSensorInfo.html#sunElevation) */ sunElevation?: number; } export interface Relationship extends Accessor, JSONSupport, Clonable { } export class Relationship { /** * The cardinality which specifies the number of objects in the origin [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) related to the number of objects in the destination [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#cardinality) */ cardinality: "one-to-one" | "one-to-many" | "many-to-many"; /** * Indicates whether the relationship is composite. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#composite) */ composite: boolean; /** * The unique ID for the relationship. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#id) */ id: number; /** * The field used to establish the relate within the [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#keyField) */ keyField: string; /** * The key field in an attributed relationship class table that matches the [keyField](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#keyField). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#keyFieldInRelationshipTable) */ keyFieldInRelationshipTable: string; /** * The name of the relationship. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#name) */ name: string; /** * The unique ID of the related [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#relatedTableId) */ relatedTableId: number; /** * The relationship table id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#relationshipTableId) */ relationshipTableId: number; /** * Indicates whether the table participating in the relationship is the `origin` or `destination` table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#role) */ role: "origin" | "destination"; /** * Describes a [layer's](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) relationship with another layer or table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html) */ constructor(properties?: RelationshipProperties); static fromJSON(json: any): Relationship; } interface RelationshipProperties { /** * The cardinality which specifies the number of objects in the origin [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) related to the number of objects in the destination [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#cardinality) */ cardinality?: "one-to-one" | "one-to-many" | "many-to-many"; /** * Indicates whether the relationship is composite. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#composite) */ composite?: boolean; /** * The unique ID for the relationship. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#id) */ id?: number; /** * The field used to establish the relate within the [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#keyField) */ keyField?: string; /** * The key field in an attributed relationship class table that matches the [keyField](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#keyField). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#keyFieldInRelationshipTable) */ keyFieldInRelationshipTable?: string; /** * The name of the relationship. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#name) */ name?: string; /** * The unique ID of the related [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#relatedTableId) */ relatedTableId?: number; /** * The relationship table id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#relationshipTableId) */ relationshipTableId?: number; /** * Indicates whether the table participating in the relationship is the `origin` or `destination` table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#role) */ role?: "origin" | "destination"; } export interface RouteStopSymbols extends Accessor, JSONSupport { } export class RouteStopSymbols { /** * The default symbol for _break_ [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#stops). * * @default { type: "simple-marker", color: [255, 255, 255], size: 12, outline: { color: [0, 122, 194], width: 3 } } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteStopSymbols.html#break) */ break: SimpleMarkerSymbol | PictureMarkerSymbol | PointSymbol3D | CIMSymbol; /** * The default symbol for the first [stop](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#stops). * * @default { type: "simple-marker", color: [0, 255, 0], size: 20, outline: { color: [255, 255, 255], width: 4 } } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteStopSymbols.html#first) */ first: SimpleMarkerSymbol | PictureMarkerSymbol | PointSymbol3D | CIMSymbol; /** * The default symbol for a _last_ [stop](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#stops). * * @default { type: "simple-marker", color: [255, 0, 0], size: 20, outline: { color: [255, 255, 255], width: 4 } } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteStopSymbols.html#last) */ last: SimpleMarkerSymbol | PictureMarkerSymbol | PointSymbol3D | CIMSymbol; /** * The default symbol for _middle_ [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#stops). * * @default { type: "simple-marker", color: [51, 51, 51],, size: 12, outline: { color: [0, 122, 194], width: 3 } } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteStopSymbols.html#middle) */ middle: SimpleMarkerSymbol | PictureMarkerSymbol | PointSymbol3D | CIMSymbol; /** * The default symbol for an _unlocated_ [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#stops). * * @default { type: "simple-marker", color: [255, 0, 0], size: 12, outline: { color: [255, 255, 255], width: 3 } } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteStopSymbols.html#unlocated) */ unlocated: SimpleMarkerSymbol | PictureMarkerSymbol | PointSymbol3D | CIMSymbol; /** * The default symbol for _waypoint_ [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#stops). * * @default { type: "simple-marker", color: [255, 255, 255], size: 12, outline: { color: [0, 122, 194], width: 3 } } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteStopSymbols.html#waypoint) */ waypoint: SimpleMarkerSymbol | PictureMarkerSymbol | PointSymbol3D | CIMSymbol; /** * RouteStopSymbols contains a set of symbols that will be used by [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html) to symbolize new stops. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteStopSymbols.html) */ constructor(properties?: RouteStopSymbolsProperties); static fromJSON(json: any): RouteStopSymbols; } interface RouteStopSymbolsProperties { /** * The default symbol for _break_ [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#stops). * * @default { type: "simple-marker", color: [255, 255, 255], size: 12, outline: { color: [0, 122, 194], width: 3 } } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteStopSymbols.html#break) */ break?: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }); /** * The default symbol for the first [stop](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#stops). * * @default { type: "simple-marker", color: [0, 255, 0], size: 20, outline: { color: [255, 255, 255], width: 4 } } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteStopSymbols.html#first) */ first?: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }); /** * The default symbol for a _last_ [stop](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#stops). * * @default { type: "simple-marker", color: [255, 0, 0], size: 20, outline: { color: [255, 255, 255], width: 4 } } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteStopSymbols.html#last) */ last?: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }); /** * The default symbol for _middle_ [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#stops). * * @default { type: "simple-marker", color: [51, 51, 51],, size: 12, outline: { color: [0, 122, 194], width: 3 } } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteStopSymbols.html#middle) */ middle?: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }); /** * The default symbol for an _unlocated_ [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#stops). * * @default { type: "simple-marker", color: [255, 0, 0], size: 12, outline: { color: [255, 255, 255], width: 3 } } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteStopSymbols.html#unlocated) */ unlocated?: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }); /** * The default symbol for _waypoint_ [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#stops). * * @default { type: "simple-marker", color: [255, 255, 255], size: 12, outline: { color: [0, 122, 194], width: 3 } } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteStopSymbols.html#waypoint) */ waypoint?: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }); } export interface RouteSymbols extends Accessor, JSONSupport { } export class RouteSymbols { /** * The default symbol for [direction lines](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#directionLines). * * @default { type: "simple-line", color: [0, 122, 194], width: 6 } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteSymbols.html#directionLines) */ directionLines: SimpleLineSymbol | LineSymbol3D | CIMSymbol; /** * The default symbol for [direction points](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#directionPoints). * * @default { type: "simple-marker", color: [255, 255, 255], size: 6, outline: { color: [0, 122, 194], width: 2 } } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteSymbols.html#directionPoints) */ directionPoints: SimpleMarkerSymbol | PictureMarkerSymbol | PointSymbol3D | CIMSymbol; /** * The default symbol for [point barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#pointBarriers). * * @default { type: "simple-marker", style: "x", size: 10, outline: { color: [255, 0, 0], width: 3 } } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteSymbols.html#pointBarriers) */ pointBarriers: SimpleMarkerSymbol | PictureMarkerSymbol | PointSymbol3D | CIMSymbol; /** * The default symbol for [polygon barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#polygonBarriers). * * @default { type: "simple-fill", color: [255, 170, 0, 0.6], outline: { width: 7.5, color: [255, 0, 0, 0.6] } } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteSymbols.html#polygonBarriers) */ polygonBarriers: PictureFillSymbol | SimpleFillSymbol | PolygonSymbol3D | CIMSymbol; /** * The default symbol for [polyline Barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#polylineBarriers). * * @default { type: "simple-line", color: [255, 85, 0, 0.7], width: 7.5 } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteSymbols.html#polylineBarriers) */ polylineBarriers: SimpleLineSymbol | LineSymbol3D | CIMSymbol; /** * The default symbol for the overall [route](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#routeInfo). * * @default { type: "simple-line", color: [20, 89, 127], width: 8 } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteSymbols.html#routeInfo) */ routeInfo: SimpleLineSymbol | LineSymbol3D | CIMSymbol; /** * The default symbol for [stop](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#stops). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteSymbols.html#stops) */ stops: RouteStopSymbols; /** * RouteSymbols contains a set of symbols that will be used by [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html) to symbolize new stops, barriers and directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteSymbols.html) */ constructor(properties?: RouteSymbolsProperties); static fromJSON(json: any): RouteSymbols; } interface RouteSymbolsProperties { /** * The default symbol for [direction lines](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#directionLines). * * @default { type: "simple-line", color: [0, 122, 194], width: 6 } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteSymbols.html#directionLines) */ directionLines?: | (SimpleLineSymbolProperties & { type: "simple-line" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (CIMSymbolProperties & { type: "cim" }); /** * The default symbol for [direction points](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#directionPoints). * * @default { type: "simple-marker", color: [255, 255, 255], size: 6, outline: { color: [0, 122, 194], width: 2 } } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteSymbols.html#directionPoints) */ directionPoints?: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }); /** * The default symbol for [point barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#pointBarriers). * * @default { type: "simple-marker", style: "x", size: 10, outline: { color: [255, 0, 0], width: 3 } } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteSymbols.html#pointBarriers) */ pointBarriers?: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }); /** * The default symbol for [polygon barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#polygonBarriers). * * @default { type: "simple-fill", color: [255, 170, 0, 0.6], outline: { width: 7.5, color: [255, 0, 0, 0.6] } } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteSymbols.html#polygonBarriers) */ polygonBarriers?: | (PictureFillSymbolProperties & { type: "picture-fill" }) | (SimpleFillSymbolProperties & { type: "simple-fill" }) | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (CIMSymbolProperties & { type: "cim" }); /** * The default symbol for [polyline Barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#polylineBarriers). * * @default { type: "simple-line", color: [255, 85, 0, 0.7], width: 7.5 } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteSymbols.html#polylineBarriers) */ polylineBarriers?: | (SimpleLineSymbolProperties & { type: "simple-line" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (CIMSymbolProperties & { type: "cim" }); /** * The default symbol for the overall [route](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#routeInfo). * * @default { type: "simple-line", color: [20, 89, 127], width: 8 } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteSymbols.html#routeInfo) */ routeInfo?: | (SimpleLineSymbolProperties & { type: "simple-line" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (CIMSymbolProperties & { type: "cim" }); /** * The default symbol for [stop](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#stops). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RouteSymbols.html#stops) */ stops?: RouteStopSymbolsProperties; } export class SceneFilter extends Accessor { /** * The geometries to apply to the spatial filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SceneFilter.html#geometries) */ geometries: Collection; /** * The type of masking to perform. * * @default "disjoint" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SceneFilter.html#spatialRelationship) */ spatialRelationship: "disjoint" | "contains"; /** * A SceneFilter defines parameters for setting a client-side spatial filter on a [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#filter). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SceneFilter.html) */ constructor(properties?: SceneFilterProperties); /** * Creates a deep clone of the SceneFilter object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SceneFilter.html#clone) */ clone(): SceneFilter; } interface SceneFilterProperties { /** * The geometries to apply to the spatial filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SceneFilter.html#geometries) */ geometries?: CollectionProperties; /** * The type of masking to perform. * * @default "disjoint" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SceneFilter.html#spatialRelationship) */ spatialRelationship?: "disjoint" | "contains"; } export interface SceneModification extends Accessor, JSONSupport { } export class SceneModification { /** * The geometry representing the location of the modification. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SceneModification.html#geometry) */ geometry: Polygon; /** * The type of modification to perform. * * @default clip * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SceneModification.html#type) */ type: "clip" | "mask" | "replace"; /** * The SceneModification is used to perform a client-side geometric modifications. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SceneModification.html) */ constructor(properties?: SceneModificationProperties); /** * Creates a clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SceneModification.html#clone) */ clone(): SceneModification; static fromJSON(json: any): SceneModification; } interface SceneModificationProperties { /** * The geometry representing the location of the modification. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SceneModification.html#geometry) */ geometry?: PolygonProperties; /** * The type of modification to perform. * * @default clip * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SceneModification.html#type) */ type?: "clip" | "mask" | "replace"; } export interface SceneModifications extends Collection, JSONSupport { } export class SceneModifications { /** * A collection of [SceneModification](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SceneModification.html) with polygons and types to apply client-side modifications. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SceneModifications.html) */ constructor(properties?: | SceneModificationsProperties | SceneModificationProperties[] | Collection); /** * Creates a clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SceneModifications.html#clone) */ clone(): SceneModifications; static fromJSON(json: any): SceneModifications; } interface SceneModificationsProperties extends CollectionPropertiesBase { } export interface SiteLayerInfo extends Accessor, JSONSupport { } export class SiteLayerInfo { /** * The id for an operational layer in a map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SiteLayerInfo.html#layerId) */ layerId: string; /** * The field name from the layer that defines the site name of a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SiteLayerInfo.html#nameField) */ nameField: string; /** * The field name from the layer that defines a site unique ID for a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SiteLayerInfo.html#siteIdField) */ siteIdField: string; /** * This value references the numeric ID of the sublayer if the Site layer is a map service sublayer instead of a feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SiteLayerInfo.html#sublayerId) */ sublayerId: number; /** * The SiteLayerInfo class describes the boundaries of managed sites and is used for visualizing groups of facilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SiteLayerInfo.html) */ constructor(properties?: SiteLayerInfoProperties); static fromJSON(json: any): SiteLayerInfo; } interface SiteLayerInfoProperties { /** * The id for an operational layer in a map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SiteLayerInfo.html#layerId) */ layerId?: string; /** * The field name from the layer that defines the site name of a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SiteLayerInfo.html#nameField) */ nameField?: string; /** * The field name from the layer that defines a site unique ID for a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SiteLayerInfo.html#siteIdField) */ siteIdField?: string; /** * This value references the numeric ID of the sublayer if the Site layer is a map service sublayer instead of a feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SiteLayerInfo.html#sublayerId) */ sublayerId?: number; } /** * A web socket connection to a stream service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-StreamConnection.html) */ interface StreamConnection { /** * The error that explains an unsuccessful attempt to connect to the stream service or an unexpected disconnection from the stream service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-StreamConnection.html#connectionError) */ readonly connectionError: Error; /** * The status of the Web Socket connection with the stream service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-StreamConnection.html#connectionStatus) */ readonly connectionStatus: "connected" | "disconnected"; /** * Destroys the existing connection instance to the stream service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-StreamConnection.html#destroy) */ destroy(): void; } export const StreamConnection: StreamConnection; export interface StreamConnectionDataReceivedEvent { attributes: any; geometry: any; } export interface Sublayer extends Accessor, Loadable, Identifiable { } export class Sublayer { /** * Describes the layer's supported capabilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#capabilities) */ readonly capabilities: SublayerCapabilities; /** * A SQL where clause used to filter features in the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#definitionExpression) */ definitionExpression: string; /** * An array of fields in the Sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#fields) */ readonly fields: Field[]; /** * A convenient property that can be used to make case-insensitive lookups for a [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#field) by name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#fieldsIndex) */ readonly fieldsIndex: FieldsIndex; /** * If a map image layer contains a sublayer which is meant to be floor-aware, then that sublayer must have a floorInfo property, containing a [LayerFloorInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LayerFloorInfo.html) object which has a string property to represent the floorField. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#floorInfo) */ floorInfo: LayerFloorInfo; /** * The full extent of the Sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#fullExtent) */ readonly fullExtent: Extent; /** * The sublayer's layer ID. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#id) */ id: number; /** * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html) objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#labelingInfo) */ labelingInfo: LabelClass[]; /** * Indicates if labels for the sublayer will be visible in the view. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#labelsVisible) */ labelsVisible: boolean; /** * The [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html) or [TileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html) to which the sublayer belongs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#layer) */ layer: MapImageLayer | TileLayer; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#legendEnabled) */ legendEnabled: boolean; /** * Indicates how the layer should display in the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widget. * * @default show * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#listMode) */ listMode: "show" | "hide" | "hide-children"; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#maxScale) */ maxScale: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#minScale) */ minScale: number; /** * The name of an `oid` [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#fields) containing a unique value or identifier for each feature in the Sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#objectIdField) */ readonly objectIdField: string; /** * The level of opacity to set on the sublayer on a scale from 0.0 - 1.0 where `0` is fully transparent and `1.0` is fully opaque. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#opacity) */ opacity: number; /** * The parent layer to which the sublayer belongs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#parent) */ parent: Sublayer | MapImageLayer | TileLayer; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#popupEnabled) */ popupEnabled: boolean; /** * The popup template for the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * The renderer to apply to the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#renderer) */ renderer: Renderer; /** * An object that allows you to create a dynamic layer with data either from the map service sublayers or data from a registered workspace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#source) */ source: DynamicMapLayer | DynamicDataLayer; /** * The [map service's metadata JSON](https://developers.arcgis.com/rest/services-reference/map-service.htm) exposed by the ArcGIS REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#sourceJSON) */ sourceJSON: any; /** * If a sublayer contains sublayers, this property is a [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [Sublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html) objects belonging to the given sublayer with sublayers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#sublayers) */ sublayers: Collection; /** * The title of the sublayer used to identify it in places such as the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) and [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widgets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#title) */ title: string; readonly type: "sublayer"; /** * The name of the field holding the type ID or subtypes for the features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#typeIdField) */ readonly typeIdField: string; /** * An array of [types](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html) defined in the feature service exposed by ArcGIS REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#types) */ readonly types: FeatureType[]; /** * The URL to the REST endpoint of the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#url) */ url: string; /** * Indicates if the layer is visible in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#visible) */ visible: boolean; /** * Represents a sublayer in a [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html) or a [TileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html) */ constructor(properties?: SublayerProperties); /** * Creates a deep clone of the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#clone) */ clone(): Sublayer; /** * A convenient method for creating a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) instance based on the Sublayer's configuration, including [dynamic sources](https://enterprise.arcgis.com/en/server/latest/publish-services/linux/about-dynamic-layers.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#createFeatureLayer) */ createFeatureLayer(): Promise; /** * Creates a popup template for the sublayer, populated with all the fields of the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#createPopupTemplate) */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate; /** * Creates a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) object with default values representing the layer's state, including filters (definition expression) on the layer's features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#createQuery) */ createQuery(): Query; /** * Returns a [FeatureType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html) describing the feature's type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#getFeatureType) */ getFeatureType(feature: Graphic): FeatureType; /** * Returns the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) associated with the given field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#getFieldDomain) */ getFieldDomain(fieldName: string, options?: SublayerGetFieldDomainOptions): Domain; /** * Query information about attachments associated with features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#queryAttachments) */ queryAttachments(attachmentQuery: AttachmentQuery | AttachmentQueryProperties, options?: SublayerQueryAttachmentsOptions): void; /** * Executes a [query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html) against features in the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#queryFeatures) */ queryFeatures(query?: Query | QueryProperties, options?: SublayerQueryFeaturesOptions): Promise; } interface SublayerProperties extends LoadableProperties { /** * A SQL where clause used to filter features in the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#definitionExpression) */ definitionExpression?: string; /** * If a map image layer contains a sublayer which is meant to be floor-aware, then that sublayer must have a floorInfo property, containing a [LayerFloorInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LayerFloorInfo.html) object which has a string property to represent the floorField. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#floorInfo) */ floorInfo?: LayerFloorInfoProperties; /** * The sublayer's layer ID. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#id) */ id?: number; /** * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html) objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#labelingInfo) */ labelingInfo?: LabelClassProperties[]; /** * Indicates if labels for the sublayer will be visible in the view. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#labelsVisible) */ labelsVisible?: boolean; /** * The [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html) or [TileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html) to which the sublayer belongs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#layer) */ layer?: (MapImageLayerProperties & { type: "map-image" }) | (TileLayerProperties & { type: "tile" }); /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#legendEnabled) */ legendEnabled?: boolean; /** * Indicates how the layer should display in the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widget. * * @default show * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#listMode) */ listMode?: "show" | "hide" | "hide-children"; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#maxScale) */ maxScale?: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#minScale) */ minScale?: number; /** * The level of opacity to set on the sublayer on a scale from 0.0 - 1.0 where `0` is fully transparent and `1.0` is fully opaque. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#opacity) */ opacity?: number; /** * The parent layer to which the sublayer belongs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#parent) */ parent?: | (SublayerProperties & { type: "sublayer" }) | (MapImageLayerProperties & { type: "map-image" }) | (TileLayerProperties & { type: "tile" }); /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#popupEnabled) */ popupEnabled?: boolean; /** * The popup template for the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * The renderer to apply to the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#renderer) */ renderer?: RendererProperties; /** * An object that allows you to create a dynamic layer with data either from the map service sublayers or data from a registered workspace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#source) */ source?: (DynamicMapLayer & { type: "map-layer" }) | (DynamicDataLayer & { type: "data-layer" }); /** * The [map service's metadata JSON](https://developers.arcgis.com/rest/services-reference/map-service.htm) exposed by the ArcGIS REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#sourceJSON) */ sourceJSON?: any; /** * If a sublayer contains sublayers, this property is a [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [Sublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html) objects belonging to the given sublayer with sublayers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#sublayers) */ sublayers?: CollectionProperties; /** * The title of the sublayer used to identify it in places such as the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) and [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widgets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#title) */ title?: string; /** * The URL to the REST endpoint of the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#url) */ url?: string; /** * Indicates if the layer is visible in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#visible) */ visible?: boolean; } /** * A dynamic data layer is a layer created on-the-fly with data stored in a [registered workspace](https://enterprise.arcgis.com/en/server/latest/manage-data/windows/overview-register-data-with-arcgis-server.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicDataLayer) */ export interface DynamicDataLayer { /** * This value is always `data-layer` and is inferred when the `dataSource` property is set. * * [Read more...](global.html#type) */ type: "data-layer"; /** * A table, feature class, or raster that resides in a registered workspace (either a folder or geodatabase). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicDataLayer) */ dataSource: TableDataSource | QueryTableDataSource | RasterDataSource | JoinTableDataSource; /** * Controls field visibility in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicDataLayer) */ fields: DynamicDataLayerFields[]; } /** * A dynamic map layer refers to a layer published in a map service that has dynamic layers enabled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicMapLayer) */ export interface DynamicMapLayer { /** * This value is always `map-layer` and is inferred when the `mapLayerId` property is set. * * [Read more...](global.html#type) */ type: "map-layer"; /** * The [id](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#id) of the service sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicMapLayer) */ mapLayerId: number; /** * An optional property for specifying the GDB version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicMapLayer) */ gdbVersion: string; } /** * The result of an on-the-fly join operation at runtime. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#JoinTableDataSource) */ export interface JoinTableDataSource { /** * This value is always `join-table` and is inferred when other join table properties of this object are set. * * [Read more...](global.html#type) */ type: "join-table"; /** * The field name used for joining or matching records in the left table to records in the right table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#JoinTableDataSource) */ leftTableKey: string; /** * The field name used for joining or matching records in the right table to records in the left table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#JoinTableDataSource) */ rightTableKey: string; /** * The left table for joining to the right table source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#JoinTableDataSource) */ leftTableSource: DynamicMapLayer | DynamicDataLayer; /** * The right table for joining to the left table source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#JoinTableDataSource) */ rightTableSource: DynamicMapLayer | DynamicDataLayer; /** * The type of join that will be performed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#JoinTableDataSource) */ joinType: "left-outer-join" | "left-inner-join"; } /** * A query table is a feature class or table defined by a SQL query on the fly. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#QueryTableDataSource) */ export interface QueryTableDataSource { /** * This value is always `query-table` and is inferred when the `query` property of this object is set. * * [Read more...](global.html#type) */ type: "query-table"; /** * The workspace where the data resides (defined in ArcGIS Server Manager). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#QueryTableDataSource) */ workspaceId: string; /** * The SQL query used to filter records. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#QueryTableDataSource) */ query: string; /** * The field name(s) containing the unique IDs for each record in the table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#QueryTableDataSource) */ oidFields: string; /** * The spatial reference of the geometry of each feature in the table source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#QueryTableDataSource) */ spatialReference: SpatialReference; /** * The geometry type of each record in the table. * * [Read more...](global.html#geometryType) */ geometryType: "point" | "multipoint" | "polyline" | "polygon" | "multipatch"; } /** * A file-based raster that resides in a registered raster workspace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#RasterDataSource) */ export interface RasterDataSource { /** * This value is always `raster`. * * [Read more...](global.html#type) */ type: "raster"; /** * The workspace where the raster resides as defined in the ArcGIS Server Manager. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#RasterDataSource) */ workspaceId: string; /** * The name of the raster in the registered workspace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#RasterDataSource) */ dataSourceName: string; } export interface SublayerCapabilities { /** * Describes characteristics of the data in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#capabilities) */ data: SublayerCapabilitiesData; /** * Describes operations that can be performed on features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#capabilities) */ operations: SublayerCapabilitiesOperations; /** * Indicates if the layer's query operation supports querying features or records related to features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#capabilities) */ queryRelated: SublayerCapabilitiesQueryRelated; } export interface SublayerCapabilitiesData { /** * Indicates if attachments are enabled on the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#capabilities) */ supportsAttachment: boolean; } export interface SublayerCapabilitiesOperations { /** * Indicates if features in the layer can be [queried](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#queryFeatures). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#capabilities) */ supportsQuery: boolean; /** * Indicates if the layer supports [REST API queryAttachments](https://developers.arcgis.com/rest/services-reference/query-attachments-feature-service-layer-.htm) operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#capabilities) */ supportsQueryAttachments: boolean; } export interface SublayerCapabilitiesQueryRelated { /** * Indicates if the layer's query response includes the number of features or records related to features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#capabilities) */ supportsCount: boolean; /** * Indicates if the related features or records returned in the query response can be ordered by one or more fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#capabilities) */ supportsOrderBy: boolean; /** * Indicates if the query response supports pagination for related features or records. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#capabilities) */ supportsPagination: boolean; } export interface SublayerGetFieldDomainOptions { /** * The feature to which the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) is assigned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#getFieldDomain) */ feature: Graphic; } export interface SublayerQueryAttachmentsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#queryAttachments) */ signal?: AbortSignal; } export interface SublayerQueryFeaturesOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#queryFeatures) */ signal?: AbortSignal; } /** * A table or feature class that resides in a registered workspace (either a folder or geodatabase). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#TableDataSource) */ export interface TableDataSource { /** * This value is always `table`. * * [Read more...](global.html#type) */ type: string; /** * The workspace where the table resides as defined in the ArcGIS Server Manager. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#TableDataSource) */ workspaceId: string; /** * The name of the table in the registered workspace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#TableDataSource) */ dataSourceName: string; /** * References the geodatabase version if multiple versions exist in the geodatabase. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#TableDataSource) */ gdbVersion: string; } export interface DynamicDataLayerFields { /** * The name of the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicDataLayer) */ name: string; /** * The alias of the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicDataLayer) */ alias: string; } export interface Subtype extends Accessor, JSONSupport { } export class Subtype { /** * The subtype unique identifier number. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Subtype.html#code) */ code: number; /** * Name-value pairs of fields and their default field values associated with the subtype. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Subtype.html#defaultValues) */ defaultValues: any; /** * [Domains](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) associated with the subtype. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Subtype.html#domains) */ domains: HashMap; /** * The subtype name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Subtype.html#name) */ name: string; /** * Subtypes categorize a subset of features in a layer that share the same attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Subtype.html) */ constructor(properties?: SubtypeProperties); static fromJSON(json: any): Subtype; } interface SubtypeProperties { /** * The subtype unique identifier number. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Subtype.html#code) */ code?: number; /** * Name-value pairs of fields and their default field values associated with the subtype. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Subtype.html#defaultValues) */ defaultValues?: any; /** * [Domains](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) associated with the subtype. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Subtype.html#domains) */ domains?: HashMap< | (CodedValueDomainProperties & { type: "coded-value" }) | (RangeDomainProperties & { type: "range" }) | (InheritedDomainProperties & { type: "inherited" }) >; /** * The subtype name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Subtype.html#name) */ name?: string; } export interface SubtypeSublayer extends Accessor, Loadable, Identifiable { } export class SubtypeSublayer { /** * Describes the layer's supported capabilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#capabilities) */ readonly capabilities: Capabilities; /** * Determines if the layer is editable. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#editingEnabled) */ editingEnabled: boolean; /** * Indicates whether the layer is editable taking in to consideration privileges of the currently signed-in user and whether the parent subtype group layer is editable or not. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#effectiveEditingEnabled) */ readonly effectiveEditingEnabled: boolean; /** * An array of fields in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#fields) */ readonly fields: Field[]; /** * The [template](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html) used in an associated layer's [FeatureForm](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#formTemplate) */ formTemplate: FormTemplate; /** * The geometry type of features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#geometryType) */ readonly geometryType: "point" | "multipoint" | "polyline" | "polygon" | "multipatch" | "mesh"; /** * The unique ID assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#id) */ readonly id: string; /** * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#labelingInfo) */ labelingInfo: LabelClass[]; /** * Indicates whether to display labels for this layer. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#labelsVisible) */ labelsVisible: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#legendEnabled) */ legendEnabled: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#maxScale) */ maxScale: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#minScale) */ minScale: number; /** * The name of an `oid` [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#fields) containing a unique value or identifier for each feature in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#objectIdField) */ readonly objectIdField: string; /** * The opacity of the layer. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#opacity) */ opacity: number; /** * The [SubtypeGroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html) to which the sublayer belongs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#parent) */ parent: SubtypeGroupLayer; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#popupEnabled) */ popupEnabled: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#renderer) */ renderer: Renderer; /** * The spatial reference of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#spatialReference) */ spatialReference: SpatialReference; /** * The unique identifier representing the [SubtypeSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html) created from the [SubtypeGroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#subtypeCode) */ subtypeCode: number; /** * The name of the field which holds the id of the [subtypes](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#subtypes). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#subtypeField) */ readonly subtypeField: string; /** * An array of feature templates defined in the feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#templates) */ templates: FeatureTemplate[]; /** * The title of the layer used to identify it in places such as the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#title) */ title: string; readonly type: "subtype-sublayer"; /** * The absolute URL of the REST endpoint of the feature service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#url) */ url: string; /** * Indicates if the layer is visible in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#visible) */ visible: boolean; /** * Represents a sublayer in a [SubtypeGroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html) */ constructor(properties?: SubtypeSublayerProperties); /** * Adds an attachment to a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#addAttachment) */ addAttachment(feature: Graphic, attachment: HTMLFormElement | FormData): Promise; /** * Creates a popup template for the layer, populated with all the fields of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#createPopupTemplate) */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate; /** * Creates query parameters that can be used to fetch features that satisfy the layer's current filters, and definitions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#createQuery) */ createQuery(): Query; /** * Deletes attachments from a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#deleteAttachments) */ deleteAttachments(feature: Graphic, attachmentIds: number[]): Promise; /** * Returns the [Field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) instance for a field name (case-insensitive). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#getField) */ getField(fieldName: string): Field; /** * Returns the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) associated with the given field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#getFieldDomain) */ getFieldDomain(fieldName: string): Domain; /** * Query information about attachments associated with features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#queryAttachments) */ queryAttachments(attachmentQuery: AttachmentQuery | AttachmentQueryProperties, options?: SubtypeSublayerQueryAttachmentsOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the feature service and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html), which can be accessed using the `.then()` method once the promise resolves. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#queryFeatures) */ queryFeatures(query?: Query | QueryProperties, options?: SubtypeSublayerQueryFeaturesOptions): Promise; /** * Updates an existing attachment for a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#updateAttachment) */ updateAttachment(feature: Graphic, attachmentId: number, attachment: HTMLFormElement | FormData): Promise; } interface SubtypeSublayerProperties extends LoadableProperties { /** * Determines if the layer is editable. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#editingEnabled) */ editingEnabled?: boolean; /** * The [template](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html) used in an associated layer's [FeatureForm](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#formTemplate) */ formTemplate?: FormTemplateProperties; /** * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#labelingInfo) */ labelingInfo?: LabelClassProperties[]; /** * Indicates whether to display labels for this layer. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#labelsVisible) */ labelsVisible?: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#legendEnabled) */ legendEnabled?: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#maxScale) */ maxScale?: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#minScale) */ minScale?: number; /** * The opacity of the layer. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#opacity) */ opacity?: number; /** * The [SubtypeGroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html) to which the sublayer belongs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#parent) */ parent?: SubtypeGroupLayerProperties; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#popupEnabled) */ popupEnabled?: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#renderer) */ renderer?: RendererProperties; /** * The spatial reference of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * The unique identifier representing the [SubtypeSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html) created from the [SubtypeGroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#subtypeCode) */ subtypeCode?: number; /** * An array of feature templates defined in the feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#templates) */ templates?: FeatureTemplateProperties[]; /** * The title of the layer used to identify it in places such as the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#title) */ title?: string; /** * The absolute URL of the REST endpoint of the feature service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#url) */ url?: string; /** * Indicates if the layer is visible in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#visible) */ visible?: boolean; } export interface SubtypeSublayerQueryAttachmentsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#queryAttachments) */ signal?: AbortSignal; } export interface SubtypeSublayerQueryFeaturesOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#queryFeatures) */ signal?: AbortSignal; } export interface TileInfo extends Accessor, JSONSupport { } export class TileInfo { /** * The dots per inch (DPI) of the tiling scheme. * * @default 96 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#dpi) */ dpi: number; /** * Image format of the cached tiles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#format) */ format: | "png" | "png24" | "png32" | "jpg" | "dib" | "tiff" | "emf" | "ps" | "pdf" | "gif" | "svg" | "svgz" | "mixed" | "lerc" | "pbf"; /** * Indicates if the tiling scheme supports wrap around. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#isWrappable) */ isWrappable: boolean; /** * An array of levels of detail that define the tiling scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#lods) */ lods: LOD[]; /** * The tiling scheme origin. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#origin) */ origin: Point; /** * Size of tiles in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#size) */ size: number[]; /** * The spatial reference of the tiling schema. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#spatialReference) */ spatialReference: SpatialReference; /** * Contains information about the tiling scheme for [TileLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html), [ElevationLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html), [ImageryTileLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html), [VectorTileLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html), and [WebTileLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html) */ constructor(properties?: TileInfoProperties); /** * Utility method used to convert a scale value to its corresponding zoom value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#scaleToZoom) */ scaleToZoom(scale: number): number; /** * Utility method used to convert a zoom value to its corresponding scale value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#zoomToScale) */ zoomToScale(zoom: number): number; /** * A convenience method used to create a new TileInfo instance with preset properties like [LODs](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#lods). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#create) */ static create(options?: TileInfoCreateOptions): TileInfo; static fromJSON(json: any): TileInfo; } interface TileInfoProperties { /** * The dots per inch (DPI) of the tiling scheme. * * @default 96 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#dpi) */ dpi?: number; /** * Image format of the cached tiles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#format) */ format?: | "png" | "png24" | "png32" | "jpg" | "dib" | "tiff" | "emf" | "ps" | "pdf" | "gif" | "svg" | "svgz" | "mixed" | "lerc" | "pbf"; /** * Indicates if the tiling scheme supports wrap around. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#isWrappable) */ isWrappable?: boolean; /** * An array of levels of detail that define the tiling scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#lods) */ lods?: LODProperties[]; /** * The tiling scheme origin. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#origin) */ origin?: PointProperties; /** * Size of tiles in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#size) */ size?: number[]; /** * The spatial reference of the tiling schema. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; } export interface TileInfoCreateOptions { /** * The size of each tile in pixels. * * @default 256 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#create) */ size?: number; /** * Total number of LODs to create. * * @default 24 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#create) */ numLODs?: number; /** * The spatial reference for the new TileInfo instance. * * @default WebMercator * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#create) */ spatialReference?: SpatialReference; /** * An array of scale values to use for the TileInfo. * * @default The scales provided by ArcGIS Online basemaps * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#create) */ scales?: number[]; } export interface TileMatrixSet extends Accessor, JSONSupport { } export class TileMatrixSet { /** * The full extent of the TileMatrixSet. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html#fullExtent) */ fullExtent: Extent; /** * The unique ID assigned to the TileMatrixSet. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html#id) */ id: string; /** * The tiling scheme information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html#tileInfo) */ tileInfo: TileInfo; /** * Contains information about the tiling scheme for [WMTSSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html) */ constructor(properties?: TileMatrixSetProperties); /** * Creates a deep clone of this TileMatrixSet. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html#clone) */ clone(): TileMatrixSet; static fromJSON(json: any): TileMatrixSet; } interface TileMatrixSetProperties { /** * The full extent of the TileMatrixSet. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html#fullExtent) */ fullExtent?: ExtentProperties; /** * The unique ID assigned to the TileMatrixSet. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html#id) */ id?: string; /** * The tiling scheme information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html#tileInfo) */ tileInfo?: TileInfoProperties; } export interface TimeInfo extends Accessor, JSONSupport, Clonable { } export class TimeInfo { /** * The name of the field containing the end time information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#endField) */ endField: string; /** * The time extent defines the start time and end time for all data in the layer. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#fullTimeExtent) */ fullTimeExtent: TimeExtent; /** * The time interval defines the granularity of the temporal data and allows you to visualize the data at specified intervals using the [time slider widget](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#interval) */ interval: TimeInterval; /** * The name of the field containing the start time information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#startField) */ startField: string; /** * The IANA time zone that dates are stored in. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#timeZone) */ timeZone: string; /** * The name of the field used to join or group discrete locations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#trackIdField) */ trackIdField: string; /** * Time info represents the temporal data of a time-aware layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html) */ constructor(properties?: TimeInfoProperties); static fromJSON(json: any): TimeInfo; } interface TimeInfoProperties { /** * The name of the field containing the end time information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#endField) */ endField?: string; /** * The time extent defines the start time and end time for all data in the layer. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#fullTimeExtent) */ fullTimeExtent?: TimeExtentProperties; /** * The time interval defines the granularity of the temporal data and allows you to visualize the data at specified intervals using the [time slider widget](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#interval) */ interval?: TimeIntervalProperties; /** * The name of the field containing the start time information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#startField) */ startField?: string; /** * The IANA time zone that dates are stored in. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#timeZone) */ timeZone?: string; /** * The name of the field used to join or group discrete locations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#trackIdField) */ trackIdField?: string; } export interface VideoElement extends Accessor, MediaElementBase { } export class VideoElement { /** * The video content referenced in the video element instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VideoElement.html#content) */ readonly content: any; /** * The element type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VideoElement.html#type) */ readonly type: "video"; /** * The video element to be added to the [media layer's source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#source). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VideoElement.html#video) */ video: string | any; /** * Represents a video element referenced in the MediaLayer's [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#source). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VideoElement.html) */ constructor(properties?: VideoElementProperties); } interface VideoElementProperties extends MediaElementBaseProperties { /** * The video element to be added to the [media layer's source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#source). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VideoElement.html#video) */ video?: string | any; } /** * Describes a single variable in the [VoxelLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html). * * @deprecated This module was moved in 4.25. Use {@link module:esri/layers/voxel/VoxelVariable esri/layers/voxel/VoxelVariable} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VoxelVariable.html) */ interface VoxelVariable { /** * The original data source description of the variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VoxelVariable.html#description) */ readonly description: string; /** * The unique identifier for the variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VoxelVariable.html#id) */ readonly id: number; /** * The original data source name of the variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VoxelVariable.html#name) */ readonly name: string; /** * A description of various properties of the variable as it is represented on the GPU. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VoxelVariable.html#renderingFormat) */ readonly renderingFormat: VoxelVariableRenderingFormat; /** * The variable units. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VoxelVariable.html#unit) */ readonly unit: string; /** * The volumeId of the variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VoxelVariable.html#volumeId) */ readonly volumeId: number; } export const VoxelVariable: VoxelVariable; export interface VoxelVariableRenderingFormat { /** * Whether or not the data is discrete or continuous. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VoxelVariable.html#renderingFormat) */ continuity: "discrete" | "continuous"; /** * Whether or not the data has a value representing NoData. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VoxelVariable.html#renderingFormat) */ hasNoData?: boolean; /** * The NoData value if there is one. * * @default 0.0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VoxelVariable.html#renderingFormat) */ noData?: number; /** * Indicates how the data are encoded. * * [Read more...](global.html#type) */ type: "Int8" | "UInt8" | "Int16" | "UInt16" | "Int32" | "UInt32" | "Float32"; } export interface VoxelVolumeStyle extends JSONSupport, Clonable { } export class VoxelVolumeStyle { /** * The collection of [VoxelDynamicSection](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelDynamicSection.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VoxelVolumeStyle.html#dynamicSections) */ dynamicSections: Collection; /** * The collection of [VoxelSlice](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelSlice.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VoxelVolumeStyle.html#slices) */ slices: Collection; /** * The vertical exaggeration factor. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VoxelVolumeStyle.html#verticalExaggeration) */ verticalExaggeration: number; /** * The vertical offset amount. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VoxelVolumeStyle.html#verticalOffset) */ verticalOffset: number; /** * Id of the volume. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VoxelVolumeStyle.html#volumeId) */ readonly volumeId: number; /** * The VolumeStyle allows you to define rendering properties that apply to the volume itself, such as vertical exaggeration and offset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VoxelVolumeStyle.html) */ constructor(properties?: VoxelVolumeStyleProperties); static fromJSON(json: any): VoxelVolumeStyle; } interface VoxelVolumeStyleProperties { /** * The collection of [VoxelDynamicSection](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelDynamicSection.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VoxelVolumeStyle.html#dynamicSections) */ dynamicSections?: CollectionProperties; /** * The collection of [VoxelSlice](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelSlice.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VoxelVolumeStyle.html#slices) */ slices?: CollectionProperties; /** * The vertical exaggeration factor. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VoxelVolumeStyle.html#verticalExaggeration) */ verticalExaggeration?: number; /** * The vertical offset amount. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-VoxelVolumeStyle.html#verticalOffset) */ verticalOffset?: number; } export interface WMSSublayer extends Accessor, Identifiable { } export class WMSSublayer { /** * Description for the WMS sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#description) */ description: string; /** * An array of time, elevation and other dimensions for the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#dimensions) */ readonly dimensions: (TimeDimension | ElevationDimension | GenericDimension)[]; /** * The full extent of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#fullExtent) */ fullExtent: Extent; /** * The id for the WMS sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#id) */ id: number; /** * The [WMSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html) to which the sublayer belongs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#layer) */ layer: WMSLayer; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#legendEnabled) */ legendEnabled: boolean; /** * A string url pointing to a legend image for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#legendUrl) */ legendUrl: string; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#maxScale) */ maxScale: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#minScale) */ minScale: number; /** * Name of the WMS sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#name) */ name: string; /** * Returns a reference to the parent WMS sublayer or layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#parent) */ parent: WMSSublayer | WMSLayer; /** * Indicates whether to display popups when features in the layer are clicked. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#popupEnabled) */ popupEnabled: boolean; /** * Indicates if the layer can be queried, i.e. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#queryable) */ queryable: boolean; /** * List of spatialReferences (WKID) derived from the CRS elements of the first layer in the GetCapabilities request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#spatialReferences) */ spatialReferences: number[]; /** * A collection of [WMSSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html)s. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#sublayers) */ sublayers: Collection; /** * The title of the WMS sublayer used to identify it in places such as the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) and [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widgets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#title) */ title: string; /** * Indicates if the layer is visible in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#visible) */ visible: boolean; /** * Represents a sublayer in a [WMSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html) */ constructor(properties?: WMSSublayerProperties); /** * Creates a deep clone of the WMS sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#clone) */ clone(): WMSSublayer; } interface WMSSublayerProperties { /** * Description for the WMS sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#description) */ description?: string; /** * The full extent of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#fullExtent) */ fullExtent?: ExtentProperties; /** * The id for the WMS sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#id) */ id?: number; /** * The [WMSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html) to which the sublayer belongs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#layer) */ layer?: WMSLayerProperties; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#legendEnabled) */ legendEnabled?: boolean; /** * A string url pointing to a legend image for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#legendUrl) */ legendUrl?: string; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#maxScale) */ maxScale?: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#minScale) */ minScale?: number; /** * Name of the WMS sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#name) */ name?: string; /** * Returns a reference to the parent WMS sublayer or layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#parent) */ parent?: WMSSublayerProperties | (WMSLayerProperties & { type: "wms" }); /** * Indicates whether to display popups when features in the layer are clicked. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#popupEnabled) */ popupEnabled?: boolean; /** * Indicates if the layer can be queried, i.e. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#queryable) */ queryable?: boolean; /** * List of spatialReferences (WKID) derived from the CRS elements of the first layer in the GetCapabilities request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#spatialReferences) */ spatialReferences?: number[]; /** * A collection of [WMSSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html)s. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#sublayers) */ sublayers?: CollectionProperties; /** * The title of the WMS sublayer used to identify it in places such as the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) and [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widgets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#title) */ title?: string; /** * Indicates if the layer is visible in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#visible) */ visible?: boolean; } /** * Elevation dimension information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#ElevationDimension) */ export interface ElevationDimension { /** * Name of dimensional axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#ElevationDimension) */ name: "elevation"; } /** * Generic dimension information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#GenericDimension) */ export interface GenericDimension { /** * Name of dimensional axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#GenericDimension) */ name: string; } /** * Time dimension information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#TimeDimension) */ export interface TimeDimension { /** * Name of dimensional axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#TimeDimension) */ name: "time"; /** * Units of dimensional axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#TimeDimension) */ units: "ISO8601"; /** * Available value(s) for the time dimension. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#TimeDimension) */ extent: Date[] | TimeDimensionInterval[]; /** * Default value(s) for the time dimension. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#TimeDimension) */ default: Date[] | TimeDimensionInterval[]; /** * Indicates whether multiple values of the dimension may be requested. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#TimeDimension) */ multipleValues: boolean; /** * Indicates whether the nearest value of the dimension will be returned in response to a request for a nearby value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#TimeDimension) */ nearestValue: boolean; } /** * The time dimension interval. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#TimeDimensionInterval) */ export interface TimeDimensionInterval { /** * Start of interval. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#TimeDimensionInterval) */ min: Date; /** * End of interval. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#TimeDimensionInterval) */ max: Date; /** * Interval duration defined by the following properties. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#TimeDimensionInterval) */ resolution: TimeDimensionIntervalResolution; } export interface TimeDimensionIntervalResolution { /** * Number of years. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#TimeDimensionInterval) */ years: number; /** * Number of months. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#TimeDimensionInterval) */ months: number; /** * Number of days. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#TimeDimensionInterval) */ days: number; /** * Number of hours. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#TimeDimensionInterval) */ hours: number; /** * Number of minutes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#TimeDimensionInterval) */ minutes: number; /** * Number of seconds. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#TimeDimensionInterval) */ seconds: number; } export interface WMTSStyle extends Accessor, JSONSupport { } export class WMTSStyle { /** * Description for the WMTS style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html#description) */ description: string; /** * The unique ID assigned to the style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html#id) */ id: string; /** * The URL to the legend which gets used in [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html#legendUrl) */ legendUrl: string; /** * The title of the WMTS style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html#title) */ title: string; /** * Contains information about the WMTS Style for [WMTSSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html) */ constructor(properties?: WMTSStyleProperties); /** * Creates a deep clone of the WMTSStyle. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html#clone) */ clone(): WMTSStyle; static fromJSON(json: any): WMTSStyle; } interface WMTSStyleProperties { /** * Description for the WMTS style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html#description) */ description?: string; /** * The unique ID assigned to the style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html#id) */ id?: string; /** * The URL to the legend which gets used in [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html#legendUrl) */ legendUrl?: string; /** * The title of the WMTS style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html#title) */ title?: string; } export interface WMTSSublayer extends Accessor, JSONSupport { } export class WMTSSublayer { /** * Description for the WMTS sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#description) */ description: string; /** * The full extent of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#fullExtent) */ fullExtent: Extent; /** * The unique ID assigned to the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#id) */ id: string; /** * The map image format (MIME type) to request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#imageFormat) */ imageFormat: string; /** * Supported image formats as retrieved from the GetCapabilities request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#imageFormats) */ imageFormats: string[]; /** * The [WMTSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html) to which the sublayer belongs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#layer) */ layer: WMTSLayer; /** * The parent [WMTSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html) to which the sublayer belongs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#parent) */ parent: WMTSLayer; /** * The [WMTSStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html) to request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#styleId) */ styleId: string; /** * A collection of supported [WMTSStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html)s as retrieved from the GetCapabilities request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#styles) */ styles: Collection; /** * The [TileMatrixSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html) to request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#tileMatrixSet) */ tileMatrixSet: TileMatrixSet; /** * The id of the [TileMatrixSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html) to request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#tileMatrixSetId) */ tileMatrixSetId: string; /** * A collection of supported [TileMatrixSets](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#tileMatrixSets) */ tileMatrixSets: Collection; /** * The title of the WMTS sublayer used to identify it in places such as the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) and [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widgets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#title) */ title: string; /** * Represents a sublayer in a [WMTSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html) */ constructor(properties?: WMTSSublayerProperties); /** * Creates a deep clone of the WMTS sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#clone) */ clone(): WMTSSublayer; static fromJSON(json: any): WMTSSublayer; } interface WMTSSublayerProperties { /** * Description for the WMTS sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#description) */ description?: string; /** * The full extent of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#fullExtent) */ fullExtent?: ExtentProperties; /** * The unique ID assigned to the sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#id) */ id?: string; /** * The map image format (MIME type) to request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#imageFormat) */ imageFormat?: string; /** * Supported image formats as retrieved from the GetCapabilities request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#imageFormats) */ imageFormats?: string[]; /** * The [WMTSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html) to which the sublayer belongs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#layer) */ layer?: WMTSLayerProperties; /** * The parent [WMTSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html) to which the sublayer belongs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#parent) */ parent?: WMTSLayerProperties; /** * The [WMTSStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html) to request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#styleId) */ styleId?: string; /** * A collection of supported [WMTSStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html)s as retrieved from the GetCapabilities request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#styles) */ styles?: CollectionProperties; /** * The [TileMatrixSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html) to request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#tileMatrixSet) */ tileMatrixSet?: TileMatrixSetProperties; /** * The id of the [TileMatrixSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html) to request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#tileMatrixSetId) */ tileMatrixSetId?: string; /** * A collection of supported [TileMatrixSets](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#tileMatrixSets) */ tileMatrixSets?: CollectionProperties; /** * The title of the WMTS sublayer used to identify it in places such as the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) and [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widgets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#title) */ title?: string; } export interface TileLayer extends Layer, SublayersOwner, ArcGISMapService, ArcGISCachedService, RefreshableLayer, ScaleRangeLayer, PortalLayer, BlendLayer, CustomParametersMixin, APIKeyMixin, OperationalLayer { } export class TileLayer { /** * A flat [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of all the [sublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#sublayers) in the TileLayer including the sublayers of its sublayers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#allSublayers) */ readonly allSublayers: Collection; /** * The URL that points to the location of the layer's attribution data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#attributionDataUrl) */ readonly attributionDataUrl: string; /** * Indicates if the layer has attribution data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#hasAttributionData) */ readonly hasAttributionData: boolean; /** * Resampling is enabled by default in 2D [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) and 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#resampling) */ resampling: boolean; /** * The [tiled map service's metadata JSON](https://developers.arcgis.com/rest/services-reference/map-service.htm) exposed by the ArcGIS REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#sourceJSON) */ sourceJSON: any; /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [Sublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html) objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#sublayers) */ readonly sublayers: Collection; /** * An array of tile servers used for changing map tiles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#tileServers) */ tileServers: string[]; readonly type: "tile"; /** * The URL of the REST endpoint of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#url) */ url: string; /** * The TileLayer allows you work with a cached [map service](https://enterprise.arcgis.com/en/server/latest/publish-services/windows/what-is-a-map-service.htm) exposed by the ArcGIS Server REST API and add it to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) as a tile layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html) */ constructor(properties?: TileLayerProperties); /** * This method fetches a tile for the given level, row and column present in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#fetchTile) */ fetchTile(level: number, row: number, col: number, options?: TileLayerFetchTileOptions): Promise; /** * This method returns a URL to a tile for a given level, row and column. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#getTileUrl) */ getTileUrl(level: number, row: number, col: number): string; /** * Loads all of the sublayers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#loadAll) */ loadAll(): Promise; on(name: "refresh", eventHandler: TileLayerRefreshEventHandler): IHandle; on(name: "layerview-create", eventHandler: TileLayerLayerviewCreateEventHandler): IHandle; on(name: "layerview-create-error", eventHandler: TileLayerLayerviewCreateErrorEventHandler): IHandle; on(name: "layerview-destroy", eventHandler: TileLayerLayerviewDestroyEventHandler): IHandle; static fromJSON(json: any): TileLayer; } interface TileLayerProperties extends LayerProperties, ArcGISMapServiceProperties, ArcGISCachedServiceProperties, RefreshableLayerProperties, ScaleRangeLayerProperties, PortalLayerProperties, BlendLayerProperties, CustomParametersMixinProperties, APIKeyMixinProperties, OperationalLayerProperties { /** * Resampling is enabled by default in 2D [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) and 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#resampling) */ resampling?: boolean; /** * The [tiled map service's metadata JSON](https://developers.arcgis.com/rest/services-reference/map-service.htm) exposed by the ArcGIS REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#sourceJSON) */ sourceJSON?: any; /** * An array of tile servers used for changing map tiles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#tileServers) */ tileServers?: string[]; /** * The URL of the REST endpoint of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#url) */ url?: string; } export interface TileLayerLayerviewCreateErrorEvent { error: Error; view: View; } export interface TileLayerLayerviewCreateEvent { layerView: LayerView; view: View; } export interface TileLayerLayerviewDestroyEvent { layerView: LayerView; view: View; } export interface TileLayerRefreshEvent { dataChanged: boolean; } export interface TileLayerFetchTileOptions { /** * [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#fetchTile) */ signal?: AbortSignal; } export class UnknownLayer extends Layer { readonly type: "unknown"; /** * Represents a layer whose type could not be determined. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-UnknownLayer.html) */ constructor(properties?: UnknownLayerProperties); } interface UnknownLayerProperties extends LayerProperties { } export class UnsupportedLayer extends Layer { readonly type: "unsupported"; /** * Represents an unsupported layer instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-UnsupportedLayer.html) */ constructor(properties?: UnsupportedLayerProperties); } interface UnsupportedLayerProperties extends LayerProperties { } export interface VectorTileLayer extends Layer, OperationalLayer, ScaleRangeLayer, BlendLayer { } export class VectorTileLayer { /** * An authorization string used to access a resource or service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#apiKey) */ apiKey: string; /** * The URL that points to the location of the layer's attribution data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#attributionDataUrl) */ readonly attributionDataUrl: string; /** * Indicates the layer's supported capabilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#capabilities) */ readonly capabilities: VectorTileLayerCapabilities; /** * The current style information of the VectorTileLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#currentStyleInfo) */ readonly currentStyleInfo: VectorTileLayerCurrentStyleInfo; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#customParameters) */ customParameters: any; /** * The initial extent of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#initialExtent) */ initialExtent: Extent; /** * The portal item from which the layer is loaded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#portalItem) */ portalItem: PortalItem; /** * The spatial reference of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#spatialReference) */ spatialReference: SpatialReference; /** * A style JSON object of vector tiles that will be used to render the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#style) */ style: any; /** * The tiling scheme information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#tileInfo) */ tileInfo: TileInfo; readonly type: "vector-tile"; /** * The URL to the vector tile service, or the URL to the style resource of vector tiles that will be used to render the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#url) */ url: string; /** * VectorTileLayer accesses cached tiles of data and renders it in vector format. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html) */ constructor(properties?: VectorTileLayerProperties); /** * Deletes the specified [style layer](https://maplibre.org/maplibre-style-spec/layers/) from the VectorTileLayer's [currentStyleInfo.style](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#currentStyleInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#deleteStyleLayer) */ deleteStyleLayer(layerId: string): void; /** * Returns an instance of [layout](https://maplibre.org/maplibre-style-spec/layers/#layout-property) properties for the specified [style layer](https://maplibre.org/maplibre-style-spec/layers/). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#getLayoutProperties) */ getLayoutProperties(layerId: string): any; /** * Returns an instance of [paint](https://maplibre.org/maplibre-style-spec/layers/#paint) properties for the specified [style layer](https://maplibre.org/maplibre-style-spec/layers/). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#getPaintProperties) */ getPaintProperties(layerId: string): any; /** * Returns an instance of a [style layer](https://maplibre.org/maplibre-style-spec/layers) from the VectorTileLayer's [currentStyleInfo.style](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#currentStyleInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#getStyleLayer) */ getStyleLayer(layerId: string): any; /** * Returns the layer [id](https://maplibre.org/maplibre-style-spec/layers/#id) of the [style layer](https://maplibre.org/maplibre-style-spec/layers) based on its index. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#getStyleLayerId) */ getStyleLayerId(index: number): string; /** * Returns the index of the [style layer](https://maplibre.org/maplibre-style-spec/layers) from the VectorTileLayer's [currentStyleInfo.style](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#currentStyleInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#getStyleLayerIndex) */ getStyleLayerIndex(layerId: string): number; /** * Gets the visibility of the specified [style layer](https://maplibre.org/maplibre-style-spec/layers/) from the VectorTileLayer's [currentStyleInfo.style](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#currentStyleInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#getStyleLayerVisibility) */ getStyleLayerVisibility(layerId: string): string; /** * Loads a style to render a layer from the specified URL to a style resource or style JSON object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#loadStyle) */ loadStyle(style: string | any, options?: VectorTileLayerLoadStyleOptions): Promise; /** * Updates the [layout](https://maplibre.org/maplibre-style-spec/layers/#layout-property) properties to the specified [style layer](https://maplibre.org/maplibre-style-spec/layers/). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#setLayoutProperties) */ setLayoutProperties(layerId: string, layout: any): void; /** * Updates the [paint](https://maplibre.org/maplibre-style-spec/layers/#paint) properties to the specified [style layer](https://maplibre.org/maplibre-style-spec/layers). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#setPaintProperties) */ setPaintProperties(layerId: string, painter: any): void; /** * Changes the sprite source associated with the VectorTileLayer's [current style](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#currentStyleInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#setSpriteSource) */ setSpriteSource(spriteSourceInfo: SpriteSourceImageInfo | SpriteSourceUrlInfo): Promise; /** * Changes the layer properties of the specified [style layer](https://maplibre.org/maplibre-style-spec/layers/). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#setStyleLayer) */ setStyleLayer(layer: any, index?: number): void; /** * Toggles the visibility of the specified [style layer](https://maplibre.org/maplibre-style-spec/layers/) in the VectorTileLayer's [currentStyleInfo.style](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#currentStyleInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#setStyleLayerVisibility) */ setStyleLayerVisibility(layerId: string, visibility: "none" | "visible"): void; static fromJSON(json: any): VectorTileLayer; } interface VectorTileLayerProperties extends LayerProperties, OperationalLayerProperties, ScaleRangeLayerProperties, BlendLayerProperties { /** * An authorization string used to access a resource or service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#apiKey) */ apiKey?: string; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#customParameters) */ customParameters?: any; /** * The initial extent of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#initialExtent) */ initialExtent?: ExtentProperties; /** * The portal item from which the layer is loaded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#portalItem) */ portalItem?: PortalItemProperties; /** * The spatial reference of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * A style JSON object of vector tiles that will be used to render the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#style) */ style?: any; /** * The tiling scheme information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#tileInfo) */ tileInfo?: TileInfoProperties; /** * The URL to the vector tile service, or the URL to the style resource of vector tiles that will be used to render the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#url) */ url?: string; } export type GetSpriteInfo = (name: string) => SpriteInfo; /** * Defines an image object that can be used when setting [SpriteSourceImageInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteSourceImageInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#ImageObject) */ export interface ImageObject { /** * The width of the sprite. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#ImageObject) */ width: number; /** * The height of the sprite. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#ImageObject) */ height: number; /** * The image data for the sprite. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#ImageObject) */ data: ArrayBuffer; } /** * A description of each image contained in the sprite. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteInfo) */ export interface SpriteInfo { /** * The x position of the upper-left corner of the sprite. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteInfo) */ x: number; /** * The y position of the upper-left corner of the sprite. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteInfo) */ y: number; /** * The height of the sprite. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteInfo) */ height: number; /** * The width of the sprite. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteInfo) */ width: number; /** * The pixel ratio of the sprite. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteInfo) */ pixelRatio?: number; /** * Whether the sprite is SDF or not. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteInfo) */ sdf?: number; } /** * The sprite source returned from the [setSpriteSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#setSpriteSource) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteSource) */ export interface SpriteSource { /** * The base URL of the sprites source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteSource) */ baseUrl: string; /** * Indicates whether the sprite source is loaded successfully. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteSource) */ loadStatus: any | any | any | any; /** * The device pixel ratio of the sprite source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteSource) */ devicePixelRatio: number; /** * The height in pixels of the sprite source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteSource) */ height: number; /** * The width in pixels of the sprite source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteSource) */ width: number; /** * The sprite image data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteSource) */ image: Uint8Array; /** * Returns the sprite info for the given sprite. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteSource) */ getSpriteInfo: GetSpriteInfo; } /** * Defines sprite source from an image and index json when the [setSpriteSource()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#setSpriteSource) method is called. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteSourceImageInfo) */ export interface SpriteSourceImageInfo { /** * For SpriteSourceImageInfo the type is always "image". * * [Read more...](global.html#type) */ type: string; /** * The sprite source url. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteSourceImageInfo) */ spriteUrl?: string; /** * The device pixel ratio of the sprite source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteSourceImageInfo) */ pixelRatio?: number; /** * Sprite source for non high-DPI devices. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteSourceImageInfo) */ spriteSource1x?: SpriteSourceImageInfoSpriteSource1x; /** * Sprite source for high-DPI devices. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteSourceImageInfo) */ spriteSource2x?: SpriteSourceImageInfoSpriteSource2x; } /** * The URL of the sprite source to be fetched when the [setSpriteSource()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#setSpriteSource) method is called. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteSourceUrlInfo) */ export interface SpriteSourceUrlInfo { /** * For SpriteSourceUrlInfo the type is always "url". * * [Read more...](global.html#type) */ type: string; /** * The sprite source url. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteSourceUrlInfo) */ spriteUrl: string; /** * The device pixel ratio used to fetch the appropriate sprite source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteSourceUrlInfo) */ pixelRatio?: number; /** * The sprite image format. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteSourceUrlInfo) */ spriteFormat?: "png" | "webp"; } export interface VectorTileLayerCapabilities { /** * Indicates options supported by the exportTiles operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#capabilities) */ exportTiles: any; exportMap: VectorTileLayerCapabilitiesExportMap; /** * Indicates operations that can be performed on the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#capabilities) */ operations: VectorTileLayerCapabilitiesOperations; } export interface VectorTileLayerCapabilitiesExportMap { /** * Specifies the maximum number of tiles that can be exported to a cache dataset or a tile package. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#capabilities) */ maxExportTilesCount: number; } export interface VectorTileLayerCapabilitiesOperations { /** * Indicates if the tiles from the service can be exported. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#capabilities) */ supportsExportTiles: boolean; /** * Indicates if the service exposes a tile map that describes the presence of tiles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#capabilities) */ supportsTileMap: boolean; } export interface VectorTileLayerCurrentStyleInfo { /** * Absolute URL for a vector tile service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#currentStyleInfo) */ serviceUrl: string; /** * Absolute URL for vector tile service style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#currentStyleInfo) */ styleUrl: string; /** * Absolute URL for sprites included in a style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#currentStyleInfo) */ spriteUrl: string; /** * Absolute template URL for font sets included in a style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#currentStyleInfo) */ glyphsUrl: string; /** * Style JSON object for vector tiles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#currentStyleInfo) */ style: any; /** * Vector tile service information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#currentStyleInfo) */ layerDefinition: any; } export interface VectorTileLayerLoadStyleOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#loadStyle) */ signal?: AbortSignal; } export interface SpriteSourceImageInfoSpriteSource1x { /** * Image containing sprite data for non high-DPI devices. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteSourceImageInfo) */ image: HTMLImageElement | HTMLCanvasElement | any | ImageData | ImageObject; /** * The JSON representation of an index file containing a description of each image in the sprite for non high-DPI devices. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteSourceImageInfo) */ json: SpriteInfo; } export interface SpriteSourceImageInfoSpriteSource2x { /** * Image containing sprite data for high-DPI devices. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteSourceImageInfo) */ image: HTMLImageElement | HTMLCanvasElement | any | ImageData | ImageObject; /** * The JSON representation of an index file containing a description of each image in the sprite for high-DPI devices. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#SpriteSourceImageInfo) */ json: SpriteInfo; } export interface VoxelDynamicSection extends JSONSupport, Clonable { } export class VoxelDynamicSection { /** * Whether or not the dynamic section is enabled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelDynamicSection.html#enabled) */ enabled: boolean; /** * The label for the dynamic section. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelDynamicSection.html#label) */ label: string; /** * The orientation angle (in the degrees) of the dynamic section plane. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelDynamicSection.html#orientation) */ orientation: number; /** * A point on the dynamic section plane specified as [x ,y, z] in voxel space for XYZ and XYZT volumes and as [x, y, t] for XYT volumes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelDynamicSection.html#point) */ point: number[]; /** * The tilt angle (in degrees) of the dynamic section plane. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelDynamicSection.html#tilt) */ tilt: number; /** * The VoxelDynamicSection allows you to define the properties of an individual dynamic section. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelDynamicSection.html) */ constructor(properties?: VoxelDynamicSectionProperties); static fromJSON(json: any): VoxelDynamicSection; } interface VoxelDynamicSectionProperties { /** * Whether or not the dynamic section is enabled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelDynamicSection.html#enabled) */ enabled?: boolean; /** * The label for the dynamic section. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelDynamicSection.html#label) */ label?: string; /** * The orientation angle (in the degrees) of the dynamic section plane. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelDynamicSection.html#orientation) */ orientation?: number; /** * A point on the dynamic section plane specified as [x ,y, z] in voxel space for XYZ and XYZT volumes and as [x, y, t] for XYT volumes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelDynamicSection.html#point) */ point?: number[]; /** * The tilt angle (in degrees) of the dynamic section plane. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelDynamicSection.html#tilt) */ tilt?: number; } export interface VoxelSlice extends JSONSupport, Clonable { } export class VoxelSlice { /** * Whether or not the slice is enabled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelSlice.html#enabled) */ enabled: boolean; /** * The label for the slice. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelSlice.html#label) */ label: string; /** * The orientation angle (in the degrees) of the slice plane. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelSlice.html#orientation) */ orientation: number; /** * A point on the slice plane specified as [x ,y, z] in voxel space for XYZ and XYZT volumes and as [x, y, t] for XYT volumes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelSlice.html#point) */ point: number[]; /** * The tilt angle (in degrees) of the slice plane. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelSlice.html#tilt) */ tilt: number; /** * The VoxelSlice allows you to define the properties of an individual slice. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelSlice.html) */ constructor(properties?: VoxelSliceProperties); static fromJSON(json: any): VoxelSlice; } interface VoxelSliceProperties { /** * Whether or not the slice is enabled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelSlice.html#enabled) */ enabled?: boolean; /** * The label for the slice. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelSlice.html#label) */ label?: string; /** * The orientation angle (in the degrees) of the slice plane. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelSlice.html#orientation) */ orientation?: number; /** * A point on the slice plane specified as [x ,y, z] in voxel space for XYZ and XYZT volumes and as [x, y, t] for XYT volumes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelSlice.html#point) */ point?: number[]; /** * The tilt angle (in degrees) of the slice plane. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelSlice.html#tilt) */ tilt?: number; } export interface VoxelTransferFunctionStyle extends JSONSupport, Clonable { } export class VoxelTransferFunctionStyle { /** * A collection of colors and normalized positions which describe how to colorize the data values that are within the [stretchRange](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelTransferFunctionStyle.html#stretchRange). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelTransferFunctionStyle.html#colorStops) */ colorStops: Collection; /** * A collection of transparency values and normalized positions which describe how to apply transparency to the data values that are within the [stretchRange](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelTransferFunctionStyle.html#stretchRange). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelTransferFunctionStyle.html#opacityStops) */ opacityStops: Collection; /** * Defines the data range which will be rendered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelTransferFunctionStyle.html#rangeFilter) */ rangeFilter: VoxelRangeFilter; /** * The data range to apply the color and alpha stops to, specified as [minimum, maximum] in the units of the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelTransferFunctionStyle.html#stretchRange) */ stretchRange: number[]; /** * The VoxelTransferFunctionStyle allows you to define how an individual continuous variable is rendered as a volume or as sections. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelTransferFunctionStyle.html) */ constructor(properties?: VoxelTransferFunctionStyleProperties); static fromJSON(json: any): VoxelTransferFunctionStyle; } interface VoxelTransferFunctionStyleProperties { /** * A collection of colors and normalized positions which describe how to colorize the data values that are within the [stretchRange](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelTransferFunctionStyle.html#stretchRange). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelTransferFunctionStyle.html#colorStops) */ colorStops?: CollectionProperties; /** * A collection of transparency values and normalized positions which describe how to apply transparency to the data values that are within the [stretchRange](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelTransferFunctionStyle.html#stretchRange). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelTransferFunctionStyle.html#opacityStops) */ opacityStops?: CollectionProperties; /** * Defines the data range which will be rendered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelTransferFunctionStyle.html#rangeFilter) */ rangeFilter?: VoxelRangeFilter; /** * The data range to apply the color and alpha stops to, specified as [minimum, maximum] in the units of the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelTransferFunctionStyle.html#stretchRange) */ stretchRange?: number[]; } /** * VoxelColorStop defines a color and a normalized position. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelTransferFunctionStyle.html#VoxelColorStop) */ export interface VoxelColorStop { /** * The color to render data at this position with. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelTransferFunctionStyle.html#VoxelColorStop) */ color: Color; /** * The normalized (i.e. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelTransferFunctionStyle.html#VoxelColorStop) */ position: number; } /** * VoxelOpacityStop defines an opacity value and a normalized position. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelTransferFunctionStyle.html#VoxelOpacityStop) */ export interface VoxelOpacityStop { /** * The opacity value (0 = transparent, 1 = opaque) to apply to data at this position. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelTransferFunctionStyle.html#VoxelOpacityStop) */ opacity: number; /** * The normalized (i.e. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelTransferFunctionStyle.html#VoxelOpacityStop) */ position: number; } /** * VoxelRangeFilter defines the data range which will be rendered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelTransferFunctionStyle.html#VoxelRangeFilter) */ export interface VoxelRangeFilter { /** * Whether or not the filter is enabled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelTransferFunctionStyle.html#VoxelRangeFilter) */ enabled?: boolean; /** * The data range to render, specified as [minimum, maximum]. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelTransferFunctionStyle.html#VoxelRangeFilter) */ range: number[]; } /** * Describes a single variable in the [VoxelLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariable.html) */ interface voxelVoxelVariable { /** * The original data source description of the variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariable.html#description) */ readonly description: string; /** * The unique identifier for the variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariable.html#id) */ readonly id: number; /** * The original data source name of the variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariable.html#name) */ readonly name: string; /** * A description of various properties of the variable as it is represented on the GPU. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariable.html#renderingFormat) */ readonly renderingFormat: voxelVoxelVariableRenderingFormat; /** * The variable units. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariable.html#unit) */ readonly unit: string; /** * The volumeId of the variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariable.html#volumeId) */ readonly volumeId: number; } export const voxelVoxelVariable: voxelVoxelVariable; export interface voxelVoxelVariableRenderingFormat { /** * Whether or not the data is discrete or continuous. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariable.html#renderingFormat) */ continuity: "discrete" | "continuous"; /** * Whether or not the data has a value representing NoData. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariable.html#renderingFormat) */ hasNoData?: boolean; /** * The NoData value if there is one. * * @default 0.0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariable.html#renderingFormat) */ noData?: number; /** * Indicates how the data are encoded. * * [Read more...](global.html#type) */ type: "Int8" | "UInt8" | "Int16" | "UInt16" | "Int32" | "UInt32" | "Float32"; } export interface VoxelVariableStyle extends JSONSupport, Clonable { } export class VoxelVariableStyle { /** * The collection of continuous variable isosurfaces. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html#isosurfaces) */ isosurfaces: Collection; /** * The variable label. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html#label) */ label: string; /** * The transferFunction describes how to render continuous variable volumes and sections. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html#transferFunction) */ transferFunction: VoxelTransferFunctionStyle; /** * The collection of unique values describes how to render discrete variable volumes and sections. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html#uniqueValues) */ uniqueValues: Collection; /** * Id of the [VoxelVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariable.html) that the style applies to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html#variableId) */ variableId: number; /** * The VoxelVariableStyle allows you to define how an individual variable is rendered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html) */ constructor(properties?: VoxelVariableStyleProperties); static fromJSON(json: any): VoxelVariableStyle; } interface VoxelVariableStyleProperties { /** * The collection of continuous variable isosurfaces. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html#isosurfaces) */ isosurfaces?: CollectionProperties; /** * The variable label. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html#label) */ label?: string; /** * The transferFunction describes how to render continuous variable volumes and sections. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html#transferFunction) */ transferFunction?: VoxelTransferFunctionStyleProperties; /** * The collection of unique values describes how to render discrete variable volumes and sections. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html#uniqueValues) */ uniqueValues?: CollectionProperties; /** * Id of the [VoxelVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariable.html) that the style applies to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html#variableId) */ variableId?: number; } /** * VoxelIsosurface describes an isosurface value and how to render it. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html#VoxelIsosurface) */ export interface VoxelIsosurface { /** * The color to render this isosurface with. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html#VoxelIsosurface) */ color: Color; /** * The data value for this isosurface. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html#VoxelIsosurface) */ value: number; /** * Whether or not to render this isosurface. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html#VoxelIsosurface) */ enabled?: boolean; /** * The label string for this isosurface. * * [Read more...](global.html) */ label?: string; /** * Whether or not the isosurface color is automatically updated when the variable's transfer function's color stops change. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html#VoxelIsosurface) */ colorLocked?: boolean; } /** * VoxelUniqueValue describes a particular voxel discrete value how to render it. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html#VoxelUniqueValue) */ export interface VoxelUniqueValue { /** * The color to render this value with. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html#VoxelUniqueValue) */ color: Color; /** * The data value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html#VoxelUniqueValue) */ value: number; /** * Whether or not to render data with this value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html#VoxelUniqueValue) */ enabled?: boolean; /** * The label string for this value. * * [Read more...](global.html) */ label?: string; } /** * The VoxelVolume exposes properties that describe the volume and methods to convert to and from voxel space. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVolume.html) */ interface VoxelVolume { /** * The unique identifier for the volume. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVolume.html#id) */ readonly id: number; /** * A 3-component array containing the volume size in voxels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVolume.html#sizeInVoxels) */ sizeInVoxels: number[]; /** * Returns the type of the current variable's volume. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVolume.html#volumeType) */ volumeType: "xyz" | "xyzt" | "xyt"; /** * Convert a position in voxel space to the spatialReference of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVolume.html#computeLayerSpaceLocation) */ computeLayerSpaceLocation(posInVoxelSpace: number[]): Point; /** * Convert a position from the layer's spatialReference to voxel space for XYZ or XYZT volumes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVolume.html#computeVoxelSpaceLocation) */ computeVoxelSpaceLocation(pos: Point): number[]; } export const VoxelVolume: VoxelVolume; export interface voxelVoxelVolumeStyle extends JSONSupport, Clonable { } export class voxelVoxelVolumeStyle { /** * The collection of [VoxelDynamicSection](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelDynamicSection.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVolumeStyle.html#dynamicSections) */ dynamicSections: Collection; /** * The collection of [VoxelSlice](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelSlice.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVolumeStyle.html#slices) */ slices: Collection; /** * The vertical exaggeration factor. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVolumeStyle.html#verticalExaggeration) */ verticalExaggeration: number; /** * The vertical offset amount. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVolumeStyle.html#verticalOffset) */ verticalOffset: number; /** * Id of the volume. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVolumeStyle.html#volumeId) */ readonly volumeId: number; /** * The VolumeStyle allows you to define rendering properties that apply to the volume itself, such as vertical exaggeration and offset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVolumeStyle.html) */ constructor(properties?: voxelVoxelVolumeStyleProperties); static fromJSON(json: any): voxelVoxelVolumeStyle; } interface voxelVoxelVolumeStyleProperties { /** * The collection of [VoxelDynamicSection](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelDynamicSection.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVolumeStyle.html#dynamicSections) */ dynamicSections?: CollectionProperties; /** * The collection of [VoxelSlice](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelSlice.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVolumeStyle.html#slices) */ slices?: CollectionProperties; /** * The vertical exaggeration factor. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVolumeStyle.html#verticalExaggeration) */ verticalExaggeration?: number; /** * The vertical offset amount. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVolumeStyle.html#verticalOffset) */ verticalOffset?: number; } export interface VoxelLayer extends Layer, SceneService, PortalLayer, ScaleRangeLayer, CustomParametersMixin, APIKeyMixin, OperationalLayer { } export class VoxelLayer { /** * The variable that is being displayed. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#currentVariableId) */ currentVariableId: number; /** * Controls whether or not to globally disable all dynamic sections in the current [VoxelVolumeStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVolumeStyle.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#enableDynamicSections) */ enableDynamicSections: boolean; /** * Controls whether or not to globally disable all isosurfaces in the current [VoxelVariableStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#enableIsosurfaces) */ enableIsosurfaces: boolean; /** * Controls whether or not to globally disable all slices in the current [VoxelVolumeStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVolumeStyle.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#enableSlices) */ enableSlices: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#legendEnabled) */ legendEnabled: boolean; /** * Indicates whether to display popups when voxels in the layer are clicked. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#popupEnabled) */ popupEnabled: boolean; /** * Current rendering mode for the [VoxelLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html). * * @default "volume" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#renderMode) */ renderMode: "volume" | "surfaces"; readonly type: "voxel"; /** * The collection of variables that the VoxelLayer has data for. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#variables) */ readonly variables: Collection; /** * The collection of variable styles, containing exactly one [VoxelVariableStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html) for each [VoxelVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariable.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#variableStyles) */ variableStyles: Collection; /** * The collection of volumes that the VoxelLayer has variables for. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#volumes) */ readonly volumes: Collection; /** * The collection of volume styles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#volumeStyles) */ volumeStyles: Collection; /** * A voxel layer represents multidimensional volumetric data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html) */ constructor(properties?: VoxelLayerProperties); /** * Returns a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) for a given value for the continuous [VoxelVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariable.html) identified by variableId using the variable's [VoxelTransferFunctionStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelTransferFunctionStyle.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#getColorForContinuousDataValue) */ getColorForContinuousDataValue(variableId: number, dataValue: number, applyOpacityStops: boolean): Color | null; /** * Returns a [VoxelVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariable.html) based on an id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#getVariable) */ getVariable(variableId: number | null): voxelVoxelVariable | null; /** * Returns a [VoxelVariableStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html) based on an id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#getVariableStyle) */ getVariableStyle(variableId: number | null): VoxelVariableStyle | null; /** * Returns a [VoxelVolume](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVolume.html) based on the id of a [VoxelVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariable.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#getVolume) */ getVolume(variableId: number | null): VoxelVolume | null; /** * Returns a [VoxelVolumeStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVolumeStyle.html) based on the id of a [VoxelVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariable.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#getVolumeStyle) */ getVolumeStyle(variableId: number | null): voxelVoxelVolumeStyle | null; static fromJSON(json: any): VoxelLayer; } interface VoxelLayerProperties extends LayerProperties, SceneServiceProperties, PortalLayerProperties, ScaleRangeLayerProperties, CustomParametersMixinProperties, APIKeyMixinProperties, OperationalLayerProperties { /** * The variable that is being displayed. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#currentVariableId) */ currentVariableId?: number; /** * Controls whether or not to globally disable all dynamic sections in the current [VoxelVolumeStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVolumeStyle.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#enableDynamicSections) */ enableDynamicSections?: boolean; /** * Controls whether or not to globally disable all isosurfaces in the current [VoxelVariableStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#enableIsosurfaces) */ enableIsosurfaces?: boolean; /** * Controls whether or not to globally disable all slices in the current [VoxelVolumeStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVolumeStyle.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#enableSlices) */ enableSlices?: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#legendEnabled) */ legendEnabled?: boolean; /** * Indicates whether to display popups when voxels in the layer are clicked. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#popupEnabled) */ popupEnabled?: boolean; /** * Current rendering mode for the [VoxelLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html). * * @default "volume" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#renderMode) */ renderMode?: "volume" | "surfaces"; /** * The collection of variable styles, containing exactly one [VoxelVariableStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariableStyle.html) for each [VoxelVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-voxel-VoxelVariable.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#variableStyles) */ variableStyles?: CollectionProperties; /** * The collection of volume styles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#volumeStyles) */ volumeStyles?: CollectionProperties; } export interface WCSLayer extends Layer, ImageryTileMixin, OperationalLayer, PortalLayer, ScaleRangeLayer { } export class WCSLayer { /** * The coverage identifier for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#coverageId) */ coverageId: string; /** * Coverage information retrieved from the WCS Server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#coverageInfo) */ coverageInfo: CoverageInfo; /** * Use this property to append custom parameters to all WCS requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#customParameters) */ customParameters: any; /** * Defines how to interpolate pixel values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#interpolation) */ interpolation: "nearest" | "bilinear" | "cubic" | "majority"; /** * An array of raster fields in the layer that consists of service pixel value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#rasterFields) */ rasterFields: Field[]; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#renderer) */ renderer: ClassBreaksRenderer | RasterStretchRenderer; /** * The layer's time extent. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#timeExtent) */ timeExtent: TimeExtent; /** * TimeInfo provides information such as date fields that store [start](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#startField) and [end](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#endField) time for each feature and the [fullTimeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#fullTimeExtent) for the layer. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#timeInfo) */ timeInfo: TimeInfo; /** * A temporary offset of the time data based on a certain [TimeInterval](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeInterval.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#timeOffset) */ timeOffset: TimeInterval; readonly type: "wcs"; /** * The URL of the WCS service endpoint of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#url) */ url: string; /** * Determines if the layer will update its temporal data based on the view's [timeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#timeExtent). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#useViewTime) */ useViewTime: boolean; /** * The version of Web Coverage Service currently being used. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#version) */ version: string; /** * WCS presents raster data from a [OGC Web Coverage Service](https://www.ogc.org/standards/wcs). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html) */ constructor(properties?: WCSLayerProperties); /** * Creates a default popup template for the layer, populated with all the fields of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#createPopupTemplate) */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate; static fromJSON(json: any): WCSLayer; } interface WCSLayerProperties extends LayerProperties, ImageryTileMixinProperties, OperationalLayerProperties, PortalLayerProperties, ScaleRangeLayerProperties { /** * The coverage identifier for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#coverageId) */ coverageId?: string; /** * Coverage information retrieved from the WCS Server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#coverageInfo) */ coverageInfo?: CoverageInfo; /** * Use this property to append custom parameters to all WCS requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#customParameters) */ customParameters?: any; /** * Defines how to interpolate pixel values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#interpolation) */ interpolation?: "nearest" | "bilinear" | "cubic" | "majority"; /** * An array of raster fields in the layer that consists of service pixel value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#rasterFields) */ rasterFields?: FieldProperties[]; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#renderer) */ renderer?: | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (RasterStretchRendererProperties & { type: "raster-stretch" }); /** * The layer's time extent. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#timeExtent) */ timeExtent?: TimeExtentProperties; /** * TimeInfo provides information such as date fields that store [start](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#startField) and [end](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#endField) time for each feature and the [fullTimeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#fullTimeExtent) for the layer. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#timeInfo) */ timeInfo?: TimeInfoProperties; /** * A temporary offset of the time data based on a certain [TimeInterval](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeInterval.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#timeOffset) */ timeOffset?: TimeIntervalProperties; /** * The URL of the WCS service endpoint of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#url) */ url?: string; /** * Determines if the layer will update its temporal data based on the view's [timeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#timeExtent). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#useViewTime) */ useViewTime?: boolean; /** * The version of Web Coverage Service currently being used. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#version) */ version?: string; } /** * Coverage description for WCS service version 1.0.0. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ export interface CoverageDescriptionV100 { /** * Coverage name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ name: string; /** * Coverage label. * * [Read more...](global.html) */ label: string; /** * Coverage description. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ description: string; /** * Formats supported by a coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ supportedFormats: string[]; /** * Interpolations supported by a coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ supportedInterpolations: string[]; /** * Coordinate reference systems supported by a coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ supportedCRSs: CoverageDescriptionV100SupportedCRSs; /** * Spatial extent of the coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ lonLatEnvelope: Extent; /** * Defines the properties (categories, measures, or values) assigned to each location in the domain. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ rangeSet: CoverageDescriptionV100RangeSet; /** * Describes the spatial and temporal domain of a coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ domainSet: CoverageDescriptionV100DomainSet; /** * Coverage version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ version: "1.0"; } /** * Coverage description for WCS service version 1.1.0. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ export interface CoverageDescriptionV110 { /** * Coverage title. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ title: string; /** * Coverage abstract. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ abstract: string; /** * Coverage identifier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ identifier: string; /** * Formats supported by a coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ supportedFormats: string[]; /** * Coordinate reference systems supported by a coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ supportedCRSs: string[]; /** * Describes the spatial and temporal domain of a coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ domain: CoverageDescriptionV110Domain; /** * Specifies spatial resolution of the coordinate reference system. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ gridBaseCRS: string; /** * Indicates if the EPSG axis is used. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ useEPSGAxis: boolean; /** * Temporal domain or extent of the coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ temporalDomain: TemporalDomain; /** * Defines the properties (categories, measures, or values) assigned to each location in the domain. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ range: CoverageDescriptionV110Range; /** * Resolution x, y. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ resolution: CoverageDescriptionV110Resolution; /** * Coverage metadata. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ metadata?: string; /** * Coverage version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ version: "1.1"; } /** * Coverage description for WCS service version 2.0.1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ export interface CoverageDescriptionV201 { /** * Coverage id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ coverageId: string; /** * Spatial and temporal extent of a coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ boundedBy: CoverageDescriptionV201BoundedBy; /** * Domains associated with a coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ domainSet: CoverageDescriptionV201DomainSet; /** * Describes the semantics of the range set values supported by a coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ rangeType: CoverageDescriptionV201RangeType; /** * Service parameters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ serviceParameters: any; /** * Service x,y resolution. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ resolution: CoverageDescriptionV201Resolution; /** * Coverage function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ coverageFunction?: any; /** * Coverage extension. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ extension?: string; /** * The WCS 2.0 Earth Observation coverage metadata. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ EOCoverageMetadata: CoverageDescriptionV201EOCoverageMetadata; /** * Service version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ version: "2.0"; } /** * Coverage information associated with a WCS service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageInfo) */ export interface CoverageInfo { /** * Service coverage id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageInfo) */ id: string; /** * Service coverage title. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageInfo) */ title: string; /** * Service coverage description. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageInfo) */ description: string; /** * Spatial extent of the coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageInfo) */ lonLatEnvelope: Extent; /** * Coverage band names. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageInfo) */ bandNames: string[]; /** * Coverage raster info. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageInfo) */ rasterInfo: RasterInfo; /** * Formats supported by a service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageInfo) */ supportedFormats: string[]; /** * Interpolation supported by a service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageInfo) */ supportedInterpolations: "nearest" | "bilinear" | "cubic" | "majority"; /** * Coverage description for different versions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageInfo) */ coverageDescription: CoverageDescriptionV100 | CoverageDescriptionV110 | CoverageDescriptionV201; /** * The service version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageInfo) */ version: "1.0.0" | "1.1.0" | "1.1.1" | "1.1.2" | "2.0.1"; /** * Indicates if the EPSG axis is used. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageInfo) */ useEPSGAxis: boolean; } /** * Temporal domain or extent of a coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#TemporalDomain) */ export interface TemporalDomain { /** * Start date for the temporal domain of a coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#TemporalDomain) */ begin: Date; /** * End date for the temporal domain of a coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#TemporalDomain) */ end: Date; /** * Date values available in the temporal domain. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#TemporalDomain) */ values?: Date[]; /** * The numerical value of the temporal domain or extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#TemporalDomain) */ resolution?: number; /** * Temporal units such as day, month, year etc. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#TemporalDomain) */ units?: any; } export interface CoverageDescriptionV100DomainSet { /** * Spatial domain of a coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ spatialDomain: CoverageDescriptionV100DomainSetSpatialDomain; /** * Temporal domain or extent of a coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ temporalDomain?: TemporalDomain; } export interface CoverageDescriptionV100DomainSetSpatialDomain { /** * Spatial domain extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ envelope: Extent; /** * Spatial domain columns. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ columns: number; /** * Spatial domain rows. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ rows: number; /** * Spatial domain x, y offset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ offset: CoverageDescriptionV100DomainSetSpatialDomainOffset; /** * Spatial domain x, y origin. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ origin: CoverageDescriptionV100DomainSetSpatialDomainOrigin; } export interface CoverageDescriptionV100DomainSetSpatialDomainOffset { /** * Spatial domain x offset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ x: number; /** * Spatial domain y offset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ y: any; } export interface CoverageDescriptionV100DomainSetSpatialDomainOrigin { /** * Spatial domain x origin. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ x: number; /** * Spatial domain y origin. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ y: any; } export interface CoverageDescriptionV100RangeSet { /** * Range set name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ name: string; /** * Range set label. * * [Read more...](global.html) */ label: string; /** * The null values is used when valid values are not available. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ nullValues?: number[]; /** * Provides additional information on compound valued range set. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ axis: CoverageDescriptionV100RangeSetAxis[]; } export interface CoverageDescriptionV100RangeSetAxis { /** * Range axis name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ name: string; /** * Range axis label. * * [Read more...](global.html) */ label: string; /** * Range axis values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ values: string[]; } export interface CoverageDescriptionV100SupportedCRSs { /** * Coordinate reference systems in which the coverage can both accept GetCoverage requests and deliver coverage responses. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ requestResponseCRSs: string[]; /** * The native coordinate reference system of a coverage – that is, the coordinate reference systems in which coverages can be obtained without any distortion or degradation of the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV100) */ nativeCRSs: string[]; } export interface CoverageDescriptionV110Domain { /** * Spatial extent or domain of a coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ spatialDomain: CoverageDescriptionV110DomainSpatialDomain; } export interface CoverageDescriptionV110DomainSpatialDomain { /** * Spatial domain extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ envelope: Extent; /** * Spatial domain columns. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ columns: number; /** * Spatial domain rows. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ rows: number; /** * Spatial domain x, y offset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ offset: CoverageDescriptionV110DomainSpatialDomainOffset; /** * Spatial domain x, y origin. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ origin: CoverageDescriptionV110DomainSpatialDomainOrigin; } export interface CoverageDescriptionV110DomainSpatialDomainOffset { /** * Spatial domain x offset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ x: number; /** * Spatial domain y offset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ y: any; } export interface CoverageDescriptionV110DomainSpatialDomainOrigin { /** * Spatial domain x origin. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ x: number; /** * Spatial domain y origin. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ y: any; } export interface CoverageDescriptionV110Range { /** * Range identifier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ identifier: string; /** * Range description. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ description?: string; /** * Range definition. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ definition: string; /** * Range abstract. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ abstract?: string; /** * Range title. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ title?: string; /** * Interpolations supported by the range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ supportedInterpolations: string[]; /** * Null values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ nullValues?: number[]; /** * Provides additional information on compound valued range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ axis: CoverageDescriptionV110RangeAxis; } export interface CoverageDescriptionV110RangeAxis { /** * The range axis identifier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ identifier: string; /** * The axis unit of measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ uom: string; /** * The axis data type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ dataType: string; /** * The axis values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ values: string[]; /** * The axis bandNoDataValues. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ bandNoDataValues?: number[]; } export interface CoverageDescriptionV110Resolution { /** * Resolution x. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ x: any; /** * Resolution y. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV110) */ y: any; } export interface CoverageDescriptionV201BoundedBy { /** * The spatial extent of a coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ extent: Extent; /** * The coverage's axis name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ axisLabels: string[]; /** * List of unit of measure (uom) labels for all the axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ uomLabels: string[]; /** * The spatial extent dimensions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ envelopeAllDims: CoverageDescriptionV201BoundedByEnvelopeAllDims; /** * Start date for the temporal extent of a coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ beginPosition?: Date; /** * End date for the temporal extent of the coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ endPosition?: Date; /** * Is east first. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ isEastFirst: boolean; } export interface CoverageDescriptionV201BoundedByEnvelopeAllDims { /** * Spatial extent min x and y. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ mins: number[]; /** * Spatial extent min x and y. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ maxs: number[]; } export interface CoverageDescriptionV201DomainSet { /** * Domain columns of a coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ columns: number; /** * Domain rows of a coverage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ rows: number; /** * Domain origin. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ origin: number[]; /** * Domain offset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ offset: number[]; /** * Domain x, y resolution. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ resolution: CoverageDescriptionV201DomainSetResolution; /** * Domain grid samples. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ gridSamples: number[]; /** * Axis labels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ axisLabels: string[]; /** * Has same axis labels as bounded by. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ hasSameAxisLabelsAsBoundedBy: boolean; } export interface CoverageDescriptionV201DomainSetResolution { /** * Resolution x. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ x: number; /** * Resolution.y. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ y: number; } export interface CoverageDescriptionV201EOCoverageMetadata { /** * Earth observation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ observation: CoverageDescriptionV201EOCoverageMetadataObservation; /** * Earth observation identifier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ identifier: string; } export interface CoverageDescriptionV201EOCoverageMetadataObservation { /** * Earth observation phenomenon time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ phenomenonTime?: TemporalDomain; /** * Earth observation resultTime. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ resultTime?: TemporalDomain; /** * Earth observation footprint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ footprint?: Polygon; /** * Earth observation acquisition type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ acquisitionType?: string; /** * Earth observation status. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ status?: string; } export interface CoverageDescriptionV201RangeType { /** * Range type name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ name: string; /** * Range type description. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ description?: string; /** * Unit of measurement for the range type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ uom: string; /** * Number that represents null value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ nilValue?: number; /** * Allowed values for the range type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ allowedValues?: number[]; } export interface CoverageDescriptionV201Resolution { /** * Resolution x. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ x: number; /** * Resolution y. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#CoverageDescriptionV201) */ y: number; } export interface WebTileLayer extends Layer, ScaleRangeLayer, RefreshableLayer, PortalLayer, BlendLayer, OperationalLayer { } export class WebTileLayer { /** * The attribution information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#copyright) */ copyright: string; /** * The spatial reference of the layer. * * @default Web Mercator Auxiliary Sphere (wkid: 3857) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#spatialReference) */ readonly spatialReference: SpatialReference; /** * A string of subDomain names where tiles are served to speed up tile retrieval. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#subDomains) */ subDomains: string[]; /** * The tiling scheme information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#tileInfo) */ tileInfo: TileInfo; /** * The list of tile server urls for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#tileServers) */ readonly tileServers: string[]; /** * For [WebTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html) the type is `web-tile`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#type) */ readonly type: "web-tile" | "open-street-map"; /** * The url template is a string that specifies the URL of the hosted tile images to load. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#urlTemplate) */ urlTemplate: string; /** * WebTileLayer provides a simple way to add non-ArcGIS Server map tiles as a layer to a map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html) */ constructor(properties?: WebTileLayerProperties); /** * This method fetches a tile for the given level, row and column present in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#fetchTile) */ fetchTile(level: number, row: number, col: number, options?: WebTileLayerFetchTileOptions): Promise; /** * This method returns a URL to a tile for a given level, row and column. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#getTileUrl) */ getTileUrl(level: number, row: number, col: number): string; static fromJSON(json: any): WebTileLayer; } interface WebTileLayerProperties extends LayerProperties, ScaleRangeLayerProperties, RefreshableLayerProperties, PortalLayerProperties, BlendLayerProperties, OperationalLayerProperties { /** * The attribution information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#copyright) */ copyright?: string; /** * A string of subDomain names where tiles are served to speed up tile retrieval. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#subDomains) */ subDomains?: string[]; /** * The tiling scheme information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#tileInfo) */ tileInfo?: TileInfoProperties; /** * The url template is a string that specifies the URL of the hosted tile images to load. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#urlTemplate) */ urlTemplate?: string; } export interface WebTileLayerFetchTileOptions { /** * [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#fetchTile) */ signal?: AbortSignal; } export interface WFSLayer extends Layer, OrderedLayer, ScaleRangeLayer, RefreshableLayer, BlendLayer, OperationalLayer, PortalLayer, FeatureEffectLayer, FeatureReductionLayer { } export class WFSLayer { /** * Describes the layer's supported capabilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ readonly capabilities: WFSLayerCapabilities; /** * Copyright information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#copyright) */ copyright: string; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#customParameters) */ customParameters: any; /** * The time zone that dates are stored in. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#dateFieldsTimeZone) */ readonly dateFieldsTimeZone: string; /** * The SQL where clause used to filter features on the client. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#definitionExpression) */ definitionExpression: string; /** * The name of the layer's primary display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#displayField) */ displayField: string; /** * Specifies how features are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#elevationInfo) */ elevationInfo: WFSLayerElevationInfo; /** * An array of fields in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#fields) */ fields: Field[]; /** * A convenient property that can be used to make case-insensitive lookups for a field by name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#fieldsIndex) */ readonly fieldsIndex: FieldsIndex; /** * The geometry type of features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#geometryType) */ geometryType: "point" | "polygon" | "polyline" | "multipoint"; /** * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#labelingInfo) */ labelingInfo: LabelClass[]; /** * Indicates whether to display labels for this layer. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#labelsVisible) */ labelsVisible: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#legendEnabled) */ legendEnabled: boolean; /** * The maximum number of queries allowed to fetch the whole dataset from the service. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#maxPageCount) */ maxPageCount: number; /** * The maximum number of features that can be returned in a single request. * * @default 3000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#maxRecordCount) */ maxRecordCount: number; /** * The name of the layer in the WFS service to display, excluding the namespace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#name) */ name: string; /** * The namespace URI for the layer name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#namespaceUri) */ namespaceUri: string; /** * The name of an `oid` [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#fields) containing a unique value or identifier for each feature in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#objectIdField) */ objectIdField: string; /** * An array of field names from the WFS layer to include with each feature. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#outFields) */ outFields: string[]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#popupEnabled) */ popupEnabled: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#renderer) */ renderer: Renderer; /** * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#screenSizePerspectiveEnabled) */ screenSizePerspectiveEnabled: boolean; /** * The spatial reference of the layer. * * @default SpatialReference.WGS84 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#spatialReference) */ spatialReference: SpatialReference; readonly type: "wfs"; /** * The url to the WFS service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#url) */ url: string; /** * WFS service information about the available layers and operations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#wfsCapabilities) */ wfsCapabilities: WFSCapabilities; /** * The WFSLayer is used to create a layer based on an [OGC Web Feature Service](https://www.ogc.org/standards/wfs) (WFS). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html) */ constructor(properties?: WFSLayerProperties); /** * Creates a popup template for the layer, populated with all the fields of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#createPopupTemplate) */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate; /** * Creates query parameter object that can be used to fetch features that satisfy the layer's configurations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#createQuery) */ createQuery(): Query; /** * Returns the [Field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) instance for a field name (case-insensitive). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#getField) */ getField(fieldName: string): Field; /** * Returns the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) associated with the given field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#getFieldDomain) */ getFieldDomain(fieldName: string, options?: WFSLayerGetFieldDomainOptions): Domain; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the layer and returns the [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#queryExtent) */ queryExtent(query?: Query | QueryProperties, options?: WFSLayerQueryExtentOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the layer and returns the number of features that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#queryFeatureCount) */ queryFeatureCount(query?: Query | QueryProperties, options?: WFSLayerQueryFeatureCountOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the layer and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html), which can be accessed using the `.then()` method once the promise resolves. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#queryFeatures) */ queryFeatures(query?: Query | QueryProperties, options?: WFSLayerQueryFeaturesOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the layer and returns an array of Object IDs for features that satisfy the input query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#queryObjectIds) */ queryObjectIds(query?: Query | QueryProperties, options?: WFSLayerQueryObjectIdsOptions): Promise; on(name: "refresh", eventHandler: WFSLayerRefreshEventHandler): IHandle; on(name: "layerview-create", eventHandler: WFSLayerLayerviewCreateEventHandler): IHandle; on(name: "layerview-create-error", eventHandler: WFSLayerLayerviewCreateErrorEventHandler): IHandle; on(name: "layerview-destroy", eventHandler: WFSLayerLayerviewDestroyEventHandler): IHandle; /** * Creates a WFSLayer from an object created by [wfsUtils.getWFSLayerInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#getWFSLayerInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#fromWFSLayerInfo) */ static fromWFSLayerInfo(layerInfo: WFSLayerInfo): WFSLayer; static fromJSON(json: any): WFSLayer; } interface WFSLayerProperties extends LayerProperties, OrderedLayerProperties, ScaleRangeLayerProperties, RefreshableLayerProperties, BlendLayerProperties, OperationalLayerProperties, PortalLayerProperties, FeatureEffectLayerProperties, FeatureReductionLayerProperties { /** * Copyright information for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#copyright) */ copyright?: string; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#customParameters) */ customParameters?: any; /** * The SQL where clause used to filter features on the client. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#definitionExpression) */ definitionExpression?: string; /** * The name of the layer's primary display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#displayField) */ displayField?: string; /** * Specifies how features are placed on the vertical axis (z). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#elevationInfo) */ elevationInfo?: WFSLayerElevationInfo; /** * An array of fields in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#fields) */ fields?: FieldProperties[]; /** * The geometry type of features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#geometryType) */ geometryType?: "point" | "polygon" | "polyline" | "multipoint"; /** * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#labelingInfo) */ labelingInfo?: LabelClassProperties[]; /** * Indicates whether to display labels for this layer. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#labelsVisible) */ labelsVisible?: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#legendEnabled) */ legendEnabled?: boolean; /** * The maximum number of queries allowed to fetch the whole dataset from the service. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#maxPageCount) */ maxPageCount?: number; /** * The maximum number of features that can be returned in a single request. * * @default 3000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#maxRecordCount) */ maxRecordCount?: number; /** * The name of the layer in the WFS service to display, excluding the namespace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#name) */ name?: string; /** * The namespace URI for the layer name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#namespaceUri) */ namespaceUri?: string; /** * The name of an `oid` [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#fields) containing a unique value or identifier for each feature in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#objectIdField) */ objectIdField?: string; /** * An array of field names from the WFS layer to include with each feature. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#outFields) */ outFields?: string[]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#popupEnabled) */ popupEnabled?: boolean; /** * The popup template for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * The renderer assigned to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#renderer) */ renderer?: RendererProperties; /** * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#screenSizePerspectiveEnabled) */ screenSizePerspectiveEnabled?: boolean; /** * The spatial reference of the layer. * * @default SpatialReference.WGS84 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * The url to the WFS service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#url) */ url?: string; /** * WFS service information about the available layers and operations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#wfsCapabilities) */ wfsCapabilities?: WFSCapabilities; } export interface WFSLayerLayerviewCreateErrorEvent { error: Error; view: View; } export interface WFSLayerLayerviewCreateEvent { layerView: LayerView; view: View; } export interface WFSLayerLayerviewDestroyEvent { layerView: LayerView; view: View; } export interface WFSLayerRefreshEvent { dataChanged: boolean; } export interface WFSLayerCapabilities { /** * Describes characteristics of the data in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ data: WFSLayerCapabilitiesData; /** * Describes editing capabilities that can be performed on the features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ editing: WFSLayerCapabilitiesEditing; /** * Describes operations that can be performed on features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ operations: WFSLayerCapabilitiesOperations; /** * Describes [query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) operations that can be performed on features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ query: WFSLayerCapabilitiesQuery; /** * Indicates if the layer's query operation supports querying features or records related to features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ queryRelated: WFSLayerCapabilitiesQueryRelated; } export interface WFSLayerCapabilitiesData { /** * Indicates if the attachment is enabled on the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsAttachment: boolean; /** * Indicates if the features in the layer support m-values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsM: boolean; /** * Indicates if the features in the layer support z-values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsZ: boolean; } export interface WFSLayerCapabilitiesEditing { /** * Indicates if anonymous users can delete features created by others. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsDeleteByAnonymous: boolean; /** * Indicates if logged in users can delete features created by others. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsDeleteByOthers: boolean; /** * Indicates if the geometry of the features in the layer can be edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsGeometryUpdate: boolean; /** * Indicates if the `globalid` values provided by the client are used in [applyEdits](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#applyEdits). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsGlobalId: boolean; /** * Indicates if the `rollbackOnFailure` parameter can be set to `true` or `false` when running the synchronizeReplica operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsRollbackOnFailure: boolean; /** * Indicates if anonymous users can update features created by others. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsUpdateByAnonymous: boolean; /** * Indicates if logged in users can update features created by others. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsUpdateByOthers: boolean; /** * Indicates if `m-values` must be provided when updating features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsUpdateWithoutM: boolean; /** * Indicates if the layer supports uploading attachments by [UploadId](https://developers.arcgis.com/rest/services-reference/item.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsUploadWithItemId: boolean; } export interface WFSLayerCapabilitiesOperations { /** * Indicates if new features can be [added](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#applyEdits) to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsAdd: boolean; /** * Indicates if features can be [deleted](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#applyEdits) from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsDelete: boolean; /** * Indicates if features in the layer can be [updated](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#applyEdits). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsUpdate: boolean; /** * Indicates if features in the layer can be [edited](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#applyEdits). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsEditing: boolean; /** * Indicates if values of one or more field values in the layer can be updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsCalculate: boolean; /** * Indicates if features in the layer can be [queried](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#queryFeatures). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsQuery: boolean; /** * Indicates if the layer supports [REST API queryAttachments](https://developers.arcgis.com/rest/services-reference/query-attachments-feature-service-layer-.htm) operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsQueryAttachments: boolean; /** * Indicates if the layer supports a SQL-92 expression or where clause. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsValidateSql: boolean; /** * Indicates if resized attachments are supported in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsResizeAttachments: boolean; } export interface WFSLayerCapabilitiesQuery { /** * Indicates if the geometry centroid associated with each polygon feature can be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsCentroid: boolean; /** * Indicates if the layer's query operation supports a buffer distance for input geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsDistance: boolean; /** * Indicates if the layer supports queries for distinct values based on fields specified in the [outFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#outFields). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsDistinct: boolean; /** * Indicates if the query operation supports `disjoint` [spatial relationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#spatialRelationship). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsDisjointSpatialRelationship: boolean; /** * Indicates if the layer's query response includes the extent of features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsExtent: boolean; /** * Indicates if the layer's query response contains geometry attributes, including shape area and length attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsGeometryProperties: boolean; /** * Indicates if the layer supports the [having](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#having) clause on the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsHavingClause: boolean; /** * Indicates if features returned in the query response can be ordered by one or more fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsOrderBy: boolean; /** * Indicates if the query response supports pagination. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsPagination: boolean; /** * Indicates if the layer supports [percentile statisticType](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-StatisticDefinition.html#statisticType). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsPercentileStatistics: boolean; /** * Indicates if the query response includes the [query geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html#queryGeometry). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsQueryGeometry: boolean; /** * Indicates if the query operation supports the projection of geometries onto a virtual grid. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsQuantization: boolean; /** * Indicates if the query operation supports quantization designed to be used in edit mode (highest resolution at the given spatial reference). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsQuantizationEditMode: boolean; /** * Indicates if the number of features returned by the query operation can be controlled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsResultType: boolean; /** * Indicates if the query operation supports SQL expressions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsSqlExpression: boolean; /** * Indicates if the query operation supports using standardized queries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsStandardizedQueriesOnly: boolean; /** * Indicates if the layer supports field-based statistical functions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsStatistics: boolean; /** * Indicates if the layer supports historic moment query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsHistoricMoment: boolean; } export interface WFSLayerCapabilitiesQueryRelated { /** * Indicates if the layer's query response includes the number of features or records related to features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsCount: boolean; /** * Indicates if the related features or records returned in the query response can be ordered by one or more fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsOrderBy: boolean; /** * Indicates if the query response supports pagination for related features or records. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#capabilities) */ supportsPagination: boolean; } export interface WFSLayerElevationInfo { /** * Defines how the feature is placed with respect to the terrain surface or 3D objects in the scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#elevationInfo) */ mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; /** * An elevation offset, which is added to the vertical position of the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#elevationInfo) */ offset?: number; /** * Defines how to override a feature's Z-value based on its attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#elevationInfo) */ featureExpressionInfo?: WFSLayerElevationInfoFeatureExpressionInfo; /** * The unit for `featureExpressionInfo` and `offset` values. * * [Read more...](global.html#unit) */ unit?: "feet" | "meters" | "kilometers" | "miles" | "us-feet" | "yards"; } export interface WFSLayerElevationInfoFeatureExpressionInfo { /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Feature Z Profile](https://developers.arcgis.com/javascript/latest/arcade/#z-values). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#elevationInfo) */ expression?: string; } export interface WFSLayerGetFieldDomainOptions { /** * The feature to which the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) is assigned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#getFieldDomain) */ feature: Graphic; } export interface WFSLayerQueryExtentOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#queryExtent) */ signal?: AbortSignal; } export interface WFSLayerQueryFeatureCountOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#queryFeatureCount) */ signal?: AbortSignal; } export interface WFSLayerQueryFeaturesOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#queryFeatures) */ signal?: AbortSignal; } export interface WFSLayerQueryObjectIdsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html#queryObjectIds) */ signal?: AbortSignal; } export interface WMSLayer extends Layer, BlendLayer, OperationalLayer, PortalLayer, ScaleRangeLayer, RefreshableLayer { } export class WMSLayer { /** * A flattened collection of all [WMSSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html)s based on the [`sublayers`](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#sublayers) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#allSublayers) */ allSublayers: Collection; /** * Copyright information for the WMS service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#copyright) */ copyright: string; /** * Use this to append different custom parameters to the WMS map requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#customLayerParameters) */ customLayerParameters: any; /** * Use this to append custom parameters to all WMS requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#customParameters) */ customParameters: any; /** * Description for the WMS layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#description) */ description: string; /** * An array of time, elevation and other dimensions for the root layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#dimensions) */ readonly dimensions: (TimeDimension | ElevationDimension | GenericDimension)[]; /** * The MIME type that will be requested by popups. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#featureInfoFormat) */ featureInfoFormat: "text/html" | "text/plain" | null; /** * This property lists all available MIME-types that can be used with the WMS service's _GetFeatureInfo_ request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#featureInfoFormats) */ readonly featureInfoFormats: string[]; /** * The URL for the WMS GetFeatureInfo call. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#featureInfoUrl) */ featureInfoUrl: string; /** * Function to override the default popup behavior of `WMSLayer`. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#fetchFeatureInfoFunction) */ fetchFeatureInfoFunction: FetchFeatureInfoFunction; /** * All bounding boxes defined for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#fullExtents) */ fullExtents: Extent[]; /** * The map image format (MIME type) to request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#imageFormat) */ imageFormat: string; /** * Indicates the maximum height of the image exported by the service. * * @default 2048 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#imageMaxHeight) */ imageMaxHeight: number; /** * Indicates the maximum width of the image exported by the service. * * @default 2048 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#imageMaxWidth) */ imageMaxWidth: number; /** * Indicates whether the background of the image exported by the service is transparent. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#imageTransparency) */ imageTransparency: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#legendEnabled) */ legendEnabled: boolean; /** * The spatial reference of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#spatialReference) */ spatialReference: SpatialReference; /** * List of spatialReference well known ids derived from the CRS elements of the first layer in the GetCapabilities request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#spatialReferences) */ spatialReferences: number[]; /** * A subset of the layer's [WMSSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html)s that will be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#sublayers) */ sublayers: Collection; /** * The layer's time extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#timeExtent) */ timeExtent: TimeExtent; /** * TimeInfo provides information such as date fields that store [start](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#startField) and [end](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#endField) time for each feature and the [fullTimeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#fullTimeExtent) for the layer. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#timeInfo) */ timeInfo: TimeInfo; /** * A temporary offset of the time data based on a certain [TimeInterval](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeInterval.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#timeOffset) */ timeOffset: TimeInterval; readonly type: "wms"; /** * The URL of the WMS service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#url) */ url: string; /** * Determines if the layer will update its temporal data based on the view's [timeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#timeExtent). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#useViewTime) */ useViewTime: boolean; /** * Version of the [WMS specification](http://www.opengeospatial.org/standards/wms) to use. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#version) */ version: string; /** * The WMSLayer is used to create layers based on OGC Web Map Services (WMS). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html) */ constructor(properties?: WMSLayerProperties); /** * Fetching the WMS image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#fetchImage) */ fetchImage(extent: Extent, width: number, height: number, options?: WMSLayerFetchImageOptions): Promise; /** * Returns a [WMSSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html) based on the given sublayer id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#findSublayerById) */ findSublayerById(id: number): WMSSublayer; /** * Returns a [WMSSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html) based on the given sublayer name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#findSublayerByName) */ findSublayerByName(name: string): WMSSublayer; on(name: "refresh", eventHandler: WMSLayerRefreshEventHandler): IHandle; on(name: "layerview-create", eventHandler: WMSLayerLayerviewCreateEventHandler): IHandle; on(name: "layerview-create-error", eventHandler: WMSLayerLayerviewCreateErrorEventHandler): IHandle; on(name: "layerview-destroy", eventHandler: WMSLayerLayerviewDestroyEventHandler): IHandle; static fromJSON(json: any): WMSLayer; } interface WMSLayerProperties extends LayerProperties, BlendLayerProperties, OperationalLayerProperties, PortalLayerProperties, ScaleRangeLayerProperties, RefreshableLayerProperties { /** * A flattened collection of all [WMSSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html)s based on the [`sublayers`](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#sublayers) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#allSublayers) */ allSublayers?: CollectionProperties; /** * Copyright information for the WMS service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#copyright) */ copyright?: string; /** * Use this to append different custom parameters to the WMS map requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#customLayerParameters) */ customLayerParameters?: any; /** * Use this to append custom parameters to all WMS requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#customParameters) */ customParameters?: any; /** * Description for the WMS layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#description) */ description?: string; /** * The MIME type that will be requested by popups. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#featureInfoFormat) */ featureInfoFormat?: "text/html" | "text/plain" | null; /** * The URL for the WMS GetFeatureInfo call. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#featureInfoUrl) */ featureInfoUrl?: string; /** * Function to override the default popup behavior of `WMSLayer`. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#fetchFeatureInfoFunction) */ fetchFeatureInfoFunction?: FetchFeatureInfoFunction; /** * All bounding boxes defined for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#fullExtents) */ fullExtents?: ExtentProperties[]; /** * The map image format (MIME type) to request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#imageFormat) */ imageFormat?: string; /** * Indicates the maximum height of the image exported by the service. * * @default 2048 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#imageMaxHeight) */ imageMaxHeight?: number; /** * Indicates the maximum width of the image exported by the service. * * @default 2048 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#imageMaxWidth) */ imageMaxWidth?: number; /** * Indicates whether the background of the image exported by the service is transparent. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#imageTransparency) */ imageTransparency?: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#legendEnabled) */ legendEnabled?: boolean; /** * The spatial reference of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * List of spatialReference well known ids derived from the CRS elements of the first layer in the GetCapabilities request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#spatialReferences) */ spatialReferences?: number[]; /** * A subset of the layer's [WMSSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html)s that will be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#sublayers) */ sublayers?: CollectionProperties; /** * The layer's time extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#timeExtent) */ timeExtent?: TimeExtentProperties; /** * TimeInfo provides information such as date fields that store [start](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#startField) and [end](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#endField) time for each feature and the [fullTimeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#fullTimeExtent) for the layer. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#timeInfo) */ timeInfo?: TimeInfoProperties; /** * A temporary offset of the time data based on a certain [TimeInterval](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeInterval.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#timeOffset) */ timeOffset?: TimeIntervalProperties; /** * The URL of the WMS service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#url) */ url?: string; /** * Determines if the layer will update its temporal data based on the view's [timeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#timeExtent). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#useViewTime) */ useViewTime?: boolean; /** * Version of the [WMS specification](http://www.opengeospatial.org/standards/wms) to use. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#version) */ version?: string; } export type FetchFeatureInfoFunction = (query: any) => Promise; export interface WMSLayerLayerviewCreateErrorEvent { error: Error; view: View; } export interface WMSLayerLayerviewCreateEvent { layerView: LayerView; view: View; } export interface WMSLayerLayerviewDestroyEvent { layerView: LayerView; view: View; } export interface WMSLayerRefreshEvent { dataChanged: boolean; } export interface WMSLayerFetchImageOptions { /** * The ratio of the resolution in physical pixels of the image to the resolution it will be displayed at. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#fetchImage) */ pixelRatio?: number; /** * The rotation in degrees of the exported image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#fetchImage) */ rotation?: number; /** * The [TimeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeExtent.html) of the exported image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#fetchImage) */ timeExent?: any; /** * An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to abort the request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#fetchImage) */ signal?: AbortSignal; } export interface WMTSLayer extends Layer, OperationalLayer, PortalLayer, ScaleRangeLayer, RefreshableLayer, BlendLayer { } export class WMTSLayer { /** * Currently active sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#activeLayer) */ activeLayer: WMTSSublayer; /** * Copyright information for the WMTS service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#copyright) */ copyright: string; /** * Use this to append different custom parameters to the WMTS tile requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#customLayerParameters) */ customLayerParameters: any; /** * Use this to append custom parameters to all WMTS requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#customParameters) */ customParameters: any; /** * The service mode for the WMTS layer. * * @default RESTful * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#serviceMode) */ serviceMode: "RESTful" | "KVP"; /** * A collection of [WMTSSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html) objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#sublayers) */ sublayers: Collection; readonly type: "wmts"; /** * The URL of the WMTS service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#url) */ url: string; /** * Version of the [WMTS specification](http://www.opengeospatial.org/standards/wmts) to use. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#version) */ version: string; /** * The WMTSLayer is used to create layers based on OGC Web Map Tile Services (WMTS). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html) */ constructor(properties?: WMTSLayerProperties); /** * Requests a tile from the WMTS service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#fetchTile) */ fetchTile(level: number, row: number, col: number, options?: WMTSLayerFetchTileOptions): Promise; /** * Returns a [WMTSSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html) based on the given sublayer id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#findSublayerById) */ findSublayerById(id: string): WMTSSublayer; static fromJSON(json: any): WMTSLayer; } interface WMTSLayerProperties extends LayerProperties, OperationalLayerProperties, PortalLayerProperties, ScaleRangeLayerProperties, RefreshableLayerProperties, BlendLayerProperties { /** * Currently active sublayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#activeLayer) */ activeLayer?: WMTSSublayerProperties; /** * Copyright information for the WMTS service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#copyright) */ copyright?: string; /** * Use this to append different custom parameters to the WMTS tile requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#customLayerParameters) */ customLayerParameters?: any; /** * Use this to append custom parameters to all WMTS requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#customParameters) */ customParameters?: any; /** * The service mode for the WMTS layer. * * @default RESTful * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#serviceMode) */ serviceMode?: "RESTful" | "KVP"; /** * A collection of [WMTSSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html) objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#sublayers) */ sublayers?: CollectionProperties; /** * The URL of the WMTS service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#url) */ url?: string; /** * Version of the [WMTS specification](http://www.opengeospatial.org/standards/wmts) to use. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#version) */ version?: string; } export interface WMTSLayerFetchTileOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#fetchTile) */ signal?: AbortSignal; } export interface Map extends Accessor, LayersMixin, TablesMixin { } export class Map { /** * A flattened collection of all [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) in the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#allLayers) */ readonly allLayers: Collection; /** * A flattened collection of tables anywhere in the map's hierarchy. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#allTables) */ readonly allTables: Collection; /** * Specifies a basemap for the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) */ basemap: Basemap; /** * A collection of editable layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#editableLayers) */ readonly editableLayers: Collection; /** * Specifies the surface properties for the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground) */ ground: Ground; /** * The Map class contains properties and methods for storing, managing, and overlaying [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) common to both 2D and 3D viewing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) */ constructor(properties?: MapProperties); /** * Destroys the map, and any associated resources, including its [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers), [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap), [tables](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#tables), and [ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#destroy) */ destroy(): void; } interface MapProperties extends LayersMixinProperties, TablesMixinProperties { /** * Specifies a basemap for the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) */ basemap?: BasemapProperties | string; /** * Specifies the surface properties for the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground) */ ground?: GroundProperties | string; } export interface Network extends Accessor, JSONSupport, Loadable { } export class Network { /** * The full network definition, accessible only when the network is loaded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#dataElement) */ dataElement: any; /** * The physical dataset name of the network as defined in the backend database. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#datasetName) */ readonly datasetName: string; /** * Returns the root feature service url which this network is part of. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#featureServiceUrl) */ readonly featureServiceUrl: string; /** * The full extent of the network, defined from the service territory used to create the network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#fullExtent) */ fullExtent: Extent; /** * The version of the geodatabase of the feature service data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#gdbVersion) */ gdbVersion: string; /** * The historic moment to query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#historicMoment) */ historicMoment: Date; /** * Random unique id (UUID) to identify a network as defined in the webmap spec. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#id) */ id: string; /** * The layer id of the network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#layerId) */ readonly layerId: number; /** * The full url to the network layer id as defined in the webmap spec. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#layerUrl) */ layerUrl: string; /** * Indicates whether the network instance has loaded. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#loaded) */ readonly loaded: boolean; /** * Returns the url of network server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#networkServiceUrl) */ readonly networkServiceUrl: string; /** * Contains the url and IDs of the utility network rules, subnetworks, and dirty areas tables or layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#networkSystemLayers) */ readonly networkSystemLayers: NetworkSystemLayers; /** * The portal user owner of the network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#owner) */ readonly owner: string; /** * Converts url to a url object * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#parsedUrl) */ readonly parsedUrl: string; /** * The schema version of the network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#schemaGeneration) */ readonly schemaGeneration: number; sourceJSON: any; /** * The spatial reference of the network, defined at the creation of the network, usually from the service territory class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#spatialReference) */ spatialReference: SpatialReference; /** * The name of the network as defined in the webmap spec. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#title) */ title: string; /** * The type of the dataset. * * @default utility * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#type) */ readonly type: "utility" | "trace"; /** * Class defining high level properties that describes utility networks and trace networks. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html) */ constructor(properties?: NetworkProperties); /** * The network consists of sources (classes) and each source has a unique Id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#getLayerIdBySourceId) */ getLayerIdBySourceId(id: number): number; /** * Triggers the loading of the network instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#load) */ load(): Promise; /** * Named trace configurations allow you to add and store complex traces in a network that can be shared across an organization through web maps and consumed by web and field applications. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#queryNamedTraceConfigurations) */ queryNamedTraceConfigurations(query?: NetworkQueryNamedTraceConfigurationsQuery, options?: RequestOptions): Promise; /** * Whenever the network is edited or modified, the network and its features become out of date in the [network topology](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/about-network-topology.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#submitTopologyValidationJob) */ submitTopologyValidationJob(parameters: ValidateTopologyProps, options?: RequestOptions): Promise; /** * Whenever the network is edited or modified, the network and its features become out of date in the [network topology]( https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/about-network-topology.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#validateTopology) */ validateTopology(parameters: ValidateTopologyProps, options?: RequestOptions): Promise; /** * Creates a new network instance from an ArcGIS Online or ArcGIS Enterprise [portal item](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#fromPortalItem) */ static fromPortalItem(params: NetworkFromPortalItemParams): Promise; static fromJSON(json: any): Network; } interface NetworkProperties extends LoadableProperties { /** * The full network definition, accessible only when the network is loaded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#dataElement) */ dataElement?: any; /** * The full extent of the network, defined from the service territory used to create the network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#fullExtent) */ fullExtent?: ExtentProperties; /** * The version of the geodatabase of the feature service data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#gdbVersion) */ gdbVersion?: string; /** * The historic moment to query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#historicMoment) */ historicMoment?: DateProperties; /** * Random unique id (UUID) to identify a network as defined in the webmap spec. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#id) */ id?: string; /** * The full url to the network layer id as defined in the webmap spec. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#layerUrl) */ layerUrl?: string; sourceJSON?: any; /** * The spatial reference of the network, defined at the creation of the network, usually from the service territory class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * The name of the network as defined in the webmap spec. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#title) */ title?: string; } export interface NetworkFromPortalItemParams { /** * The object representing an ArcGIS Online or ArcGIS Enterprise portal item from which to load the network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#fromPortalItem) */ portalItem: PortalItem; } export interface NetworkQueryNamedTraceConfigurationsQuery { /** * An array of the named trace configuration creators to be queried. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#queryNamedTraceConfigurations) */ creators?: string[]; /** * An array of named trace configuration globalIds (UUID) to be queried. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#queryNamedTraceConfigurations) */ globalIds?: string[]; /** * An array of named trace configuration names to be queried. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#queryNamedTraceConfigurations) */ names?: string[]; /** * An array of named trace configuration user tags to be queried. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#queryNamedTraceConfigurations) */ tags?: string[]; } /** * ValidateTopologyProps represents the parameters for validating a network topology. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#ValidateTopologyProps) */ export interface ValidateTopologyProps { /** * Specifies the geodatabase version name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#ValidateTopologyProps) */ gdbVersion?: string; /** * Specifies the GUID used to lock the version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#ValidateTopologyProps) */ sessionID?: string; /** * Specifies the envelope of the area to validate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#ValidateTopologyProps) */ validateArea: Extent; /** * Specifies the set of features and objects to validate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#ValidateTopologyProps) */ validationSet?: ValidationSetItemJSON[]; /** * Specifies the validation to perform. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#ValidateTopologyProps) */ validationType?: "normal" | "rebuild" | "force-rebuild"; } export class NamedTraceConfiguration { /** * The date/time when the trace configuration has been added to the utility network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-NamedTraceConfiguration.html#creationDate) */ creationDate: Date; /** * The portal user who created the trace configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-NamedTraceConfiguration.html#creator) */ creator: string; /** * Short description of what kind of trace this trace configuration performs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-NamedTraceConfiguration.html#description) */ description: string; /** * The `globalId` (UUID) uniquely identifies a trace configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-NamedTraceConfiguration.html#globalId) */ globalId: string; /** * The minimum number of starting points required to perform a trace with this particular trace configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-NamedTraceConfiguration.html#minStartingPoints) */ minStartingPoints: "none" | "one" | "many"; /** * The result types of the trace configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-NamedTraceConfiguration.html#resultTypes) */ resultTypes: any[]; /** * Labels that help identify and search for a particular trace configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-NamedTraceConfiguration.html#tags) */ tags: string[]; /** * The title or the name of the trace configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-NamedTraceConfiguration.html#title) */ title: string; /** * The full definition of the trace configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-NamedTraceConfiguration.html#traceConfiguration) */ traceConfiguration: TraceConfiguration | UNTraceConfiguration; /** * The trace type defined in this trace configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-NamedTraceConfiguration.html#traceType) */ traceType: | "connected" | "upstream" | "downstream" | "shortest-path" | "subnetwork" | "subnetwork-controllers" | "loops" | "isolation"; constructor(properties?: any); } export class NetworkSystemLayers extends Accessor { readonly associationsTableId: number; readonly associationsTableUrl: string; /** * The layer ID of the service containing the utility network's [dirty areas](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/dirty-areas-in-a-utility-network.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-NetworkSystemLayers.html#dirtyAreasLayerId) */ readonly dirtyAreasLayerId: number; /** * The service url containing the utility network's [dirty areas](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/dirty-areas-in-a-utility-network.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-NetworkSystemLayers.html#dirtyAreasLayerUrl) */ readonly dirtyAreasLayerUrl: string; /** * The layer ID of the service containing the network rules table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-NetworkSystemLayers.html#rulesTableId) */ readonly rulesTableId: number; /** * The service url containing the network rules table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-NetworkSystemLayers.html#rulesTableUrl) */ readonly rulesTableUrl: string; /** * The layer ID of the service containing the utility network's [Subnetworks table](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/subnetworks-table.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-NetworkSystemLayers.html#subnetworksTableId) */ readonly subnetworksTableId: number; /** * The service url containing the utility network's [Subnetworks table](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/subnetworks-table.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-NetworkSystemLayers.html#subnetworksTableUrl) */ readonly subnetworksTableUrl: string; /** * The NetworkSystemLayers contains the url and IDs of the utility network rules, subnetworks, and dirty areas tables or layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-NetworkSystemLayers.html) */ constructor(properties?: NetworkSystemLayersProperties); } interface NetworkSystemLayersProperties { } export interface Terminal extends Accessor, JSONSupport { } export class Terminal { /** * A unique numeric identifer for the terminal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-Terminal.html#id) */ id: number; /** * The name of the terminal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-Terminal.html#name) */ name: string; /** * A device feature can be assigned a terminal configuration, which could have one or more terminals. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-Terminal.html) */ constructor(properties?: TerminalProperties); static fromJSON(json: any): Terminal; } interface TerminalProperties { /** * A unique numeric identifer for the terminal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-Terminal.html#id) */ id?: number; /** * The name of the terminal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-Terminal.html#name) */ name?: string; } export interface TerminalConfiguration extends Accessor, JSONSupport { } export class TerminalConfiguration { /** * The default terminal configuration path defined. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TerminalConfiguration.html#defaultConfiguration) */ defaultConfiguration: string; /** * A unique numeric identifer of the terminal configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TerminalConfiguration.html#id) */ id: number; /** * The name of the terminal configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TerminalConfiguration.html#name) */ name: string; /** * An array of [terminals](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-Terminal.html) defined in this configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TerminalConfiguration.html#terminals) */ terminals: Terminal[]; /** * Terminal configurations can be defined as directional or bidirectional. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TerminalConfiguration.html#traversabilityModel) */ traversabilityModel: "directional" | "bidirectional"; /** * A device feature can be assigned a terminal configuration which could have one or more terminals. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TerminalConfiguration.html) */ constructor(properties?: TerminalConfigurationProperties); static fromJSON(json: any): TerminalConfiguration; } interface TerminalConfigurationProperties { /** * The default terminal configuration path defined. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TerminalConfiguration.html#defaultConfiguration) */ defaultConfiguration?: string; /** * A unique numeric identifer of the terminal configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TerminalConfiguration.html#id) */ id?: number; /** * The name of the terminal configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TerminalConfiguration.html#name) */ name?: string; /** * An array of [terminals](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-Terminal.html) defined in this configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TerminalConfiguration.html#terminals) */ terminals?: TerminalProperties[]; /** * Terminal configurations can be defined as directional or bidirectional. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TerminalConfiguration.html#traversabilityModel) */ traversabilityModel?: "directional" | "bidirectional"; } export interface TopologyValidationJobInfo extends Accessor, JSONSupport { } export class TopologyValidationJobInfo { /** * The last date and time the service was updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TopologyValidationJobInfo.html#lastUpdatedTime) */ lastUpdatedTime: Date; /** * The job status. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TopologyValidationJobInfo.html#status) */ status: "pending" | "in-progress" | "completed"; /** * ArcGIS Server Rest API endpoint to the resource that receives the validate network topology request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TopologyValidationJobInfo.html#statusUrl) */ statusUrl: string; /** * The date and time in which [submitTopologyValidationJob()](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#submitTopologyValidationJob) is first called. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TopologyValidationJobInfo.html#submissionTime) */ submissionTime: Date; /** * Represents information pertaining to the execution of an asynchronous [submitTopologyValidationJob()](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#submitTopologyValidationJob) request on the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TopologyValidationJobInfo.html) */ constructor(properties?: TopologyValidationJobInfoProperties); /** * Sends a request for the current state of this job. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TopologyValidationJobInfo.html#checkJobStatus) */ checkJobStatus(requestOptions?: any): Promise; /** * Stop monitoring this job for status updates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TopologyValidationJobInfo.html#destroy) */ destroy(): void; /** * Resolves when an asynchronous job has completed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TopologyValidationJobInfo.html#waitForJobCompletion) */ waitForJobCompletion(options?: TopologyValidationJobInfoWaitForJobCompletionOptions): Promise; static fromJSON(json: any): TopologyValidationJobInfo; } interface TopologyValidationJobInfoProperties { /** * The last date and time the service was updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TopologyValidationJobInfo.html#lastUpdatedTime) */ lastUpdatedTime?: DateProperties; /** * The job status. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TopologyValidationJobInfo.html#status) */ status?: "pending" | "in-progress" | "completed"; /** * ArcGIS Server Rest API endpoint to the resource that receives the validate network topology request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TopologyValidationJobInfo.html#statusUrl) */ statusUrl?: string; /** * The date and time in which [submitTopologyValidationJob()](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#submitTopologyValidationJob) is first called. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TopologyValidationJobInfo.html#submissionTime) */ submissionTime?: DateProperties; } export interface TopologyValidationJobInfoWaitForJobCompletionOptions { /** * The time in millisecond between remote job status requests. * * @default 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TopologyValidationJobInfo.html#waitForJobCompletion) */ interval?: any; /** * [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) allows for cancelable asynchronous job. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TopologyValidationJobInfo.html#waitForJobCompletion) */ signal?: any; /** * Callback function that is called at the specified interval. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TopologyValidationJobInfo.html#waitForJobCompletion) */ statusCallback?: any; } export class TraceConfiguration { /** * An array of objects representing network attribute or category conditions that serve as barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceConfiguration.html#conditionBarriers) */ conditionBarriers: any[]; /** * An array of objects representing function barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceConfiguration.html#functionBarriers) */ functionBarriers: any[]; /** * An array of objects representing function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceConfiguration.html#functions) */ functions: any[]; /** * Do not stop the trace if the starting point is a barrier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceConfiguration.html#ignoreBarriersAtStartingPoints) */ ignoreBarriersAtStartingPoints: boolean; /** * Specifies whether the traversability barrier features will be included in the trace results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceConfiguration.html#includeBarriers) */ includeBarriers: boolean; /** * Specifies the type of features returned based on a network attribute or check for a category string. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceConfiguration.html#outputConditions) */ outputConditions: any[]; /** * Specifies the network attribute name used for determining the shortest path. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceConfiguration.html#shortestPathNetworkAttributeName) */ shortestPathNetworkAttributeName: string; /** * Determines whether traversability is applied to both junctions and edges, junctions only, or edges only. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceConfiguration.html#traversabilityScope) */ traversabilityScope: "junctions" | "edges" | "junctionsAndEdges"; /** * Specifies whether an error will be returned if dirty areas are encountered in any of the traversed features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceConfiguration.html#validateConsistency) */ validateConsistency: boolean; constructor(properties?: any); } export interface TraceJobInfo extends Accessor, JSONSupport { } export class TraceJobInfo { /** * The last date and time the service was updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceJobInfo.html#lastUpdatedTime) */ lastUpdatedTime: Date; /** * The job status. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceJobInfo.html#status) */ status: "pending" | "in-progress" | "completed"; /** * ArcGIS Server Rest API endpoint to the resource that receives the validate network topology request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceJobInfo.html#statusUrl) */ statusUrl: string; /** * The date and time in which [submitTopologyValidationJob()](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#submitTopologyValidationJob) is first called. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceJobInfo.html#submissionTime) */ submissionTime: Date; /** * Represents information pertaining to the execution of an asynchronous request on the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceJobInfo.html) */ constructor(properties?: TraceJobInfoProperties); /** * Sends a request for the current state of this job. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceJobInfo.html#checkJobStatus) */ checkJobStatus(requestOptions?: any): Promise; /** * Stop monitoring this job for status updates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceJobInfo.html#destroy) */ destroy(): void; /** * Resolves when an asynchronous job has completed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceJobInfo.html#waitForJobCompletion) */ waitForJobCompletion(options?: TraceJobInfoWaitForJobCompletionOptions): Promise; static fromJSON(json: any): TraceJobInfo; } interface TraceJobInfoProperties { /** * The last date and time the service was updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceJobInfo.html#lastUpdatedTime) */ lastUpdatedTime?: DateProperties; /** * The job status. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceJobInfo.html#status) */ status?: "pending" | "in-progress" | "completed"; /** * ArcGIS Server Rest API endpoint to the resource that receives the validate network topology request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceJobInfo.html#statusUrl) */ statusUrl?: string; /** * The date and time in which [submitTopologyValidationJob()](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#submitTopologyValidationJob) is first called. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceJobInfo.html#submissionTime) */ submissionTime?: DateProperties; } export interface TraceJobInfoWaitForJobCompletionOptions { /** * The time in millisecond between remote job status requests. * * @default 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceJobInfo.html#waitForJobCompletion) */ interval?: any; /** * [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) allows for cancelable asynchronous job. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceJobInfo.html#waitForJobCompletion) */ signal?: any; /** * Callback function that is called at the specified interval. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-TraceJobInfo.html#waitForJobCompletion) */ statusCallback?: any; } export class UNTraceConfiguration { /** * Specifies whether to allow IndeterminateFlow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-UNTraceConfiguration.html#allowIndeterminateFlow) */ allowIndeterminateFlow: boolean; /** * Allows users to input arcade expressions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-UNTraceConfiguration.html#arcadeExpressionBarrier) */ arcadeExpressionBarrier: string; /** * Specifies the diagram Template Name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-UNTraceConfiguration.html#diagramTemplateName) */ diagramTemplateName: string; /** * Specifies the name of the domain network where the trace will be run. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-UNTraceConfiguration.html#domainNetworkName) */ domainNetworkName: string; /** * An array of objects representing specific categories or network attributes where the trace will stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-UNTraceConfiguration.html#filterBarriers) */ filterBarriers: any[]; /** * Ensures the trace results include any bit that is set in the starting points for the network attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-UNTraceConfiguration.html#filterBitsetNetworkAttributeName) */ filterBitsetNetworkAttributeName: string; /** * An array of objects representing filter function barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-UNTraceConfiguration.html#filterFunctionBarriers) */ filterFunctionBarriers: any[]; /** * Specifies where the filter will be applied. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-UNTraceConfiguration.html#filterScope) */ filterScope: "junctions" | "edges" | "junctionsAndEdges"; /** * Specifies if the container features will be included in the trace results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-UNTraceConfiguration.html#includeContainers) */ includeContainers: boolean; /** * Specifies if the content in containers will be included in the results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-UNTraceConfiguration.html#includeContent) */ includeContent: boolean; /** * Specifies whether to include isolated features for an isolation trace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-UNTraceConfiguration.html#includeIsolated) */ includeIsolated: boolean; /** * Specifies if structure features and objects will be included in the trace results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-UNTraceConfiguration.html#includeStructures) */ includeStructures: boolean; /** * Specifies whether to limit the containers returned to include only those encountered up to, and including, the first spatial container for each network element in the trace results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-UNTraceConfiguration.html#includeUpToFirstSpatialContainer) */ includeUpToFirstSpatialContainer: boolean; /** * Specifies the parameters needed for calculating nearest neighbors. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-UNTraceConfiguration.html#nearestNeighbor) */ nearestNeighbor: any; /** * An array of objects representing the output filter categories. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-UNTraceConfiguration.html#outputFilterCategories) */ outputFilterCategories: any[]; /** * An array of objects used to control what is returned in the results of a trace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-UNTraceConfiguration.html#outputFilters) */ outputFilters: any[]; /** * A propagator defines the propagation of a network attribute along a traversal and provides a filter to stop traversal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-UNTraceConfiguration.html#propagators) */ propagators: any[]; /** * Specifies the name of the [subnetwork](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/subnetworks.htm) where the trace will be run. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-UNTraceConfiguration.html#subnetworkName) */ subnetworkName: string; /** * Specifies the name of the tier where an upstream or downstream trace ends. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-UNTraceConfiguration.html#targetTierName) */ targetTierName: string; /** * Specifies the name of the tier where the trace will be run. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-UNTraceConfiguration.html#tierName) */ tierName: string; /** * Specifies if its necessary to validate whether traversed junction or edge objects have the necessary containment, attachment, or connectivity association in their association hierarchy. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-UNTraceConfiguration.html#validateLocatability) */ validateLocatability: boolean; constructor(properties?: any); } export class UtilityNetwork extends Network { /** * Returns all the [domain networks](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/domain-network.htm) in the utility network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#domainNetworkNames) */ readonly domainNetworkNames: string[]; /** * The layer id of the service territory class used to define the extent of the utility network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#serviceTerritoryFeatureLayerId) */ readonly serviceTerritoryFeatureLayerId: number; /** * This property returns the list of trace configurations shared on the webmap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#sharedNamedTraceConfigurations) */ sharedNamedTraceConfigurations: NamedTraceConfiguration[]; /** * Returns all the terminal configurations on the utility network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#terminalConfigurations) */ readonly terminalConfigurations: TerminalConfiguration[]; /** * The type of the dataset. * * @default "utility" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#type) */ readonly type: "utility"; /** * This class contains metadata about the utility network dataset retrieved from a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html) */ constructor(properties?: UtilityNetworkProperties); /** * Returns `true` if the given [Association](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html) is valid. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#canAddAssociation) */ canAddAssociation(association: Association): Promise; /** * Returns [ServiceEdits](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#ServiceEdits) which are used to add an [Association](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html) via the `applyEdits` method on the [FeatureService](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html) class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#generateAddAssociations) */ generateAddAssociations(association: Association[]): ServiceEdits; /** * Returns [ServiceEdits](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#ServiceEdits) which are used to delete an [Association](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html) via the `applyEdits` method on the [FeatureService](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html) class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#generateDeleteAssociations) */ generateDeleteAssociations(association: Association[]): ServiceEdits; /** * All devices features have terminal configurations (default single terminal). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#getTerminalConfiguration) */ getTerminalConfiguration(feature: Graphic): TerminalConfiguration; /** * Takes the name of a domain network and returns an array with the names of its tiers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#getTierNames) */ getTierNames(domainNetworkName: string): string[]; /** * Returns all associations filtered by the [QueryAssociationsParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsParameters.html) in a utility network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#queryAssociations) */ queryAssociations(props: QueryAssociationsParameters): Promise; /** * Takes the traceProps and preforms an async trace on a [UtilityNetwork](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#submitTraceJob) */ submitTraceJob(props?: UtilityNetworkSubmitTraceJobProps): Promise; /** * Given an extent, returns all associations within this extent and their synthesized geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#synthesizeAssociationGeometries) */ synthesizeAssociationGeometries(params: SynthesizeAssociationGeometriesParameters): Promise; /** * Takes the traceProps and preforms a trace on a [UtilityNetwork](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#trace) */ trace(props?: UtilityNetworkTraceProps): Promise; static fromJSON(json: any): UtilityNetwork; } interface UtilityNetworkProperties extends NetworkProperties { /** * This property returns the list of trace configurations shared on the webmap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#sharedNamedTraceConfigurations) */ sharedNamedTraceConfigurations?: NamedTraceConfiguration[]; } /** * Results returned from the [generateAddAssocations](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#generateAddAssociations) method and [generateDeleteAssocations](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#generateDeleteAssociations). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#ServiceEdits) */ export interface ServiceEdits { /** * The layerId of the feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#ServiceEdits) */ id: number; /** * Identifier for globalId and objectId. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#ServiceEdits) */ identifierFields: ServiceEditsIdentifierFields[]; /** * Object of generated add features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#ServiceEdits) */ addFeatures: any[]; /** * Object of generated delete features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#ServiceEdits) */ deleteFeatures: any[]; } export interface UtilityNetworkSubmitTraceJobProps { /** * The globalId (UUID) of the named trace configuration persisted in the network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#submitTraceJob) */ namedTraceConfigurationGlobalId?: string; /** * The geodatabase version to execute the function against. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#submitTraceJob) */ gdbVersion?: string; /** * The list of starting points and barriers that will define where the trace starts and stops. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#submitTraceJob) */ traceLocations?: TraceLocation[]; /** * The spatial reference that should be used to project the [aggregated geometries](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-AggregatedGeometry.html) returned by the trace (if applicable). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#submitTraceJob) */ outSpatialReference?: SpatialReference; /** * Defines the properties of a trace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#submitTraceJob) */ traceConfiguration?: UNTraceConfiguration; /** * Parameter specifying the types of results to return after running a trace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#submitTraceJob) */ resultTypes?: ResultTypeJSON[]; /** * The [traceType](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#traceType) defined in this trace configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#submitTraceJob) */ traceTypes?: string; } export interface UtilityNetworkTraceProps { /** * The globalId (UUID) of the named trace configuration persisted in the network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#trace) */ namedTraceConfigurationGlobalId?: string; /** * The geodatabase version to execute the function against. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#trace) */ gdbVersion?: string; /** * The list of starting points and barriers that will define where the trace starts and stops. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#trace) */ traceLocations?: TraceLocation[]; /** * The spatial reference that should be used to project the [aggregated geometries](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-AggregatedGeometry.html) returned by the trace (if applicable). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#trace) */ outSpatialReference?: SpatialReference; /** * Defines the properties of a trace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#trace) */ traceConfiguration?: UNTraceConfiguration; /** * Parameter specifying the types of results to return after running a trace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#trace) */ resultTypes?: ResultTypeJSON[]; /** * The [traceType](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#traceType) defined in this trace configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#trace) */ traceTypes?: string; } export interface ServiceEditsIdentifierFields { /** * The globalId identifier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#ServiceEdits) */ globalIdField: string; /** * The objectId identifier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#ServiceEdits) */ objectIdField: string; } /** * A convenience module for importing [PointCloudRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html) classes when developing with [TypeScript](https://developers.arcgis.com/javascript/latest/typescript-setup/). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-pointCloudRenderers.html) */ namespace pointCloudRenderers { /** * Renderer types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-pointCloudRenderers.html#PointCloudRenderer) */ export type PointCloudRenderer = | __esri.PointCloudClassBreaksRenderer | __esri.PointCloudRGBRenderer | __esri.PointCloudStretchRenderer | __esri.PointCloudUniqueValueRenderer; /** * PointCloudClassBreaksRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-pointCloudRenderers.html#PointCloudClassBreaksRenderer) */ export type PointCloudClassBreaksRenderer = __esri.PointCloudClassBreaksRenderer; export const PointCloudClassBreaksRenderer: typeof __esri.PointCloudClassBreaksRenderer; /** * PointCloudRGBRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-pointCloudRenderers.html#PointCloudRGBRenderer) */ export type PointCloudRGBRenderer = __esri.PointCloudRGBRenderer; export const PointCloudRGBRenderer: typeof __esri.PointCloudRGBRenderer; /** * PointCloudStretchRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-pointCloudRenderers.html#PointCloudStretchRenderer) */ export type PointCloudStretchRenderer = __esri.PointCloudStretchRenderer; export const PointCloudStretchRenderer: typeof __esri.PointCloudStretchRenderer; /** * PointCloudUniqueValueRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-pointCloudRenderers.html#PointCloudUniqueValueRenderer) */ export type PointCloudUniqueValueRenderer = __esri.PointCloudUniqueValueRenderer; export const PointCloudUniqueValueRenderer: typeof __esri.PointCloudUniqueValueRenderer; } /** * PointCloudClassBreaksRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-pointCloudRenderers.html#PointCloudClassBreaksRenderer) */ export type pointCloudRenderersPointCloudClassBreaksRenderer = PointCloudClassBreaksRenderer; /** * Renderer types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-pointCloudRenderers.html#PointCloudRenderer) */ export type pointCloudRenderersPointCloudRenderer = | PointCloudClassBreaksRenderer | PointCloudRGBRenderer | PointCloudStretchRenderer | PointCloudUniqueValueRenderer; /** * PointCloudRGBRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-pointCloudRenderers.html#PointCloudRGBRenderer) */ export type pointCloudRenderersPointCloudRGBRenderer = PointCloudRGBRenderer; /** * PointCloudStretchRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-pointCloudRenderers.html#PointCloudStretchRenderer) */ export type pointCloudRenderersPointCloudStretchRenderer = PointCloudStretchRenderer; /** * PointCloudUniqueValueRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-pointCloudRenderers.html#PointCloudUniqueValueRenderer) */ export type pointCloudRenderersPointCloudUniqueValueRenderer = PointCloudUniqueValueRenderer; /** * A convenience module for importing [Content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-Content.html) classes when developing with [TypeScript](https://developers.arcgis.com/javascript/latest/typescript-setup/). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content.html) */ namespace content { /** * Popup content element types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content.html#Content) */ export type Content = | __esri.TextContent | __esri.MediaContent | __esri.FieldsContent | __esri.AttachmentsContent | __esri.CustomContent | __esri.ExpressionContent | __esri.RelationshipContent; /** * TextContent defines descriptive text as an element within the [PopupTemplate's](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content.html#TextContent) */ export type TextContent = __esri.TextContent; export const TextContent: typeof __esri.TextContent; /** * MediaContent contains an individual or array of chart and/or image media elements to display within a popup's content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content.html#MediaContent) */ export type MediaContent = __esri.MediaContent; export const MediaContent: typeof __esri.MediaContent; /** * FieldsContent represents the [FieldInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html) associated with a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content.html#FieldsContent) */ export type FieldsContent = __esri.FieldsContent; export const FieldsContent: typeof __esri.FieldsContent; /** * AttachmentsContent represents an attachment element associated with a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content.html#AttachmentsContent) */ export type AttachmentsContent = __esri.AttachmentsContent; export const AttachmentsContent: typeof __esri.AttachmentsContent; /** * CustomContent represents a custom content element associated with a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content.html#CustomContent) */ export type CustomContent = __esri.CustomContent; export const CustomContent: typeof __esri.CustomContent; /** * ExpressionContent represents an expression element associated with a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content.html#ExpressionContent) */ export type ExpressionContent = __esri.ExpressionContent; export const ExpressionContent: typeof __esri.ExpressionContent; /** * RelationshipContent represents an relationship element associated with a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content.html#RelationshipContent) */ export type RelationshipContent = __esri.RelationshipContent; export const RelationshipContent: typeof __esri.RelationshipContent; } export interface AttachmentsContent extends Content, JSONSupport { } export class AttachmentsContent { /** * Describes the attachment's content in detail. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-AttachmentsContent.html#description) */ description: string; /** * A string value indicating how to display an attachment. * * @default "auto" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-AttachmentsContent.html#displayType) */ displayType: "auto" | "preview" | "list"; /** * A heading indicating what the attachment's content represents. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-AttachmentsContent.html#title) */ title: string; /** * The type of popup element displayed. * * @default attachments * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-AttachmentsContent.html#type) */ readonly type: "attachments"; /** * An `AttachmentsContent` popup element represents an attachment element associated with a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-AttachmentsContent.html) */ constructor(properties?: AttachmentsContentProperties); static fromJSON(json: any): AttachmentsContent; } interface AttachmentsContentProperties extends ContentProperties { /** * Describes the attachment's content in detail. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-AttachmentsContent.html#description) */ description?: string; /** * A string value indicating how to display an attachment. * * @default "auto" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-AttachmentsContent.html#displayType) */ displayType?: "auto" | "preview" | "list"; /** * A heading indicating what the attachment's content represents. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-AttachmentsContent.html#title) */ title?: string; } export interface BarChartMediaInfo extends Accessor, JSONSupport, MediaInfo, ChartMediaInfo { } export class BarChartMediaInfo { /** * Indicates the type of chart. * * @default bar-chart * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-BarChartMediaInfo.html#type) */ readonly type: string; /** * A `BarChartMediaInfo` is a type of chart media element that represents a bar chart displayed within a popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-BarChartMediaInfo.html) */ constructor(properties?: BarChartMediaInfoProperties); /** * Creates a deep clone of the BarChartMediaInfo class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-BarChartMediaInfo.html#clone) */ clone(): BarChartMediaInfo; static fromJSON(json: any): BarChartMediaInfo; } interface BarChartMediaInfoProperties extends MediaInfoProperties, ChartMediaInfoProperties { } export interface ColumnChartMediaInfo extends JSONSupport, MediaInfo, ChartMediaInfo { } export class ColumnChartMediaInfo { /** * Indicates the type of chart. * * @default column-chart * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ColumnChartMediaInfo.html#type) */ readonly type: string; /** * A `ColumnChartMediaInfo` is a type of chart media element that represents a column chart displayed within a popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ColumnChartMediaInfo.html) */ constructor(properties?: ColumnChartMediaInfoProperties); /** * Creates a deep clone of the ColumnChartMediaInfo class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ColumnChartMediaInfo.html#clone) */ clone(): ColumnChartMediaInfo; static fromJSON(json: any): ColumnChartMediaInfo; } interface ColumnChartMediaInfoProperties extends MediaInfoProperties, ChartMediaInfoProperties { } export interface Content extends Accessor, JSONSupport { } export class Content { /** * The type of popup element displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-Content.html#type) */ readonly type: "text" | "fields" | "media" | "attachments" | "custom" | "expression" | "relationship"; /** * Content elements define what should display within the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-Content.html) */ constructor(properties?: ContentProperties); static fromJSON(json: any): Content; } interface ContentProperties { } export interface CustomContent extends Content, JSONSupport { } export class CustomContent { /** * The function that is called to create the custom content element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-CustomContent.html#creator) */ creator: PopupTemplateContentCreator; /** * The called function to cleanup custom content when it is no longer necessary. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-CustomContent.html#destroyer) */ destroyer: PopupTemplateContentDestroyer; /** * An array of field names used in the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-CustomContent.html#outFields) */ outFields: string[]; /** * The type of popup element displayed. * * @default custom * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-CustomContent.html#type) */ readonly type: "custom"; /** * A `CustomContent` popup element is used to provide a way to customize the [popup's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-CustomContent.html) */ constructor(properties?: CustomContentProperties); /** * Creates a deep clone of the CustomContent class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-CustomContent.html#clone) */ clone(): CustomContent; static fromJSON(json: any): CustomContent; } interface CustomContentProperties extends ContentProperties { /** * The function that is called to create the custom content element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-CustomContent.html#creator) */ creator?: PopupTemplateContentCreator; /** * The called function to cleanup custom content when it is no longer necessary. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-CustomContent.html#destroyer) */ destroyer?: PopupTemplateContentDestroyer; /** * An array of field names used in the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-CustomContent.html#outFields) */ outFields?: string[]; } export type PopupTemplateContentCreator = ( event?: PopupTemplateCreatorEvent, ) => string | HTMLElement | Widget | Promise; export type PopupTemplateContentDestroyer = (event?: PopupTemplateCreatorEvent) => void; /** * The event that contains the [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-CustomContent.html#PopupTemplateCreatorEvent) */ export interface PopupTemplateCreatorEvent { /** * The [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-CustomContent.html#PopupTemplateCreatorEvent) */ graphic: Graphic; } export interface ExpressionContent extends Content, JSONSupport { } export class ExpressionContent { /** * Contains the Arcade expression used to create a popup content element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html#expressionInfo) */ expressionInfo: ElementExpressionInfo; /** * The type of popup element displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html#type) */ readonly type: "expression"; /** * An ExpressionContent element allows you to define a popup content element with an [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html) */ constructor(properties?: ExpressionContentProperties); /** * Creates a deep clone of the ExpressionContent instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html#clone) */ clone(): ExpressionContent; static fromJSON(json: any): ExpressionContent; } interface ExpressionContentProperties extends ContentProperties { /** * Contains the Arcade expression used to create a popup content element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html#expressionInfo) */ expressionInfo?: ElementExpressionInfoProperties; } export interface FieldsContent extends Content, JSONSupport { } export class FieldsContent { /** * Describes the field's content in detail. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-FieldsContent.html#description) */ description: string; /** * Array of [fieldInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-FieldsContent.html#fieldInfos) */ fieldInfos: FieldInfo[]; /** * Heading indicating what the field's content represents. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-FieldsContent.html#title) */ title: string; /** * The type of popup element displayed. * * @default fields * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-FieldsContent.html#type) */ readonly type: "fields"; /** * A `FieldsContent` popup element represents the [FieldInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html) associated with a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-FieldsContent.html) */ constructor(properties?: FieldsContentProperties); /** * Creates a deep clone of the FieldsContent class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-FieldsContent.html#clone) */ clone(): FieldsContent; static fromJSON(json: any): FieldsContent; } interface FieldsContentProperties extends ContentProperties { /** * Describes the field's content in detail. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-FieldsContent.html#description) */ description?: string; /** * Array of [fieldInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-FieldsContent.html#fieldInfos) */ fieldInfos?: FieldInfoProperties[]; /** * Heading indicating what the field's content represents. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-FieldsContent.html#title) */ title?: string; } export interface ImageMediaInfo extends Accessor, JSONSupport, MediaInfo { } export class ImageMediaInfo { /** * Refresh interval of the layer in minutes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ImageMediaInfo.html#refreshInterval) */ refreshInterval: number; /** * The type of popup element. * * @default image * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ImageMediaInfo.html#type) */ readonly type: string; /** * Defines the value format of the image media element and how the images should be retrieved. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ImageMediaInfo.html#value) */ value: ImageMediaInfoValue; /** * An `ImageMediaInfo` is a type of media element that represents images to display within a popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ImageMediaInfo.html) */ constructor(properties?: ImageMediaInfoProperties); /** * Creates a deep clone of the ImageMediaInfo class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ImageMediaInfo.html#clone) */ clone(): ImageMediaInfo; static fromJSON(json: any): ImageMediaInfo; } interface ImageMediaInfoProperties extends MediaInfoProperties { /** * Refresh interval of the layer in minutes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ImageMediaInfo.html#refreshInterval) */ refreshInterval?: number; /** * Defines the value format of the image media element and how the images should be retrieved. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ImageMediaInfo.html#value) */ value?: ImageMediaInfoValueProperties; } export interface LineChartMediaInfo extends Accessor, JSONSupport, MediaInfo, ChartMediaInfo { } export class LineChartMediaInfo { /** * Indicates the type of chart. * * @default line-chart * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-LineChartMediaInfo.html#type) */ readonly type: string; /** * A `LineChartMediaInfo` is a type of chart media element that represents a line chart displayed within a popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-LineChartMediaInfo.html) */ constructor(properties?: LineChartMediaInfoProperties); /** * Creates a deep clone of the LineChartMediaInfo class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-LineChartMediaInfo.html#clone) */ clone(): LineChartMediaInfo; static fromJSON(json: any): LineChartMediaInfo; } interface LineChartMediaInfoProperties extends MediaInfoProperties, ChartMediaInfoProperties { } export interface MediaContent extends Content, JSONSupport { } export class MediaContent { /** * Index of the current active media within the popup's media content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html#activeMediaInfoIndex) */ activeMediaInfoIndex: string; /** * Describes the media's content in detail. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html#description) */ description: string; /** * Contains the media elements representing images or charts to display within the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html#mediaInfos) */ mediaInfos: | BarChartMediaInfo | ColumnChartMediaInfo | ImageMediaInfo | LineChartMediaInfo | PieChartMediaInfo | any[]; /** * Heading indicating what the media's content represents. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html#title) */ title: string; /** * The type of popup element displayed. * * @default media * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html#type) */ readonly type: "media"; /** * A `MediaContent` popup element contains an individual or array of chart and/or image media elements to display within a popup's content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) */ constructor(properties?: MediaContentProperties); /** * Creates a deep clone of the MediaContent class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html#clone) */ clone(): MediaContent; static fromJSON(json: any): MediaContent; } interface MediaContentProperties extends ContentProperties { /** * Index of the current active media within the popup's media content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html#activeMediaInfoIndex) */ activeMediaInfoIndex?: string; /** * Describes the media's content in detail. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html#description) */ description?: string; /** * Contains the media elements representing images or charts to display within the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html#mediaInfos) */ mediaInfos?: | BarChartMediaInfoProperties | ColumnChartMediaInfoProperties | ImageMediaInfoProperties | LineChartMediaInfoProperties | PieChartMediaInfoProperties | any[]; /** * Heading indicating what the media's content represents. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html#title) */ title?: string; } export class ChartMediaInfo { /** * Defines the chart value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-mixins-ChartMediaInfo.html#value) */ value: ChartMediaInfoValue; } interface ChartMediaInfoProperties { /** * Defines the chart value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-mixins-ChartMediaInfo.html#value) */ value?: ChartMediaInfoValueProperties; } export class MediaInfo { /** * Provides an alternate text for an image if the image cannot be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-mixins-MediaInfo.html#altText) */ altText: string; /** * Defines a caption for the media. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-mixins-MediaInfo.html#caption) */ caption: string; /** * The title of the media element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-mixins-MediaInfo.html#title) */ title: string; } interface MediaInfoProperties { /** * Provides an alternate text for an image if the image cannot be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-mixins-MediaInfo.html#altText) */ altText?: string; /** * Defines a caption for the media. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-mixins-MediaInfo.html#caption) */ caption?: string; /** * The title of the media element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-mixins-MediaInfo.html#title) */ title?: string; } export interface PieChartMediaInfo extends Accessor, JSONSupport, MediaInfo, ChartMediaInfo { } export class PieChartMediaInfo { /** * Indicates the type of chart. * * @default pie-chart * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-PieChartMediaInfo.html#type) */ readonly type: string; /** * A `PieChartMediaInfo` is a type of chart media element that represents a pie chart displayed within a popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-PieChartMediaInfo.html) */ constructor(properties?: PieChartMediaInfoProperties); /** * Creates a deep clone of the PieChartMediaInfo class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-PieChartMediaInfo.html#clone) */ clone(): PieChartMediaInfo; static fromJSON(json: any): PieChartMediaInfo; } interface PieChartMediaInfoProperties extends MediaInfoProperties, ChartMediaInfoProperties { } export interface RelationshipContent extends Content, JSONSupport, Clonable { } export class RelationshipContent { /** * Describes the relationship's content in detail. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-RelationshipContent.html#description) */ description: string; /** * A numeric value indicating the maximum number of related features to display in the list of related records. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-RelationshipContent.html#displayCount) */ displayCount: number; /** * A string value indicating how to display related records within the relationship content. * * @default "list" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-RelationshipContent.html#displayType) */ displayType: "list"; /** * An array of [RelatedRecordsInfoFieldOrder](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-RelatedRecordsInfoFieldOrder.html) indicating the display order for the related records, and whether they should be sorted in ascending `asc` or descending `desc` order. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-RelationshipContent.html#orderByFields) */ orderByFields: RelatedRecordsInfoFieldOrder[]; /** * The numeric id value for the defined relationship. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-RelationshipContent.html#relationshipId) */ relationshipId: number; /** * A heading indicating what the relationship's content represents. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-RelationshipContent.html#title) */ title: string; /** * The type of popup element displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-RelationshipContent.html#type) */ readonly type: "relationship"; /** * A `RelationshipContent` popup element represents a relationship element associated with a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-RelationshipContent.html) */ constructor(properties?: RelationshipContentProperties); static fromJSON(json: any): RelationshipContent; } interface RelationshipContentProperties extends ContentProperties { /** * Describes the relationship's content in detail. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-RelationshipContent.html#description) */ description?: string; /** * A numeric value indicating the maximum number of related features to display in the list of related records. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-RelationshipContent.html#displayCount) */ displayCount?: number; /** * A string value indicating how to display related records within the relationship content. * * @default "list" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-RelationshipContent.html#displayType) */ displayType?: "list"; /** * An array of [RelatedRecordsInfoFieldOrder](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-RelatedRecordsInfoFieldOrder.html) indicating the display order for the related records, and whether they should be sorted in ascending `asc` or descending `desc` order. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-RelationshipContent.html#orderByFields) */ orderByFields?: RelatedRecordsInfoFieldOrderProperties[]; /** * The numeric id value for the defined relationship. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-RelationshipContent.html#relationshipId) */ relationshipId?: number; /** * A heading indicating what the relationship's content represents. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-RelationshipContent.html#title) */ title?: string; } export interface ChartMediaInfoValue extends Accessor, JSONSupport { } export class ChartMediaInfoValue { /** * An optional array of [colors](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) where each color corresponds respectively to a field in the [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ChartMediaInfoValue.html#fields). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ChartMediaInfoValue.html#colors) */ colors: Color[]; /** * An array of strings, with each string containing the name of a field to display in the chart. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ChartMediaInfoValue.html#fields) */ fields: string[]; /** * A string containing the name of a field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ChartMediaInfoValue.html#normalizeField) */ normalizeField: string; /** * An array of [ChartMediaInfoValueSeries](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ChartMediaInfoValueSeries.html) objects which provide information of x/y data that is plotted in a chart. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ChartMediaInfoValue.html#series) */ series: ChartMediaInfoValueSeries[]; /** * String value indicating the tooltip for a chart specified from another field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ChartMediaInfoValue.html#tooltipField) */ tooltipField: string; /** * The `ChartMediaInfoValue` class contains information for popups regarding how charts should be constructed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ChartMediaInfoValue.html) */ constructor(properties?: ChartMediaInfoValueProperties); static fromJSON(json: any): ChartMediaInfoValue; } interface ChartMediaInfoValueProperties { /** * An optional array of [colors](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) where each color corresponds respectively to a field in the [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ChartMediaInfoValue.html#fields). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ChartMediaInfoValue.html#colors) */ colors?: Color[]; /** * An array of strings, with each string containing the name of a field to display in the chart. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ChartMediaInfoValue.html#fields) */ fields?: string[]; /** * A string containing the name of a field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ChartMediaInfoValue.html#normalizeField) */ normalizeField?: string; /** * An array of [ChartMediaInfoValueSeries](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ChartMediaInfoValueSeries.html) objects which provide information of x/y data that is plotted in a chart. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ChartMediaInfoValue.html#series) */ series?: ChartMediaInfoValueSeriesProperties[]; /** * String value indicating the tooltip for a chart specified from another field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ChartMediaInfoValue.html#tooltipField) */ tooltipField?: string; } export class ChartMediaInfoValueSeries extends Accessor { /** * The [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) representing the field for a series. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ChartMediaInfoValueSeries.html#color) */ readonly color: Color; /** * String value indicating the field's name for a series. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ChartMediaInfoValueSeries.html#fieldName) */ readonly fieldName: string; /** * String value indicating the tooltip for a series. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ChartMediaInfoValueSeries.html#tooltip) */ readonly tooltip: string; /** * Numerical value for the chart series. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ChartMediaInfoValueSeries.html#value) */ readonly value: number; /** * The `ChartMediaInfoValueSeries` class is a read-only support class that represents information specific to how data should be plotted in a chart. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ChartMediaInfoValueSeries.html) */ constructor(properties?: ChartMediaInfoValueSeriesProperties); /** * Creates a deep clone of the ChartMediaInfoValueSeries class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ChartMediaInfoValueSeries.html#clone) */ clone(): ChartMediaInfoValueSeries; } interface ChartMediaInfoValueSeriesProperties { } export interface ImageMediaInfoValue extends Accessor, JSONSupport { } export class ImageMediaInfoValue { /** * A string containing a URL to be launched in a browser when a user clicks the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ImageMediaInfoValue.html#linkURL) */ linkURL: string; /** * A string containing the URL to the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ImageMediaInfoValue.html#sourceURL) */ sourceURL: string; /** * The `ImageMediaInfoValue` class contains information for popups regarding how images should be retrieved. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ImageMediaInfoValue.html) */ constructor(properties?: ImageMediaInfoValueProperties); /** * Creates a deep clone of the ImageMediaInfoValue class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ImageMediaInfoValue.html#clone) */ clone(): ImageMediaInfoValue; static fromJSON(json: any): ImageMediaInfoValue; } interface ImageMediaInfoValueProperties { /** * A string containing a URL to be launched in a browser when a user clicks the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ImageMediaInfoValue.html#linkURL) */ linkURL?: string; /** * A string containing the URL to the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-support-ImageMediaInfoValue.html#sourceURL) */ sourceURL?: string; } export interface TextContent extends Content, JSONSupport { } export class TextContent { /** * The formatted string content to display. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-TextContent.html#text) */ text: string; /** * The type of popup element displayed. * * @default text * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-TextContent.html#type) */ readonly type: "text"; /** * A `TextContent` popup element is used to define descriptive text as an element within a [PopupTemplate's](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-TextContent.html) */ constructor(properties?: TextContentProperties); /** * Creates a deep clone of the TextContent class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-TextContent.html#clone) */ clone(): TextContent; static fromJSON(json: any): TextContent; } interface TextContentProperties extends ContentProperties { /** * The formatted string content to display. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-TextContent.html#text) */ text?: string; } /** * AttachmentsContent represents an attachment element associated with a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content.html#AttachmentsContent) */ export type contentAttachmentsContent = AttachmentsContent; /** * Popup content element types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content.html#Content) */ export type contentContent = | TextContent | MediaContent | FieldsContent | AttachmentsContent | CustomContent | ExpressionContent | RelationshipContent; /** * CustomContent represents a custom content element associated with a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content.html#CustomContent) */ export type contentCustomContent = CustomContent; /** * ExpressionContent represents an expression element associated with a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content.html#ExpressionContent) */ export type contentExpressionContent = ExpressionContent; /** * FieldsContent represents the [FieldInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html) associated with a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content.html#FieldsContent) */ export type contentFieldsContent = FieldsContent; /** * MediaContent contains an individual or array of chart and/or image media elements to display within a popup's content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content.html#MediaContent) */ export type contentMediaContent = MediaContent; /** * RelationshipContent represents an relationship element associated with a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content.html#RelationshipContent) */ export type contentRelationshipContent = RelationshipContent; /** * TextContent defines descriptive text as an element within the [PopupTemplate's](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content.html#TextContent) */ export type contentTextContent = TextContent; export interface ElementExpressionInfo extends Accessor, JSONSupport { } export class ElementExpressionInfo { /** * The [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression evaluating to a dictionary. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ElementExpressionInfo.html#expression) */ expression: string; /** * The return type of the expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ElementExpressionInfo.html#returnType) */ returnType: "dictionary"; /** * The title used to describe the popup element returned by the expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ElementExpressionInfo.html#title) */ title: string; /** * Defines an [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression used to create an [ExpressionContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html) element in a [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ElementExpressionInfo.html) */ constructor(properties?: ElementExpressionInfoProperties); /** * Creates a deep clone of the ElementExpressionInfo instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ElementExpressionInfo.html#clone) */ clone(): ElementExpressionInfo; static fromJSON(json: any): ElementExpressionInfo; } interface ElementExpressionInfoProperties { /** * The [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression evaluating to a dictionary. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ElementExpressionInfo.html#expression) */ expression?: string; /** * The return type of the expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ElementExpressionInfo.html#returnType) */ returnType?: "dictionary"; /** * The title used to describe the popup element returned by the expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ElementExpressionInfo.html#title) */ title?: string; } export interface popupExpressionInfo extends Accessor, JSONSupport { } export class popupExpressionInfo { /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Popup Profile](https://developers.arcgis.com/javascript/latest/arcade/#popup). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ExpressionInfo.html#expression) */ expression: string; /** * The name of the expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ExpressionInfo.html#name) */ name: string; /** * Indicates the return type of the Arcade expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ExpressionInfo.html#returnType) */ returnType: "string" | "number"; /** * The title used to describe the value returned by the expression in the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ExpressionInfo.html#title) */ title: string; /** * The `ExpressionInfo` class references [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expressions following the specification defined by the [Arcade Popup Profile](https://developers.arcgis.com/javascript/latest/arcade/#popup). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ExpressionInfo.html) */ constructor(properties?: popupExpressionInfoProperties); /** * Creates a deep clone of the ExpressionInfo class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ExpressionInfo.html#clone) */ clone(): popupExpressionInfo; static fromJSON(json: any): popupExpressionInfo; } interface popupExpressionInfoProperties { /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Popup Profile](https://developers.arcgis.com/javascript/latest/arcade/#popup). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ExpressionInfo.html#expression) */ expression?: string; /** * The name of the expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ExpressionInfo.html#name) */ name?: string; /** * Indicates the return type of the Arcade expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ExpressionInfo.html#returnType) */ returnType?: "string" | "number"; /** * The title used to describe the value returned by the expression in the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ExpressionInfo.html#title) */ title?: string; } export interface FieldInfo extends Accessor, JSONSupport { } export class FieldInfo { /** * The field name as defined by the service or the name of an [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html#fieldName) */ fieldName: string; /** * Class which provides formatting options for numerical or date fields and how they should display within a popup. * * * If displaying a `timestamp-offset` or `date` [type](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#type) field in a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html), [Features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html), or [Feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html) widget and the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) has a [timezone](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#timeZone) set other than `unknown`, the abbreviated time zone suffix will be omitted from the attribute value. For example, the attribute value will display as `9/28/2014, 7:58 PM`. To display an abbreviated time zone suffix, see the `Read more` section. >>>esri-read-more[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html#format) */ format: FieldInfoFormat; /** * A Boolean determining whether users can edit this field. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html#isEditable) */ isEditable: boolean; /** * A string containing the field alias. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html#label) */ label: string; /** * Used in a `one:many` or `many:many` relationship to compute the statistics on the field to show in the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html#statisticType) */ statisticType: "count" | "sum" | "min" | "max" | "avg" | "stddev" | "var"; /** * A string determining what type of input box editors see when editing the field. * * @default text-box * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html#stringFieldOption) */ stringFieldOption: "rich-text" | "text-area" | "text-box"; /** * A string providing an editing hint for editors of the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html#tooltip) */ tooltip: string; /** * Indicates whether the field is visible in the popup window. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html#visible) */ visible: boolean; /** * The `FieldInfo` class defines how a [Field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) participates, or in some cases, does not participate, in a [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html) */ constructor(properties?: FieldInfoProperties); /** * Creates a deep clone of the FieldInfo class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html#clone) */ clone(): FieldInfo; static fromJSON(json: any): FieldInfo; } interface FieldInfoProperties { /** * The field name as defined by the service or the name of an [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html#fieldName) */ fieldName?: string; /** * Class which provides formatting options for numerical or date fields and how they should display within a popup. * * * If displaying a `timestamp-offset` or `date` [type](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#type) field in a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html), [Features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html), or [Feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html) widget and the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) has a [timezone](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#timeZone) set other than `unknown`, the abbreviated time zone suffix will be omitted from the attribute value. For example, the attribute value will display as `9/28/2014, 7:58 PM`. To display an abbreviated time zone suffix, see the `Read more` section. >>>esri-read-more[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html#format) */ format?: FieldInfoFormatProperties; /** * A Boolean determining whether users can edit this field. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html#isEditable) */ isEditable?: boolean; /** * A string containing the field alias. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html#label) */ label?: string; /** * Used in a `one:many` or `many:many` relationship to compute the statistics on the field to show in the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html#statisticType) */ statisticType?: "count" | "sum" | "min" | "max" | "avg" | "stddev" | "var"; /** * A string determining what type of input box editors see when editing the field. * * @default text-box * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html#stringFieldOption) */ stringFieldOption?: "rich-text" | "text-area" | "text-box"; /** * A string providing an editing hint for editors of the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html#tooltip) */ tooltip?: string; /** * Indicates whether the field is visible in the popup window. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html#visible) */ visible?: boolean; } export interface LayerOptions extends Accessor, JSONSupport { } export class LayerOptions { /** * Applicable to [Imagery Layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-LayerOptions.html#returnTopmostRaster) */ returnTopmostRaster: boolean; /** * Applicable to [Imagery Layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-LayerOptions.html#showNoDataRecords) */ showNoDataRecords: boolean; /** * The `LayerOptions` class defines additional options that can be defined for a layer's [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-LayerOptions.html) */ constructor(properties?: LayerOptionsProperties); /** * Creates a deep clone of the LayerOptions class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-LayerOptions.html#clone) */ clone(): LayerOptions; static fromJSON(json: any): LayerOptions; } interface LayerOptionsProperties { /** * Applicable to [Imagery Layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-LayerOptions.html#returnTopmostRaster) */ returnTopmostRaster?: boolean; /** * Applicable to [Imagery Layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-LayerOptions.html#showNoDataRecords) */ showNoDataRecords?: boolean; } export interface RelatedRecordsInfo extends Accessor, JSONSupport { } export class RelatedRecordsInfo { /** * An array of [RelatedRecordsInfoFieldOrder](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-RelatedRecordsInfoFieldOrder.html) objects indicating the field display order for the related records and whether they should be sorted in ascending `asc` or descending `desc` order. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-RelatedRecordsInfo.html#orderByFields) */ orderByFields: RelatedRecordsInfoFieldOrder[]; /** * Indicates whether to display related records in the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-RelatedRecordsInfo.html#showRelatedRecords) */ showRelatedRecords: boolean; /** * The `RelatedRecordsInfo` class provides additional sorting options when working with related records in a layer's [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-RelatedRecordsInfo.html) */ constructor(properties?: RelatedRecordsInfoProperties); /** * Creates a deep clone of the RelatedRecordsInfo class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-RelatedRecordsInfo.html#clone) */ clone(): RelatedRecordsInfo; static fromJSON(json: any): RelatedRecordsInfo; } interface RelatedRecordsInfoProperties { /** * An array of [RelatedRecordsInfoFieldOrder](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-RelatedRecordsInfoFieldOrder.html) objects indicating the field display order for the related records and whether they should be sorted in ascending `asc` or descending `desc` order. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-RelatedRecordsInfo.html#orderByFields) */ orderByFields?: RelatedRecordsInfoFieldOrderProperties[]; /** * Indicates whether to display related records in the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-RelatedRecordsInfo.html#showRelatedRecords) */ showRelatedRecords?: boolean; } export interface FieldInfoFormat extends Accessor, JSONSupport, Clonable { } export class FieldInfoFormat { /** * Used only with `Date` fields. * * * If displaying a `timestamp-offset` or `date` [type](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#type) field in a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html), [Features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html), or [Feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html) widget and the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) has a [timezone](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#timeZone) set other than `unknown`, the abbreviated time zone suffix will be omitted from the attribute value. For example, the attribute value will display as `9/28/2014, 7:58 PM`. To display an abbreviated time zone suffix, see the `Read more` section. >>>esri-read-more[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-FieldInfoFormat.html#dateFormat) */ dateFormat: | "short-date" | "short-date-short-time" | "short-date-short-time-24" | "short-date-long-time" | "short-date-long-time-24" | "long-month-day-year" | "long-month-day-year-short-time" | "long-month-day-year-short-time-24" | "long-month-day-year-long-time" | "long-month-day-year-long-time-24" | "day-short-month-year" | "day-short-month-year-short-time" | "day-short-month-year-short-time-24" | "day-short-month-year-long-time" | "day-short-month-year-long-time-24" | "long-date" | "long-date-short-time" | "long-date-short-time-24" | "long-date-long-time" | "long-date-long-time-24" | "long-month-year" | "short-month-year" | "year"; /** * Used only with `Number` fields. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-FieldInfoFormat.html#digitSeparator) */ digitSeparator: boolean; /** * Used only with `Number` fields to specify the number of supported decimal places that should appear in popups. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-FieldInfoFormat.html#places) */ places: number; /** * The `FieldInfoFormat` class is used with numerical or date fields to provide more detail about how the value should be displayed in a popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-FieldInfoFormat.html) */ constructor(properties?: FieldInfoFormatProperties); static fromJSON(json: any): FieldInfoFormat; } interface FieldInfoFormatProperties { /** * Used only with `Date` fields. * * * If displaying a `timestamp-offset` or `date` [type](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#type) field in a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html), [Features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html), or [Feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html) widget and the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) has a [timezone](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#timeZone) set other than `unknown`, the abbreviated time zone suffix will be omitted from the attribute value. For example, the attribute value will display as `9/28/2014, 7:58 PM`. To display an abbreviated time zone suffix, see the `Read more` section. >>>esri-read-more[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-FieldInfoFormat.html#dateFormat) */ dateFormat?: | "short-date" | "short-date-short-time" | "short-date-short-time-24" | "short-date-long-time" | "short-date-long-time-24" | "long-month-day-year" | "long-month-day-year-short-time" | "long-month-day-year-short-time-24" | "long-month-day-year-long-time" | "long-month-day-year-long-time-24" | "day-short-month-year" | "day-short-month-year-short-time" | "day-short-month-year-short-time-24" | "day-short-month-year-long-time" | "day-short-month-year-long-time-24" | "long-date" | "long-date-short-time" | "long-date-short-time-24" | "long-date-long-time" | "long-date-long-time-24" | "long-month-year" | "short-month-year" | "year"; /** * Used only with `Number` fields. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-FieldInfoFormat.html#digitSeparator) */ digitSeparator?: boolean; /** * Used only with `Number` fields to specify the number of supported decimal places that should appear in popups. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-FieldInfoFormat.html#places) */ places?: number; } export interface RelatedRecordsInfoFieldOrder extends Accessor, JSONSupport { } export class RelatedRecordsInfoFieldOrder { /** * The attribute value of the field selected that will drive the sorting of related records. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-RelatedRecordsInfoFieldOrder.html#field) */ field: string; /** * Set the ascending or descending sort order of the returned related records. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-RelatedRecordsInfoFieldOrder.html#order) */ order: "asc" | "desc"; /** * The `RelatedRecordsInfoFieldOrder` class indicates the field display order for the related records in a layer's [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-RelatedRecordsInfoFieldOrder.html) */ constructor(properties?: RelatedRecordsInfoFieldOrderProperties); /** * Creates a deep clone of the RelatedRecordsInfoFieldOrder class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-RelatedRecordsInfoFieldOrder.html#clone) */ clone(): RelatedRecordsInfoFieldOrder; static fromJSON(json: any): RelatedRecordsInfoFieldOrder; } interface RelatedRecordsInfoFieldOrderProperties { /** * The attribute value of the field selected that will drive the sorting of related records. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-RelatedRecordsInfoFieldOrder.html#field) */ field?: string; /** * Set the ascending or descending sort order of the returned related records. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-RelatedRecordsInfoFieldOrder.html#order) */ order?: "asc" | "desc"; } export interface PopupTemplate extends Accessor, Clonable, JSONSupport { } export class PopupTemplate { /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [action toggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html) objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#actions) */ actions: Collection; /** * The template for defining and formatting a popup's content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#content) */ content: Content[] | string | Function | Promise; /** * An array of objects or [ExpressionInfo[]](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ExpressionInfo.html) that reference [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expressions following the specification defined by the [Arcade Popup Profile](https://developers.arcgis.com/javascript/latest/arcade/#popup). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#expressionInfos) */ expressionInfos: popupExpressionInfo[]; /** * An array of [FieldInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html) that defines how fields in the dataset or values from [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expressions participate in a popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#fieldInfos) */ fieldInfos: FieldInfo[]; /** * Indicates whether or not editor tracking should display. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#lastEditInfoEnabled) */ lastEditInfoEnabled: boolean; /** * Additional options that can be defined for the popup layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#layerOptions) */ layerOptions: LayerOptions; /** * An array of field names used in the PopupTemplate. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#outFields) */ outFields: string[]; /** * Indicates whether actions should replace existing [popup actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#actions). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#overwriteActions) */ overwriteActions: boolean; /** * Indicates whether to include the feature's geometry for use by the template. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#returnGeometry) */ returnGeometry: boolean; /** * The template for defining how to format the title used in a popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#title) */ title: string | Function | Promise; /** * A PopupTemplate formats and defines the content of a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) for a specific [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) or [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) */ constructor(properties?: PopupTemplateProperties); static fromJSON(json: any): PopupTemplate; } interface PopupTemplateProperties { /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [action toggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html) objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#actions) */ actions?: CollectionProperties< (ActionButtonProperties & { type: "button" }) | (ActionToggleProperties & { type: "toggle" }) >; /** * The template for defining and formatting a popup's content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#content) */ content?: ContentProperties[] | string | Function | Promise; /** * An array of objects or [ExpressionInfo[]](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ExpressionInfo.html) that reference [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expressions following the specification defined by the [Arcade Popup Profile](https://developers.arcgis.com/javascript/latest/arcade/#popup). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#expressionInfos) */ expressionInfos?: popupExpressionInfoProperties[]; /** * An array of [FieldInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html) that defines how fields in the dataset or values from [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expressions participate in a popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#fieldInfos) */ fieldInfos?: FieldInfoProperties[]; /** * Indicates whether or not editor tracking should display. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#lastEditInfoEnabled) */ lastEditInfoEnabled?: boolean; /** * Additional options that can be defined for the popup layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#layerOptions) */ layerOptions?: LayerOptionsProperties; /** * An array of field names used in the PopupTemplate. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#outFields) */ outFields?: string[]; /** * Indicates whether actions should replace existing [popup actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#actions). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#overwriteActions) */ overwriteActions?: boolean; /** * Indicates whether to include the feature's geometry for use by the template. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#returnGeometry) */ returnGeometry?: boolean; /** * The template for defining how to format the title used in a popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#title) */ title?: string | Function | Promise; } export interface Portal extends Accessor, Loadable { } export class Portal { /** * The access level of the organization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#access) */ access: "public" | "private"; /** * When `true`, access to the organization's Portal resources must occur over SSL. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#allSSL) */ allSSL: boolean; /** * The authentication mode for handling authentication when the user attempts to access a secure resource. * * @default auto * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#authMode) */ authMode: "anonymous" | "auto" | "immediate" | "no-prompt"; /** * Array of trusted servers to send credentials to when making Cross-Origin Resource Sharing (CORS) requests to access services secured with web-tier authentication. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#authorizedCrossOriginDomains) */ authorizedCrossOriginDomains: string[]; /** * The query that defines the basemaps that should be displayed in the [BasemapGallery](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html) when [useVectorBasemaps](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#useVectorBasemaps) is not true. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#basemapGalleryGroupQuery) */ basemapGalleryGroupQuery: string; /** * The query that defines the 3D basemaps that should be displayed in the [BasemapGallery](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#basemapGalleryGroupQuery3D) */ basemapGalleryGroupQuery3D: string; /** * The Bing key to use for web maps using Bing Maps. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#bingKey) */ bingKey: string; /** * Indicates whether an organization can list applications in the marketplace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canListApps) */ canListApps: boolean; /** * Indicates whether an organization can list data services in the marketplace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canListData) */ canListData: boolean; /** * Indicates whether an organization can list pre-provisioned items in the marketplace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canListPreProvisionedItems) */ canListPreProvisionedItems: boolean; /** * Indicates whether an organization can provision direct purchases in the marketplace without customer request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canProvisionDirectPurchase) */ canProvisionDirectPurchase: boolean; /** * When `true`, the organization's public items, groups and users are included in search queries. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canSearchPublic) */ canSearchPublic: boolean; /** * The Bing key can be shared to the public and is returned as part of a portal's description call (`/sharing/rest/portals/`). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canShareBingPublic) */ canShareBingPublic: boolean; /** * When `true`, members of the organization can share resources outside the organization. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canSharePublic) */ canSharePublic: boolean; /** * Indicates whether to allow an organization with an enterprise IDP configured to be able to turn on or off the ArcGIS sign in. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canSignInArcGIS) */ canSignInArcGIS: boolean; /** * Indicates whether to allow an organization with an enterprise IDP configured to be able to turn on or off the enterprise sign in. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canSignInIDP) */ canSignInIDP: boolean; /** * The query that identifies the group containing the color sets used for rendering in the map viewer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#colorSetsGroupQuery) */ colorSetsGroupQuery: string; /** * Indicates whether to allow the organization to disable commenting. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#commentsEnabled) */ commentsEnabled: boolean; /** * Date the organization was created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#created) */ created: Date; /** * The default locale (language and country) information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#culture) */ culture: string; /** * The custom base URL for the portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#customBaseUrl) */ customBaseUrl: string; /** * The default basemap to use for the portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#defaultBasemap) */ defaultBasemap: Basemap; /** * The default developer basemap to use for the portal when an [apiKey](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#apiKey) is defined. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#defaultDevBasemap) */ defaultDevBasemap: Basemap; /** * The default extent to use for the portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#defaultExtent) */ defaultExtent: Extent; /** * The default vector basemap to use for the portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#defaultVectorBasemap) */ defaultVectorBasemap: Basemap; /** * A description of the organization/portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#description) */ description: string; /** * The query that defines the basemaps that should be displayed in the [BasemapGallery](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html) when an [apiKey](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#apiKey) is defined. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#devBasemapGalleryGroupQuery) */ devBasemapGalleryGroupQuery: string; /** * Boolean value indicating whether to opt-in to the [Esri User Experience Improvement (EUEI) program](https://doc.arcgis.com/en/arcgis-online/reference/faq.htm#ESRI_QUESTIONANSWER_AED97F28DCD84F7682623C2FA9E5CE49). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#eueiEnabled) */ eueiEnabled: boolean; /** * The featured groups for the portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#featuredGroups) */ featuredGroups: PortalFeaturedGroups[]; /** * The query that defines the featured group. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#featuredItemsGroupQuery) */ featuredItemsGroupQuery: string; /** * The query that identifies the group containing features items for the gallery. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#galleryTemplatesGroupQuery) */ galleryTemplatesGroupQuery: string; /** * Indicates whether the organization has content categories. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#hasCategorySchema) */ hasCategorySchema: boolean; /** * Helper services provided by the portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#helperServices) */ helperServices: any; /** * The group that contains featured content to be displayed on the home page. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#homePageFeaturedContent) */ homePageFeaturedContent: string; /** * The number of featured items that can be displayed on the home page. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#homePageFeaturedContentCount) */ homePageFeaturedContentCount: number; /** * The port used by the portal for HTTP communication. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#httpPort) */ httpPort: number; /** * The port used by the portal for HTTPS communication. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#httpsPort) */ httpsPort: number; /** * The id of the organization that owns this portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#id) */ id: string; /** * The country code of the calling IP (ArcGIS Online only). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#ipCntryCode) */ ipCntryCode: string; /** * Indicates whether the portal is an organization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#isOrganization) */ readonly isOrganization: boolean; /** * Indicates if the portal is on-premises. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#isPortal) */ isPortal: boolean; /** * Indicates if the portal is in read-only mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#isReadOnly) */ isReadOnly: boolean; /** * The query that identifies the group containing editing templates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#layerTemplatesGroupQuery) */ layerTemplatesGroupQuery: string; /** * Indicates whether the portal's resources have loaded. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#loaded) */ readonly loaded: boolean; /** * The maximum validity in minutes of tokens issued for users of the organization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#maxTokenExpirationMinutes) */ maxTokenExpirationMinutes: number; /** * Date the organization was last modified. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#modified) */ modified: Date; /** * Name of the organization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#name) */ name: string; /** * URL of the portal host. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#portalHostname) */ portalHostname: string; /** * The portal mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#portalMode) */ portalMode: "multitenant" | "singletenant"; /** * Properties specific to the organization, for example the "contact us" link. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#portalProperties) */ portalProperties: any; /** * The region for the organization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#region) */ region: string; /** * The REST URL for the portal, for example "https://www.arcgis.com/sharing/rest" for ArcGIS Online and "https://www.example.com/arcgis/sharing/rest" for your in-house portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#restUrl) */ readonly restUrl: string; /** * Custom HTML for the home page. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#rotatorPanels) */ rotatorPanels: any[]; /** * Indicates whether the description of your organization displays on the home page. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#showHomePageDescription) */ showHomePageDescription: boolean; /** * The JSON used to create the property values when the `Portal` is loaded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#sourceJSON) */ sourceJSON: any; /** * Indicates whether hosted services are supported. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#supportsHostedServices) */ supportsHostedServices: boolean; /** * The query that defines the symbols sets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#symbolSetsGroupQuery) */ symbolSetsGroupQuery: string; /** * The query that defines the collection of templates that will appear in the template gallery. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#templatesGroupQuery) */ templatesGroupQuery: string; /** * The URL to the thumbnail of the organization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#thumbnailUrl) */ readonly thumbnailUrl: string; /** * Sets the units of measure for the organization's users. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#units) */ units: "english" | "metric"; /** * The URL to the portal instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#url) */ url: string; /** * The prefix selected by the organization's administrator to be used with the customBaseURL. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#urlKey) */ urlKey: string; /** * When `false`, 3D basemaps are hidden from the [BasemapGallery](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html), regardless of the type of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#use3dBasemaps) */ use3dBasemaps: boolean; /** * Information representing a registered user of the portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#user) */ user: PortalUser; /** * When `true`, only simple where clauses that are compliant with SQL92 can be used when querying layers and tables. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#useStandardizedQuery) */ useStandardizedQuery: boolean; /** * When `true`, the organization has opted in to use the vector tile basemaps, and (a) [vectorBasemapGalleryGroupQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#vectorBasemapGalleryGroupQuery) should be used instead of [basemapGalleryGroupQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#basemapGalleryGroupQuery), while (b) [defaultVectorBasemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#defaultVectorBasemap) should be used instead of [defaultBasemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#defaultBasemap). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#useVectorBasemaps) */ useVectorBasemaps: boolean; /** * The query that defines the vector tiles basemaps that should be displayed in the [BasemapGallery](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html) when [useVectorBasemaps](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#useVectorBasemaps) is true. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#vectorBasemapGalleryGroupQuery) */ vectorBasemapGalleryGroupQuery: string; /** * The Portal class is part of the [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/) that provides a way to build applications that work with content from [ArcGIS Online](https://www.arcgis.com/home/) or an [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html) */ constructor(properties?: PortalProperties); /** * A helper function that returns an array of [ElevationsLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html) derived from the Portal's [Limited Error Raster Compression (LERC) elevation helper service](https://enterprise.arcgis.com/en/portal/latest/administer/windows/about-utility-services.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#createElevationLayers) */ createElevationLayers(): Promise; /** * Fetches the [basemaps](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) that are displayed in the [BasemapGallery](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#fetchBasemaps) */ fetchBasemaps(basemapGalleryGroupQuery?: string, options?: PortalFetchBasemapsOptions): Promise; /** * If present, fetches the organization's category schema. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#fetchCategorySchema) */ fetchCategorySchema(options?: PortalFetchCategorySchemaOptions): Promise; /** * Fetches the featured groups in the Portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#fetchFeaturedGroups) */ fetchFeaturedGroups(options?: PortalFetchFeaturedGroupsOptions): Promise; /** * Fetches and returns the associated regions with the portal instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#fetchRegions) */ fetchRegions(options?: PortalFetchRegionsOptions): Promise; /** * Fetches and returns the portal settings as seen by the current user(s), whether anonymous or signed in. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#fetchSettings) */ fetchSettings(options?: PortalFetchSettingsOptions): Promise; /** * Executes a query against the Portal to return an array of [PortalGroup](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html) objects that match the input query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#queryGroups) */ queryGroups(queryParams: PortalQueryParams | PortalQueryParamsProperties, options?: PortalQueryGroupsOptions): Promise; /** * Executes a query against the Portal to return an array of [PortalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html) objects that match the input query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#queryItems) */ queryItems(queryParams: PortalQueryParams | PortalQueryParamsProperties, options?: PortalQueryItemsOptions): Promise; /** * Executes a query against the Portal to return an array of [PortalUser](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html) objects that match the input query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#queryUsers) */ queryUsers(queryParams: PortalQueryParams | PortalQueryParamsProperties, options?: PortalQueryUsersOptions): Promise; /** * A new `Portal` instance is created the first time this method is called. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#getDefault) */ static getDefault(): Portal; } interface PortalProperties extends LoadableProperties { /** * The access level of the organization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#access) */ access?: "public" | "private"; /** * When `true`, access to the organization's Portal resources must occur over SSL. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#allSSL) */ allSSL?: boolean; /** * The authentication mode for handling authentication when the user attempts to access a secure resource. * * @default auto * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#authMode) */ authMode?: "anonymous" | "auto" | "immediate" | "no-prompt"; /** * Array of trusted servers to send credentials to when making Cross-Origin Resource Sharing (CORS) requests to access services secured with web-tier authentication. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#authorizedCrossOriginDomains) */ authorizedCrossOriginDomains?: string[]; /** * The query that defines the basemaps that should be displayed in the [BasemapGallery](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html) when [useVectorBasemaps](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#useVectorBasemaps) is not true. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#basemapGalleryGroupQuery) */ basemapGalleryGroupQuery?: string; /** * The query that defines the 3D basemaps that should be displayed in the [BasemapGallery](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#basemapGalleryGroupQuery3D) */ basemapGalleryGroupQuery3D?: string; /** * The Bing key to use for web maps using Bing Maps. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#bingKey) */ bingKey?: string; /** * Indicates whether an organization can list applications in the marketplace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canListApps) */ canListApps?: boolean; /** * Indicates whether an organization can list data services in the marketplace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canListData) */ canListData?: boolean; /** * Indicates whether an organization can list pre-provisioned items in the marketplace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canListPreProvisionedItems) */ canListPreProvisionedItems?: boolean; /** * Indicates whether an organization can provision direct purchases in the marketplace without customer request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canProvisionDirectPurchase) */ canProvisionDirectPurchase?: boolean; /** * When `true`, the organization's public items, groups and users are included in search queries. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canSearchPublic) */ canSearchPublic?: boolean; /** * The Bing key can be shared to the public and is returned as part of a portal's description call (`/sharing/rest/portals/`). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canShareBingPublic) */ canShareBingPublic?: boolean; /** * When `true`, members of the organization can share resources outside the organization. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canSharePublic) */ canSharePublic?: boolean; /** * Indicates whether to allow an organization with an enterprise IDP configured to be able to turn on or off the ArcGIS sign in. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canSignInArcGIS) */ canSignInArcGIS?: boolean; /** * Indicates whether to allow an organization with an enterprise IDP configured to be able to turn on or off the enterprise sign in. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canSignInIDP) */ canSignInIDP?: boolean; /** * The query that identifies the group containing the color sets used for rendering in the map viewer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#colorSetsGroupQuery) */ colorSetsGroupQuery?: string; /** * Indicates whether to allow the organization to disable commenting. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#commentsEnabled) */ commentsEnabled?: boolean; /** * Date the organization was created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#created) */ created?: DateProperties; /** * The default locale (language and country) information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#culture) */ culture?: string; /** * The custom base URL for the portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#customBaseUrl) */ customBaseUrl?: string; /** * The default basemap to use for the portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#defaultBasemap) */ defaultBasemap?: BasemapProperties; /** * The default developer basemap to use for the portal when an [apiKey](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#apiKey) is defined. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#defaultDevBasemap) */ defaultDevBasemap?: BasemapProperties; /** * The default extent to use for the portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#defaultExtent) */ defaultExtent?: ExtentProperties; /** * The default vector basemap to use for the portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#defaultVectorBasemap) */ defaultVectorBasemap?: BasemapProperties; /** * A description of the organization/portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#description) */ description?: string; /** * The query that defines the basemaps that should be displayed in the [BasemapGallery](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html) when an [apiKey](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#apiKey) is defined. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#devBasemapGalleryGroupQuery) */ devBasemapGalleryGroupQuery?: string; /** * Boolean value indicating whether to opt-in to the [Esri User Experience Improvement (EUEI) program](https://doc.arcgis.com/en/arcgis-online/reference/faq.htm#ESRI_QUESTIONANSWER_AED97F28DCD84F7682623C2FA9E5CE49). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#eueiEnabled) */ eueiEnabled?: boolean; /** * The featured groups for the portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#featuredGroups) */ featuredGroups?: PortalFeaturedGroups[]; /** * The query that defines the featured group. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#featuredItemsGroupQuery) */ featuredItemsGroupQuery?: string; /** * The query that identifies the group containing features items for the gallery. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#galleryTemplatesGroupQuery) */ galleryTemplatesGroupQuery?: string; /** * Indicates whether the organization has content categories. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#hasCategorySchema) */ hasCategorySchema?: boolean; /** * Helper services provided by the portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#helperServices) */ helperServices?: any; /** * The group that contains featured content to be displayed on the home page. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#homePageFeaturedContent) */ homePageFeaturedContent?: string; /** * The number of featured items that can be displayed on the home page. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#homePageFeaturedContentCount) */ homePageFeaturedContentCount?: number; /** * The port used by the portal for HTTP communication. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#httpPort) */ httpPort?: number; /** * The port used by the portal for HTTPS communication. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#httpsPort) */ httpsPort?: number; /** * The id of the organization that owns this portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#id) */ id?: string; /** * The country code of the calling IP (ArcGIS Online only). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#ipCntryCode) */ ipCntryCode?: string; /** * Indicates if the portal is on-premises. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#isPortal) */ isPortal?: boolean; /** * Indicates if the portal is in read-only mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#isReadOnly) */ isReadOnly?: boolean; /** * The query that identifies the group containing editing templates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#layerTemplatesGroupQuery) */ layerTemplatesGroupQuery?: string; /** * The maximum validity in minutes of tokens issued for users of the organization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#maxTokenExpirationMinutes) */ maxTokenExpirationMinutes?: number; /** * Date the organization was last modified. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#modified) */ modified?: DateProperties; /** * Name of the organization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#name) */ name?: string; /** * URL of the portal host. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#portalHostname) */ portalHostname?: string; /** * The portal mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#portalMode) */ portalMode?: "multitenant" | "singletenant"; /** * Properties specific to the organization, for example the "contact us" link. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#portalProperties) */ portalProperties?: any; /** * The region for the organization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#region) */ region?: string; /** * Custom HTML for the home page. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#rotatorPanels) */ rotatorPanels?: any[]; /** * Indicates whether the description of your organization displays on the home page. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#showHomePageDescription) */ showHomePageDescription?: boolean; /** * The JSON used to create the property values when the `Portal` is loaded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#sourceJSON) */ sourceJSON?: any; /** * Indicates whether hosted services are supported. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#supportsHostedServices) */ supportsHostedServices?: boolean; /** * The query that defines the symbols sets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#symbolSetsGroupQuery) */ symbolSetsGroupQuery?: string; /** * The query that defines the collection of templates that will appear in the template gallery. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#templatesGroupQuery) */ templatesGroupQuery?: string; /** * Sets the units of measure for the organization's users. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#units) */ units?: "english" | "metric"; /** * The URL to the portal instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#url) */ url?: string; /** * The prefix selected by the organization's administrator to be used with the customBaseURL. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#urlKey) */ urlKey?: string; /** * When `false`, 3D basemaps are hidden from the [BasemapGallery](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html), regardless of the type of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#use3dBasemaps) */ use3dBasemaps?: boolean; /** * Information representing a registered user of the portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#user) */ user?: PortalUserProperties; /** * When `true`, only simple where clauses that are compliant with SQL92 can be used when querying layers and tables. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#useStandardizedQuery) */ useStandardizedQuery?: boolean; /** * When `true`, the organization has opted in to use the vector tile basemaps, and (a) [vectorBasemapGalleryGroupQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#vectorBasemapGalleryGroupQuery) should be used instead of [basemapGalleryGroupQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#basemapGalleryGroupQuery), while (b) [defaultVectorBasemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#defaultVectorBasemap) should be used instead of [defaultBasemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#defaultBasemap). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#useVectorBasemaps) */ useVectorBasemaps?: boolean; /** * The query that defines the vector tiles basemaps that should be displayed in the [BasemapGallery](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html) when [useVectorBasemaps](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#useVectorBasemaps) is true. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#vectorBasemapGalleryGroupQuery) */ vectorBasemapGalleryGroupQuery?: string; } export interface PortalFeaturedGroups { /** * Name of the group owner. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#featuredGroups) */ owner: string; /** * Group title. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#featuredGroups) */ title: string; } export interface PortalFetchBasemapsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#fetchBasemaps) */ signal?: AbortSignal; /** * When `true` the basemaps based on [basemapGalleryGroupQuery3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#basemapGalleryGroupQuery3D) are also fetched, if no `basemapGalleryGroupQuery` is passed as an argument. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#fetchBasemaps) */ include3d?: boolean; } export interface PortalFetchCategorySchemaOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#fetchCategorySchema) */ signal?: AbortSignal; } export interface PortalFetchFeaturedGroupsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#fetchFeaturedGroups) */ signal?: AbortSignal; } export interface PortalFetchRegionsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#fetchRegions) */ signal?: AbortSignal; } export interface PortalFetchSettingsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#fetchSettings) */ signal?: AbortSignal; } export interface PortalQueryGroupsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#queryGroups) */ signal?: AbortSignal; } export interface PortalQueryItemsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#queryItems) */ signal?: AbortSignal; } export interface PortalQueryUsersOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#queryUsers) */ signal?: AbortSignal; } export class PortalFolder extends Accessor { /** * The date the folder was created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalFolder.html#created) */ created: Date; /** * The unique id of the folder. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalFolder.html#id) */ id: string; /** * The portal associated with the folder. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalFolder.html#portal) */ portal: Portal; /** * The title of the folder. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalFolder.html#title) */ title: string; /** * The URL to the folder. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalFolder.html#url) */ readonly url: string; /** * Provides information about folders used to organize content in a portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalFolder.html) */ constructor(properties?: PortalFolderProperties); } interface PortalFolderProperties { /** * The date the folder was created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalFolder.html#created) */ created?: DateProperties; /** * The unique id of the folder. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalFolder.html#id) */ id?: string; /** * The portal associated with the folder. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalFolder.html#portal) */ portal?: PortalProperties; /** * The title of the folder. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalFolder.html#title) */ title?: string; } export class PortalGroup extends Accessor { /** * The access privileges on the group which determines who can see and access the group. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#access) */ access: "private" | "org" | "public"; /** * The date the group was created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#created) */ created: Date; /** * A detailed description of the group. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#description) */ description: string; /** * The unique id for the group. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#id) */ id: string; /** * If set to `true`, then users will not be able to apply to join the group. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#isInvitationOnly) */ isInvitationOnly: boolean; /** * The date the group was last modified. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#modified) */ modified: Date; /** * The username of the group's owner. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#owner) */ owner: string; /** * The portal associated with the group. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#portal) */ portal: Portal; /** * A short summary that describes the group. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#snippet) */ snippet: string; /** * The JSON used to create the property values when the `PortalGroup` is created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#sourceJSON) */ sourceJSON: any; /** * User defined tags that describe the group. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#tags) */ tags: string[]; /** * The URL to the thumbnail used for the group. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#thumbnailUrl) */ readonly thumbnailUrl: string; /** * The title of the group. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#title) */ title: string; /** * The URL to the group. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#url) */ readonly url: string; /** * The group resource represents a group within the [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html) */ constructor(properties?: PortalGroupProperties); /** * If present, fetches the group's category schema. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#fetchCategorySchema) */ fetchCategorySchema(options?: PortalGroupFetchCategorySchemaOptions): Promise; /** * Fetches the current members of the group. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#fetchMembers) */ fetchMembers(options?: PortalGroupFetchMembersOptions): Promise; /** * Get the URL to the thumbnail image for the group. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#getThumbnailUrl) */ getThumbnailUrl(width?: number): string; /** * Executes a query against the group to return an array of [PortalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html) objects that match the input query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#queryItems) */ queryItems(queryParams?: PortalQueryParams | PortalQueryParamsProperties, options?: PortalGroupQueryItemsOptions): Promise; } interface PortalGroupProperties { /** * The access privileges on the group which determines who can see and access the group. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#access) */ access?: "private" | "org" | "public"; /** * The date the group was created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#created) */ created?: DateProperties; /** * A detailed description of the group. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#description) */ description?: string; /** * The unique id for the group. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#id) */ id?: string; /** * If set to `true`, then users will not be able to apply to join the group. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#isInvitationOnly) */ isInvitationOnly?: boolean; /** * The date the group was last modified. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#modified) */ modified?: DateProperties; /** * The username of the group's owner. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#owner) */ owner?: string; /** * The portal associated with the group. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#portal) */ portal?: PortalProperties; /** * A short summary that describes the group. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#snippet) */ snippet?: string; /** * The JSON used to create the property values when the `PortalGroup` is created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#sourceJSON) */ sourceJSON?: any; /** * User defined tags that describe the group. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#tags) */ tags?: string[]; /** * The title of the group. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#title) */ title?: string; } export interface PortalGroupFetchCategorySchemaOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#fetchCategorySchema) */ signal?: AbortSignal; } export interface PortalGroupFetchMembersOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#fetchMembers) */ signal?: AbortSignal; } export interface PortalGroupQueryItemsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#queryItems) */ signal?: AbortSignal; } export interface PortalItem extends Accessor, Loadable, JSONSupport { } export class PortalItem { /** * Indicates the level of access to this item: `private`, `shared`, `org`, or `public`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#access) */ access: "private" | "shared" | "org" | "public"; /** * Information on the source of the item and its copyright status. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#accessInformation) */ accessInformation: string; /** * An authorization string used to access the portal item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#apiKey) */ apiKey: string; /** * Contains an array of objects containing proxy information for premium platform services. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#applicationProxies) */ readonly applicationProxies: PortalItemApplicationProxies[]; /** * Average rating. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#avgRating) */ avgRating: number; /** * An array of organization categories that are set on the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#categories) */ categories: string[]; /** * The date the item was created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#created) */ created: Date; /** * The item's locale information (language and country). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#culture) */ culture: string; /** * The detailed description of the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#description) */ description: string; /** * The geographic extent, or bounding rectangle, of the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#extent) */ extent: Extent; /** * An array of group categories set on the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#groupCategories) */ groupCategories: string[]; /** * The unique id for the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#id) */ id: string; /** * Indicates whether a layer can be created from this item using [Layer.fromPortalItem()](esri-layers-Layer.html#fromPortalItem). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#isLayer) */ readonly isLayer: boolean; /** * Indicates whether this item and the user whose credential was used to fetch this item belong to the same ArcGIS Enterprise Portal or ArcGIS Online Organization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#isOrgItem) */ readonly isOrgItem: boolean; /** * Indicates whether an item can be updated and deleted. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#itemControl) */ readonly itemControl: "admin" | "update" | "null"; /** * The URL to the [Item page](https://doc.arcgis.com/en/arcgis-online/manage-data/item-details.htm) on the portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#itemPageUrl) */ readonly itemPageUrl: string; /** * The URL to the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#itemUrl) */ readonly itemUrl: string; /** * Information on license or restrictions related to the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#licenseInfo) */ licenseInfo: string; /** * Indicates whether the item's resources have loaded from the portal. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#loaded) */ readonly loaded: boolean; /** * The date the item was last modified. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#modified) */ modified: Date; /** * The name of the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#name) */ name: string; /** * Number of comments on the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#numComments) */ numComments: number; /** * Number of ratings on the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#numRatings) */ numRatings: number; /** * Number of views on the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#numViews) */ numViews: number; /** * The username of the user who owns this item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#owner) */ owner: string; /** * The ID of the folder in which the owner has stored the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#ownerFolder) */ ownerFolder: string; /** * The portal that contains the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#portal) */ portal: Portal; /** * An array of string URLs. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#screenshots) */ screenshots: string[]; /** * The size of the item (in bytes). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#size) */ size: number; /** * A summary description of the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#snippet) */ snippet: string; /** * The JSON used to create the property values when the `PortalItem` is loaded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#sourceJSON) */ sourceJSON: any; /** * User defined tags that describe the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#tags) */ tags: string[]; /** * The URL to the thumbnail used for the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#thumbnailUrl) */ readonly thumbnailUrl: string; /** * The title for the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#title) */ title: string; /** * The GIS content type of this item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#type) */ type: string; /** * Type keywords that describe the type of content of this item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#typeKeywords) */ typeKeywords: string[]; /** * The service URL of this item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#url) */ url: string; /** * An item (a unit of content) in the Portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html) */ constructor(properties?: PortalItemProperties); /** * Adds a rating to an accessible item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#addRating) */ addRating(rating: number | PortalRating): Promise; /** * Adds a new [resource](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItemResource.html) to the portal item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#addResource) */ addResource(resource: PortalItemResource, content: Blob, options?: PortalItemAddResourceOptions): Promise; /** * Creates a clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#clone) */ clone(): PortalItem; /** * Deletes a rating for the specified item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#deleteRating) */ deleteRating(): Promise; /** * Destroys the portal item, and any associated resources, including its associated [portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#portal). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#destroy) */ destroy(): void; /** * Requests a PortalItem in the format specified in `responseType`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchData) */ fetchData(responseType?: "json" | "xml" | "text" | "blob" | "array-buffer" | "document", options?: PortalItemFetchDataOptions): Promise; /** * Returns the rating (if any) given to the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchRating) */ fetchRating(options?: PortalItemFetchRatingOptions): Promise; /** * Gets all the related items of a certain relationship type for the portal item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchRelatedItems) */ fetchRelatedItems(params: PortalItemFetchRelatedItemsParams, options?: PortalItemFetchRelatedItemsOptions): Promise; /** * Retrieves references to all the [portal item resources](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItemResource.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchResources) */ fetchResources(params?: FetchResourcesParams, options?: PortalItemFetchResourcesOptions): Promise; /** * Get the URL to the thumbnail image for the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#getThumbnailUrl) */ getThumbnailUrl(width?: number): string; /** * Reloads a loaded item's properties from the portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#reload) */ reload(): Promise; /** * Removes all the [resources](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItemResource.html) from the portal item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#removeAllResources) */ removeAllResources(options?: PortalItemRemoveAllResourcesOptions): Promise; /** * Removes a [resource](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItemResource.html) from the portal item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#removeResource) */ removeResource(resource: PortalItemResource, options?: PortalItemRemoveResourceOptions): Promise; /** * Updates the item's properties to the portal, and optionally its data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#update) */ update(params?: PortalItemUpdateParams): Promise; /** * Updates the item's thumbnail on the portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#updateThumbnail) */ updateThumbnail(params: PortalItemUpdateThumbnailParams): Promise; static fromJSON(json: any): PortalItem; } interface PortalItemProperties extends LoadableProperties { /** * Indicates the level of access to this item: `private`, `shared`, `org`, or `public`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#access) */ access?: "private" | "shared" | "org" | "public"; /** * Information on the source of the item and its copyright status. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#accessInformation) */ accessInformation?: string; /** * An authorization string used to access the portal item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#apiKey) */ apiKey?: string; /** * Average rating. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#avgRating) */ avgRating?: number; /** * An array of organization categories that are set on the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#categories) */ categories?: string[]; /** * The date the item was created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#created) */ created?: DateProperties; /** * The item's locale information (language and country). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#culture) */ culture?: string; /** * The detailed description of the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#description) */ description?: string; /** * The geographic extent, or bounding rectangle, of the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#extent) */ extent?: ExtentProperties; /** * An array of group categories set on the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#groupCategories) */ groupCategories?: string[]; /** * The unique id for the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#id) */ id?: string; /** * Information on license or restrictions related to the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#licenseInfo) */ licenseInfo?: string; /** * The date the item was last modified. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#modified) */ modified?: DateProperties; /** * The name of the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#name) */ name?: string; /** * Number of comments on the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#numComments) */ numComments?: number; /** * Number of ratings on the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#numRatings) */ numRatings?: number; /** * Number of views on the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#numViews) */ numViews?: number; /** * The username of the user who owns this item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#owner) */ owner?: string; /** * The ID of the folder in which the owner has stored the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#ownerFolder) */ ownerFolder?: string; /** * The portal that contains the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#portal) */ portal?: PortalProperties; /** * An array of string URLs. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#screenshots) */ screenshots?: string[]; /** * The size of the item (in bytes). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#size) */ size?: number; /** * A summary description of the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#snippet) */ snippet?: string; /** * The JSON used to create the property values when the `PortalItem` is loaded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#sourceJSON) */ sourceJSON?: any; /** * User defined tags that describe the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#tags) */ tags?: string[]; /** * The title for the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#title) */ title?: string; /** * The GIS content type of this item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#type) */ type?: string; /** * Type keywords that describe the type of content of this item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#typeKeywords) */ typeKeywords?: string[]; /** * The service URL of this item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#url) */ url?: string; } /** * A resource reference returned in the result of [fetchResources()](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchResources). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#FetchResource) */ export interface FetchResource { /** * Relative path of the resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#FetchResource) */ resource: PortalItemResource; /** * When the resource was created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#FetchResource) */ created: Date; /** * The size of the resource in bytes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#FetchResource) */ size: number; } /** * Parameters used when fetching portal item resources using [fetchResources()](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchResources). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#FetchResourcesParams) */ export interface FetchResourcesParams { /** * The maximum number of results to be included in the result set response. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#FetchResourcesParams) */ num?: number; /** * The index of the first entry in the result set response. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#FetchResourcesParams) */ start?: number; /** * The order in which to sort the results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#FetchResourcesParams) */ sortOrder?: "asc" | "desc"; /** * A field to sort the results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#FetchResourcesParams) */ sortField?: "created" | "size" | "resource"; } /** * Object returned when [fetchResources()](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchResources) promise resolves. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#FetchResourcesResult) */ export interface FetchResourcesResult { /** * The fetched resources. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#FetchResourcesResult) */ resources: FetchResource[]; /** * The next entry index if the current result set doesn't contain all results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#FetchResourcesResult) */ nextStart: number; /** * The total number of results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#FetchResourcesResult) */ total: number; } export interface PortalItemAddResourceOptions { /** * Indicates the level of access to the resource. * * @default "inherit" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#addResource) */ access?: "inherit" | "private"; /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#addResource) */ signal?: AbortSignal; } export interface PortalItemApplicationProxies { /** * The URL of the premium map service layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#applicationProxies) */ sourceUrl: string; /** * The proxy URL for the source URL. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#applicationProxies) */ proxyUrl: string; /** * The proxy ID registered in ArcGIS Online or ArcGIS Enterprise Portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#applicationProxies) */ proxyId: string; } export interface PortalItemFetchDataOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchData) */ signal?: AbortSignal; } export interface PortalItemFetchRatingOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchRating) */ signal?: AbortSignal; } export interface PortalItemFetchRelatedItemsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchRelatedItems) */ signal?: AbortSignal; } export interface PortalItemFetchRelatedItemsParams { /** * The type of relationship between the two items. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchRelatedItems) */ relationshipType: string; /** * The direction of the relationship. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchRelatedItems) */ direction: "forward" | "reverse"; } export interface PortalItemFetchResourcesOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchResources) */ signal?: AbortSignal; } export interface PortalItemRemoveAllResourcesOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#removeAllResources) */ signal?: AbortSignal; } export interface PortalItemRemoveResourceOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#removeResource) */ signal?: AbortSignal; } export interface PortalItemUpdateParams { /** * **Optional**. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#update) */ data?: string | any; } export interface PortalItemUpdateThumbnailParams { /** * A URL, Data URI, Blob, or File. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#updateThumbnail) */ thumbnail: Blob | string; /** * The file name used for the thumbnail in [thumbnailUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#thumbnailUrl). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#updateThumbnail) */ filename?: string; } export class PortalItemResource extends Accessor { /** * Path of the resource relative to `{ITEM}/resources/`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItemResource.html#path) */ path: string; /** * The [portal item](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html) that owns the resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItemResource.html#portalItem) */ portalItem: PortalItem; /** * The absolute url to the item resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItemResource.html#url) */ readonly url: string; /** * A reference to a portal item resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItemResource.html) */ constructor(properties?: PortalItemResourceProperties); /** * Requests the PortalItemResource data in the format specified for the `responseType`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItemResource.html#fetch) */ fetch(responseType?: "json" | "xml" | "text" | "blob" | "array-buffer" | "document", options?: PortalItemResourceFetchOptions): Promise; /** * Updates an existing resource with new content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItemResource.html#update) */ update(content: Blob, options?: PortalItemResourceUpdateOptions): Promise; } interface PortalItemResourceProperties { /** * Path of the resource relative to `{ITEM}/resources/`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItemResource.html#path) */ path?: string; /** * The [portal item](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html) that owns the resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItemResource.html#portalItem) */ portalItem?: PortalItemProperties; } export interface PortalItemResourceFetchOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItemResource.html#fetch) */ signal?: AbortSignal; } export interface PortalItemResourceUpdateOptions { /** * Indicates the level of access to the resource. * * @default "inherit" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItemResource.html#update) */ access?: "inherit" | "private"; /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItemResource.html#update) */ signal?: AbortSignal; } export class PortalQueryParams extends Accessor { /** * An array of categories stored within the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#categories) */ categories: (string | string[])[]; /** * Only relevant when querying for [PortalItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#extent) */ extent: Extent; /** * Structured filter to use instead of the [query](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#query) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#filter) */ filter: string; /** * The maximum number of results to be included in the [result](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryResult.html#results) set response. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#num) */ num: number; /** * The query string used for the search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#query) */ query: string; /** * A comma-delimited list of fields to sort. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#sortField) */ sortField: | "title" | "uploaded" | "modified" | "username" | "created" | "type" | "owner" | "avg-rating" | "num-ratings" | "num-comments" | "num-views"; /** * The order in which to sort the results. * * @default asc * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#sortOrder) */ sortOrder: "asc" | "desc"; /** * The index of the first entry in the result set response. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#start) */ start: number; /** * The parameters used to perform a query for Items, Groups, and Users within a [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html) */ constructor(properties?: PortalQueryParamsProperties); /** * Creates a deep clone of the instance of PortalQueryParams that calls this method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#clone) */ clone(): PortalQueryParams; } interface PortalQueryParamsProperties { /** * An array of categories stored within the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#categories) */ categories?: (string | string[])[]; /** * Only relevant when querying for [PortalItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#extent) */ extent?: ExtentProperties; /** * Structured filter to use instead of the [query](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#query) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#filter) */ filter?: string; /** * The maximum number of results to be included in the [result](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryResult.html#results) set response. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#num) */ num?: number; /** * The query string used for the search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#query) */ query?: string; /** * A comma-delimited list of fields to sort. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#sortField) */ sortField?: | "title" | "uploaded" | "modified" | "username" | "created" | "type" | "owner" | "avg-rating" | "num-ratings" | "num-comments" | "num-views"; /** * The order in which to sort the results. * * @default asc * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#sortOrder) */ sortOrder?: "asc" | "desc"; /** * The index of the first entry in the result set response. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#start) */ start?: number; } export class PortalQueryResult extends Accessor { /** * The query parameters for the next set of results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryResult.html#nextQueryParams) */ nextQueryParams: PortalQueryParams; /** * The query parameters for the first set of results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryResult.html#queryParams) */ queryParams: PortalQueryParams; /** * An array of result item objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryResult.html#results) */ results: any[]; /** * The total number of results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryResult.html#total) */ total: number; /** * Represents the result object returned from a portal query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryResult.html) */ constructor(properties?: PortalQueryResultProperties); } interface PortalQueryResultProperties { /** * The query parameters for the next set of results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryResult.html#nextQueryParams) */ nextQueryParams?: PortalQueryParamsProperties; /** * The query parameters for the first set of results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryResult.html#queryParams) */ queryParams?: PortalQueryParamsProperties; /** * An array of result item objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryResult.html#results) */ results?: any[]; /** * The total number of results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryResult.html#total) */ total?: number; } export class PortalRating extends Accessor { /** * Date the rating was added to the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalRating.html#created) */ created: Date; /** * A rating between 1.0 and 5.0 for the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalRating.html#rating) */ rating: number; /** * PortalRating provides details about the rating associated with a [Portal item](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalRating.html) */ constructor(properties?: PortalRatingProperties); } interface PortalRatingProperties { /** * Date the rating was added to the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalRating.html#created) */ created?: DateProperties; /** * A rating between 1.0 and 5.0 for the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalRating.html#rating) */ rating?: number; } export class PortalUser extends Accessor { /** * Indicates the level of access of the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#access) */ access: "private" | "org" | "public"; /** * The date the user was created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#created) */ created: Date; /** * The culture information for the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#culture) */ culture: string; /** * A description of the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#description) */ description: string; /** * The user's e-mail address. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#email) */ email: string; /** * The user's full name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#fullName) */ fullName: string; /** * The date the user was last modified. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#modified) */ modified: Date; /** * The ID of the organization the user belongs to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#orgId) */ orgId: string; /** * The portal associated with the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#portal) */ portal: Portal; /** * The user's preferred view for content, either web or GIS. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#preferredView) */ preferredView: string; /** * The user's privileges based on their user type or role in their organization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#privileges) */ privileges: string[]; /** * The user preferred region, used to set the featured maps on the home page, content in the gallery, and the default extent of new maps in the Viewer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#region) */ region: string; /** * Defines the user's role in the organization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#role) */ role: "org_admin" | "org_publisher" | "org_user"; /** * The ID of the user's role. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#roleId) */ roleId: string; /** * The JSON used to create the property values when the `PortalUser` is created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#sourceJSON) */ sourceJSON: any; /** * The URL to the thumbnail image for the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#thumbnailUrl) */ readonly thumbnailUrl: string; /** * The user's personal units of measure setting. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#units) */ units: "english" | "metric"; /** * The URL for the user's content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#userContentUrl) */ readonly userContentUrl: string; /** * The username of the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#username) */ username: string; /** * Represents a registered user of the [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html) */ constructor(properties?: PortalUserProperties); /** * Adds an item to the user's portal content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#addItem) */ addItem(params: PortalUserAddItemParams): Promise; /** * Deletes an item from the user's portal content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#deleteItem) */ deleteItem(item: PortalItem): Promise; /** * Deletes items from the user's portal content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#deleteItems) */ deleteItems(items: PortalItem[]): Promise; /** * Fetches all of the user's folders used to organize portal content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#fetchFolders) */ fetchFolders(): Promise; /** * Fetches all the groups that the portal user has permission to access. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#fetchGroups) */ fetchGroups(): Promise; /** * Retrieves all the items in the specified folder. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#fetchItems) */ fetchItems(params?: PortalUserFetchItemsParams): Promise; /** * Fetches the tag objects that have been created by the portal user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#fetchTags) */ fetchTags(): Promise; /** * Get the URL to the thumbnail image for the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#getThumbnailUrl) */ getThumbnailUrl(width?: number): string; /** * Executes a query against the user's favorite group to return an array of [PortalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html) objects that match the input query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#queryFavorites) */ queryFavorites(queryParams?: PortalQueryParams): Promise; } interface PortalUserProperties { /** * Indicates the level of access of the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#access) */ access?: "private" | "org" | "public"; /** * The date the user was created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#created) */ created?: DateProperties; /** * The culture information for the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#culture) */ culture?: string; /** * A description of the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#description) */ description?: string; /** * The user's e-mail address. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#email) */ email?: string; /** * The user's full name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#fullName) */ fullName?: string; /** * The date the user was last modified. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#modified) */ modified?: DateProperties; /** * The ID of the organization the user belongs to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#orgId) */ orgId?: string; /** * The portal associated with the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#portal) */ portal?: PortalProperties; /** * The user's preferred view for content, either web or GIS. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#preferredView) */ preferredView?: string; /** * The user's privileges based on their user type or role in their organization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#privileges) */ privileges?: string[]; /** * The user preferred region, used to set the featured maps on the home page, content in the gallery, and the default extent of new maps in the Viewer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#region) */ region?: string; /** * Defines the user's role in the organization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#role) */ role?: "org_admin" | "org_publisher" | "org_user"; /** * The ID of the user's role. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#roleId) */ roleId?: string; /** * The JSON used to create the property values when the `PortalUser` is created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#sourceJSON) */ sourceJSON?: any; /** * The user's personal units of measure setting. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#units) */ units?: "english" | "metric"; /** * The username of the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#username) */ username?: string; } export interface PortalUserAddItemParams { /** * The item to add to the user's content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#addItem) */ item: PortalItem; /** * The component used to stream the data represented by the item to the client. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#addItem) */ data?: string | any; /** * The portal folder in which to store the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#addItem) */ folder?: string | PortalFolder; } export interface PortalUserFetchItemsParams { /** * The folder to retrieve items from. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#fetchItems) */ folder?: PortalFolder; /** * The maximum number of results to be included in the result set response. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#fetchItems) */ num?: number; /** * A comma-delimited list of fields to sort by. * * @default created * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#fetchItems) */ sortField?: string; /** * The order in which to sort the results. * * @default asc * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#fetchItems) */ sortOrder?: string; /** * The index of the first entry in the result set response. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#fetchItems) */ start?: number; } /** * A convenience module for importing renderer classes that can be used to render [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html) when developing with [TypeScript](https://developers.arcgis.com/javascript/latest/typescript-setup/). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html) */ namespace rasterRenderers { /** * FlowRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#FlowRenderer) */ export type FlowRenderer = __esri.FlowRenderer; export const FlowRenderer: typeof __esri.FlowRenderer; /** * ClassBreaksRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#ClassBreaksRenderer) */ export type ClassBreaksRenderer = __esri.ClassBreaksRenderer; export const ClassBreaksRenderer: typeof __esri.ClassBreaksRenderer; /** * UniqueValueRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#UniqueValueRenderer) */ export type UniqueValueRenderer = __esri.UniqueValueRenderer; export const UniqueValueRenderer: typeof __esri.UniqueValueRenderer; /** * RasterColormapRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#RasterColormapRenderer) */ export type RasterColormapRenderer = __esri.RasterColormapRenderer; export const RasterColormapRenderer: typeof __esri.RasterColormapRenderer; /** * RasterStretchRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#RasterStretchRenderer) */ export type RasterStretchRenderer = __esri.RasterStretchRenderer; export const RasterStretchRenderer: typeof __esri.RasterStretchRenderer; /** * VectorFieldRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#VectorFieldRenderer) */ export type VectorFieldRenderer = __esri.VectorFieldRenderer; export const VectorFieldRenderer: typeof __esri.VectorFieldRenderer; /** * RasterShadedReliefRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#RasterShadedReliefRenderer) */ export type RasterShadedReliefRenderer = __esri.RasterShadedReliefRenderer; export const RasterShadedReliefRenderer: typeof __esri.RasterShadedReliefRenderer; } /** * ClassBreaksRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#ClassBreaksRenderer) */ export type rasterRenderersClassBreaksRenderer = ClassBreaksRenderer; /** * FlowRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#FlowRenderer) */ export type rasterRenderersFlowRenderer = FlowRenderer; /** * RasterColormapRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#RasterColormapRenderer) */ export type rasterRenderersRasterColormapRenderer = RasterColormapRenderer; /** * RasterShadedReliefRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#RasterShadedReliefRenderer) */ export type rasterRenderersRasterShadedReliefRenderer = RasterShadedReliefRenderer; /** * RasterStretchRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#RasterStretchRenderer) */ export type rasterRenderersRasterStretchRenderer = RasterStretchRenderer; /** * UniqueValueRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#UniqueValueRenderer) */ export type rasterRenderersUniqueValueRenderer = UniqueValueRenderer; /** * VectorFieldRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#VectorFieldRenderer) */ export type rasterRenderersVectorFieldRenderer = VectorFieldRenderer; /** * A convenience module for importing [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) classes when developing with [TypeScript](https://developers.arcgis.com/javascript/latest/typescript-setup/). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers.html) */ namespace renderers { /** * DictionaryRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers.html#DictionaryRenderer) */ export type DictionaryRenderer = __esri.DictionaryRenderer; export const DictionaryRenderer: typeof __esri.DictionaryRenderer; /** * SimpleRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers.html#SimpleRenderer) */ export type SimpleRenderer = __esri.SimpleRenderer; export const SimpleRenderer: typeof __esri.SimpleRenderer; /** * ClassBreaksRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers.html#ClassBreaksRenderer) */ export type ClassBreaksRenderer = __esri.ClassBreaksRenderer; export const ClassBreaksRenderer: typeof __esri.ClassBreaksRenderer; /** * UniqueValueRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers.html#UniqueValueRenderer) */ export type UniqueValueRenderer = __esri.UniqueValueRenderer; export const UniqueValueRenderer: typeof __esri.UniqueValueRenderer; /** * DotDensityRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers.html#DotDensityRenderer) */ export type DotDensityRenderer = __esri.DotDensityRenderer; export const DotDensityRenderer: typeof __esri.DotDensityRenderer; /** * PieChartRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers.html#PieChartRenderer) */ export type PieChartRenderer = __esri.PieChartRenderer; export const PieChartRenderer: typeof __esri.PieChartRenderer; /** * RendererWithVisualVariables. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers.html#RendererWithVisualVariables) */ export type RendererWithVisualVariables = | __esri.SimpleRenderer | __esri.ClassBreaksRenderer | __esri.UniqueValueRenderer | __esri.DotDensityRenderer | __esri.DictionaryRenderer | __esri.PieChartRenderer; /** * HeatmapRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers.html#HeatmapRenderer) */ export type HeatmapRenderer = __esri.HeatmapRenderer; export const HeatmapRenderer: typeof __esri.HeatmapRenderer; /** * Renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers.html#Renderer) */ export type Renderer = __esri.HeatmapRenderer | __esri.RendererWithVisualVariables; } export interface ClassBreaksRenderer extends Renderer, VisualVariablesMixin { } export class ClassBreaksRenderer { /** * When symbolizing polygon features with graduated symbols, set a [FillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol.html) on this property to visualize the boundaries of each feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#backgroundFillSymbol) */ backgroundFillSymbol: FillSymbol | PolygonSymbol3D; /** * Each element in the array is an object that provides information about a class break associated with the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos) */ classBreakInfos: ClassBreakInfo[]; /** * Label used in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) to describe features assigned the [default symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#defaultSymbol). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#defaultLabel) */ defaultLabel: string; /** * The default symbol assigned to features with a value not matched to a given break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#defaultSymbol) */ defaultSymbol: Symbol; /** * The name of a numeric attribute field whose data determines the symbol of each feature based on the class breaks defined in [classBreakInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#field) */ field: string; /** * An object providing options for displaying the renderer in the Legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#legendOptions) */ legendOptions: ClassBreaksRendererLegendOptions; /** * When [normalizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationType) is `field`, this property contains the attribute field name used for normalization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationField) */ normalizationField: string; /** * When [normalizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationType) is `percent-of-total`, this property contains the total of all data values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationTotal) */ normalizationTotal: number; /** * Indicates how the data is normalized. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationType) */ normalizationType: "field" | "log" | "percent-of-total"; /** * The type of renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#type) */ readonly type: "class-breaks"; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#valueExpression) */ valueExpression: string; /** * The title identifying and describing the associated [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression as defined in the [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#valueExpression) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#valueExpressionTitle) */ valueExpressionTitle: string; /** * ClassBreaksRenderer defines the symbol of each feature in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) based on the value of a numeric attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html) */ constructor(properties?: ClassBreaksRendererProperties); /** * Adds a class break to the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#addClassBreakInfo) */ addClassBreakInfo(min: number | any, max?: number, symbol?: Symbol): void; /** * Creates a deep clone of the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#clone) */ clone(): ClassBreaksRenderer; /** * Returns the [classBreakInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos) information (as defined by the renderer) associated with the given graphic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#getClassBreakInfo) */ getClassBreakInfo(graphic: Graphic): Promise; /** * Removes a break from the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#removeClassBreakInfo) */ removeClassBreakInfo(min: number, max: number): void; static fromJSON(json: any): ClassBreaksRenderer; } interface ClassBreaksRendererProperties extends RendererProperties, VisualVariablesMixinProperties { /** * When symbolizing polygon features with graduated symbols, set a [FillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol.html) on this property to visualize the boundaries of each feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#backgroundFillSymbol) */ backgroundFillSymbol?: FillSymbolProperties | (PolygonSymbol3DProperties & { type: "polygon-3d" }); /** * Each element in the array is an object that provides information about a class break associated with the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos) */ classBreakInfos?: ClassBreakInfoProperties[]; /** * Label used in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) to describe features assigned the [default symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#defaultSymbol). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#defaultLabel) */ defaultLabel?: string; /** * The default symbol assigned to features with a value not matched to a given break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#defaultSymbol) */ defaultSymbol?: SymbolProperties; /** * The name of a numeric attribute field whose data determines the symbol of each feature based on the class breaks defined in [classBreakInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#field) */ field?: string; /** * An object providing options for displaying the renderer in the Legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#legendOptions) */ legendOptions?: ClassBreaksRendererLegendOptions; /** * When [normalizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationType) is `field`, this property contains the attribute field name used for normalization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationField) */ normalizationField?: string; /** * When [normalizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationType) is `percent-of-total`, this property contains the total of all data values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationTotal) */ normalizationTotal?: number; /** * Indicates how the data is normalized. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationType) */ normalizationType?: "field" | "log" | "percent-of-total"; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#valueExpression) */ valueExpression?: string; /** * The title identifying and describing the associated [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression as defined in the [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#valueExpression) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#valueExpressionTitle) */ valueExpressionTitle?: string; } export interface ClassBreaksRendererLegendOptions { /** * Describes the variable driving the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#legendOptions) */ title: string; } export interface DictionaryRenderer extends Renderer, VisualVariablesMixin { } export class DictionaryRenderer { /** * This property allows you to set display options that can be configured on the dictionary symbol style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DictionaryRenderer.html#config) */ config: any; /** * Defines a field mapping that maps input fields from the feature to the dictionary symbol style's expected fields for symbols and text. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DictionaryRenderer.html#fieldMap) */ fieldMap: HashMap; /** * A scaling expression can be set to increase or decrease the size of the dictionary symbols. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DictionaryRenderer.html#scaleExpression) */ scaleExpression: string; /** * The title identifying and describing the associated [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression as defined in the [scaleExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DictionaryRenderer.html#scaleExpression) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DictionaryRenderer.html#scaleExpressionTitle) */ scaleExpressionTitle: string; /** * The type of renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DictionaryRenderer.html#type) */ type: "dictionary"; /** * The URL to the dictionary style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DictionaryRenderer.html#url) */ url: string; /** * Dictionary Renderer is used to symbolize layers using a dictionary of [CIMSymbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html) configured with multiple attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DictionaryRenderer.html) */ constructor(properties?: DictionaryRendererProperties); /** * Creates a deep clone of the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DictionaryRenderer.html#clone) */ clone(): DictionaryRenderer; /** * This method will return the symbol for a given graphic using the dictionary renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DictionaryRenderer.html#getSymbolAsync) */ getSymbolAsync(graphic: Graphic): Promise; static fromJSON(json: any): DictionaryRenderer; } interface DictionaryRendererProperties extends RendererProperties, VisualVariablesMixinProperties { /** * This property allows you to set display options that can be configured on the dictionary symbol style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DictionaryRenderer.html#config) */ config?: any; /** * Defines a field mapping that maps input fields from the feature to the dictionary symbol style's expected fields for symbols and text. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DictionaryRenderer.html#fieldMap) */ fieldMap?: HashMap; /** * A scaling expression can be set to increase or decrease the size of the dictionary symbols. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DictionaryRenderer.html#scaleExpression) */ scaleExpression?: string; /** * The title identifying and describing the associated [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression as defined in the [scaleExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DictionaryRenderer.html#scaleExpression) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DictionaryRenderer.html#scaleExpressionTitle) */ scaleExpressionTitle?: string; /** * The type of renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DictionaryRenderer.html#type) */ type?: "dictionary"; /** * The URL to the dictionary style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DictionaryRenderer.html#url) */ url?: string; } export class DotDensityRenderer extends Renderer { /** * Defines the variable(s) used to visualize density. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#attributes) */ attributes: AttributeColorInfo[]; /** * The color used to shade the polygon fill behind the dots. * * @default [0, 0, 0, 0.25] - black, semitransparent * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#backgroundColor) */ backgroundColor: Color; /** * Only applicable when two or more [attributes](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#attributes) are specified. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#dotBlendingEnabled) */ dotBlendingEnabled: boolean; /** * Defines the size of the dots in points. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#dotSize) */ dotSize: number; /** * Defines the initial dot value used for visualizing density. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#dotValue) */ dotValue: number; /** * An object providing options for configuring the renderer in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#legendOptions) */ legendOptions: DotDensityRendererLegendOptions; /** * The outline of the polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#outline) */ outline: SimpleLineSymbol; /** * When defined, the renderer will recalculate the dot value linearly based on the change in the view's scale using the [calculateDotValue()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#calculateDotValue) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#referenceScale) */ referenceScale: number; /** * When set to a consistent value, dot placements will be preserved for the same scale given all parameters are the same in the renderer. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#seed) */ seed: number; /** * The type of renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#type) */ readonly type: "dot-density"; /** * An array of [Size Visual Variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#visualVariables) */ visualVariables: VisualVariable[]; /** * DotDensityRenderer allows you to create dot density visualizations for polygon layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html) */ constructor(properties?: DotDensityRendererProperties); /** * Calculates an updated dot value for the given scale for the cases where a [referenceScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#referenceScale) is provided. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#calculateDotValue) */ calculateDotValue(scale: number): number; /** * Creates a deep clone of the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#clone) */ clone(): DotDensityRenderer; static fromJSON(json: any): DotDensityRenderer; } interface DotDensityRendererProperties extends RendererProperties { /** * Defines the variable(s) used to visualize density. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#attributes) */ attributes?: AttributeColorInfoProperties[]; /** * The color used to shade the polygon fill behind the dots. * * @default [0, 0, 0, 0.25] - black, semitransparent * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#backgroundColor) */ backgroundColor?: Color | number[] | string; /** * Only applicable when two or more [attributes](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#attributes) are specified. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#dotBlendingEnabled) */ dotBlendingEnabled?: boolean; /** * Defines the size of the dots in points. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#dotSize) */ dotSize?: number; /** * Defines the initial dot value used for visualizing density. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#dotValue) */ dotValue?: number; /** * An object providing options for configuring the renderer in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#legendOptions) */ legendOptions?: DotDensityRendererLegendOptions; /** * The outline of the polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#outline) */ outline?: SimpleLineSymbolProperties; /** * When defined, the renderer will recalculate the dot value linearly based on the change in the view's scale using the [calculateDotValue()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#calculateDotValue) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#referenceScale) */ referenceScale?: number; /** * When set to a consistent value, dot placements will be preserved for the same scale given all parameters are the same in the renderer. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#seed) */ seed?: number; /** * An array of [Size Visual Variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#visualVariables) */ visualVariables?: VisualVariableProperties[]; } export interface DotDensityRendererLegendOptions { /** * Indicates the unit of the data being visualized. * * [Read more...](global.html#unit) */ unit?: string; } export interface FlowRenderer extends Accessor, JSONSupport { } export class FlowRenderer { /** * Contains metadata about renderers generated from the [flowRendererCreator.createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#createRenderer) method, including information for setting UI elements such as sliders and themes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#authoringInfo) */ authoringInfo: AuthoringInfo; /** * The color of the animated streamlines. * * @default [255, 255, 255, 1] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#color) */ color: Color; /** * The density of the streamlines. * * @default 0.8 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#density) */ density: number; /** * Defines the flow direction of the data. * * @default "flow-from" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#flowRepresentation) */ flowRepresentation: "flow-from" | "flow-to"; /** * The speed of the animated streamlines, relative to the simulation time. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#flowSpeed) */ flowSpeed: number; /** * An object providing options for displaying the renderer in the Legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#legendOptions) */ legendOptions: FlowRendererLegendOptions; /** * The maximum path length streamlines will travel in points. * * @default 200 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#maxPathLength) */ maxPathLength: number; /** * The front cap of the streamline. * * @default "butt" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#trailCap) */ trailCap: "butt" | "round"; /** * The approximate visible length of the streamline in points. * * @default 100 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#trailLength) */ trailLength: number; /** * The width of the streamline trail in points. * * @default 1.5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#trailWidth) */ trailWidth: number; /** * The type of Renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#type) */ readonly type: "flow"; /** * An array of [VisualVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html) objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#visualVariables) */ visualVariables: VisualVariable[]; /** * The FlowRenderer allows you to visualize your raster data with animated streamlines. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html) */ constructor(properties?: FlowRendererProperties); /** * Creates a deep clone of the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#clone) */ clone(): FlowRenderer; static fromJSON(json: any): FlowRenderer; } interface FlowRendererProperties { /** * Contains metadata about renderers generated from the [flowRendererCreator.createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#createRenderer) method, including information for setting UI elements such as sliders and themes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#authoringInfo) */ authoringInfo?: AuthoringInfoProperties; /** * The color of the animated streamlines. * * @default [255, 255, 255, 1] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#color) */ color?: Color; /** * The density of the streamlines. * * @default 0.8 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#density) */ density?: number; /** * Defines the flow direction of the data. * * @default "flow-from" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#flowRepresentation) */ flowRepresentation?: "flow-from" | "flow-to"; /** * The speed of the animated streamlines, relative to the simulation time. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#flowSpeed) */ flowSpeed?: number; /** * An object providing options for displaying the renderer in the Legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#legendOptions) */ legendOptions?: FlowRendererLegendOptions; /** * The maximum path length streamlines will travel in points. * * @default 200 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#maxPathLength) */ maxPathLength?: number | string; /** * The front cap of the streamline. * * @default "butt" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#trailCap) */ trailCap?: "butt" | "round"; /** * The approximate visible length of the streamline in points. * * @default 100 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#trailLength) */ trailLength?: number; /** * The width of the streamline trail in points. * * @default 1.5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#trailWidth) */ trailWidth?: number | string; /** * An array of [VisualVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html) objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#visualVariables) */ visualVariables?: VisualVariableProperties[]; } export interface FlowRendererLegendOptions { /** * Describes the variable driving the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#legendOptions) */ title?: string; } export class HeatmapRenderer extends Renderer { /** * An array of objects describing the renderer's color ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#colorStops) */ colorStops: HeatmapColorStop[]; /** * The name of the attribute field used to weight the density of each heatmap point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#field) */ field: string; /** * An object providing options for describing the renderer in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#legendOptions) */ legendOptions: HeatmapRendererLegendOptions; /** * The max density value to be assigned a color in the heatmap surface. * * @default 0.04 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#maxDensity) */ maxDensity: number; /** * The minimum density value to be assigned a color in the heatmap surface. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#minDensity) */ minDensity: number; /** * The search radius (in points) used to create a smooth kernel surface fitted around each point. * * @default 18 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#radius) */ radius: number; /** * When set, the heatmap's visualization at the given scale will remain static and not change as the user zooms in and out of the view. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#referenceScale) */ referenceScale: number; /** * The type of renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#type) */ readonly type: "heatmap"; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#valueExpression) */ valueExpression: string; /** * The title identifying and describing the [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression as defined in the [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#valueExpression) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#valueExpressionTitle) */ valueExpressionTitle: string; /** * The HeatmapRenderer uses [kernel density](https://pro.arcgis.com/en/pro-app/2.8/tool-reference/spatial-analyst/how-kernel-density-works.htm) to render point features in [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [CSVLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html), [GeoJSONLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html) and [OGCFeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html) as a raster surface. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html) */ constructor(properties?: HeatmapRendererProperties); /** * Creates a deep clone of the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#clone) */ clone(): HeatmapRenderer; static fromJSON(json: any): HeatmapRenderer; } interface HeatmapRendererProperties extends RendererProperties { /** * An array of objects describing the renderer's color ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#colorStops) */ colorStops?: HeatmapColorStopProperties[]; /** * The name of the attribute field used to weight the density of each heatmap point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#field) */ field?: string; /** * An object providing options for describing the renderer in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#legendOptions) */ legendOptions?: HeatmapRendererLegendOptions; /** * The max density value to be assigned a color in the heatmap surface. * * @default 0.04 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#maxDensity) */ maxDensity?: number; /** * The minimum density value to be assigned a color in the heatmap surface. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#minDensity) */ minDensity?: number; /** * The search radius (in points) used to create a smooth kernel surface fitted around each point. * * @default 18 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#radius) */ radius?: number | string; /** * When set, the heatmap's visualization at the given scale will remain static and not change as the user zooms in and out of the view. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#referenceScale) */ referenceScale?: number; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#valueExpression) */ valueExpression?: string; /** * The title identifying and describing the [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression as defined in the [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#valueExpression) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#valueExpressionTitle) */ valueExpressionTitle?: string; } export interface HeatmapRendererLegendOptions { /** * The label used to describe low density areas in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#legendOptions) */ minLabel?: string; /** * The label used to describe max density areas in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#legendOptions) */ maxLabel?: string; /** * Describes the variable driving the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#legendOptions) */ title?: string; } export class VisualVariablesMixin { /** * An array of [VisualVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html) objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-mixins-VisualVariablesMixin.html#visualVariables) */ visualVariables: VisualVariable[]; } interface VisualVariablesMixinProperties { /** * An array of [VisualVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html) objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-mixins-VisualVariablesMixin.html#visualVariables) */ visualVariables?: VisualVariableProperties[]; } export class PieChartRenderer extends Renderer { /** * Defines the variable(s) to include in the pie charts. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#attributes) */ attributes: AttributeColorInfo[]; /** * The symbol used to render polygons behind the pie symbols. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#backgroundFillSymbol) */ backgroundFillSymbol: SimpleFillSymbol; /** * The color used to visualize features whose [attributes](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#attributes) all have null or empty values. * * @default new Color([0, 0, 0, 0]) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#defaultColor) */ defaultColor: Color; /** * Describes the [defaultColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#defaultColor) in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#defaultLabel) */ defaultLabel: string; /** * Use this property to create a donut chart. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#holePercentage) */ holePercentage: number; /** * An object providing options for describing the renderer in the Legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#legendOptions) */ legendOptions: PieChartRendererLegendOptions; /** * Defines the rules for how to aggregate small categories to a generic "others" category. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#othersCategory) */ othersCategory: PieChartRendererOthersCategory; /** * Defines the outline of the pie chart. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#outline) */ outline: SimpleLineSymbol; /** * Defines the size of each pie chart in points. * * @default 12 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#size) */ size: number; /** * The type of renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#type) */ readonly type: "pie-chart"; /** * An array of [Size Visual Variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#visualVariables) */ visualVariables: SizeVariable[]; /** * PieChartRenderer allows you to create a pie chart for each feature in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html) */ constructor(properties?: PieChartRendererProperties); /** * Creates a deep clone of the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#clone) */ clone(): PieChartRenderer; static fromJSON(json: any): PieChartRenderer; } interface PieChartRendererProperties extends RendererProperties { /** * Defines the variable(s) to include in the pie charts. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#attributes) */ attributes?: AttributeColorInfoProperties[]; /** * The symbol used to render polygons behind the pie symbols. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#backgroundFillSymbol) */ backgroundFillSymbol?: SimpleFillSymbolProperties; /** * The color used to visualize features whose [attributes](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#attributes) all have null or empty values. * * @default new Color([0, 0, 0, 0]) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#defaultColor) */ defaultColor?: Color; /** * Describes the [defaultColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#defaultColor) in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#defaultLabel) */ defaultLabel?: string; /** * Use this property to create a donut chart. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#holePercentage) */ holePercentage?: number; /** * An object providing options for describing the renderer in the Legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#legendOptions) */ legendOptions?: PieChartRendererLegendOptions; /** * Defines the rules for how to aggregate small categories to a generic "others" category. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#othersCategory) */ othersCategory?: PieChartRendererOthersCategory; /** * Defines the outline of the pie chart. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#outline) */ outline?: SimpleLineSymbolProperties; /** * Defines the size of each pie chart in points. * * @default 12 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#size) */ size?: number | string; /** * An array of [Size Visual Variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#visualVariables) */ visualVariables?: SizeVariableProperties[]; } export interface PieChartRendererLegendOptions { /** * Describes the data used by the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#legendOptions) */ title?: string; } export interface PieChartRendererOthersCategory { /** * Defines the color used to represent all categories whose pie slices are smaller than the percentage defined by `threshold`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#othersCategory) */ color?: Color; /** * Describes the `color` grouping categories smaller than the `threshold` in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](global.html) */ label?: string; /** * Represents the minimum size of individual slices as a percentage of the entire pie. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#othersCategory) */ threshold?: number; } export class PointCloudClassBreaksRenderer extends PointCloudRenderer { /** * Each element in the array is an object that provides information about a class break associated with the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#colorClassBreakInfos) */ colorClassBreakInfos: PointCloudClassBreaksRendererColorClassBreakInfos[]; /** * The name of the field that is used to drive the color visualization for the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#field) */ field: string; /** * A transform that is applied to the field value before evaluating the renderer. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#fieldTransformType) */ fieldTransformType: "none" | "low-four-bit" | "high-four-bit" | "absolute-value" | "modulo-ten"; /** * An object providing options for displaying the renderer in the Legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#legendOptions) */ legendOptions: PointCloudClassBreaksRendererLegendOptions; /** * The type of renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#type) */ readonly type: "point-cloud-class-breaks"; /** * This class defines the color of each point in a [PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html) based on the value of a numeric attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html) */ constructor(properties?: PointCloudClassBreaksRendererProperties); /** * Creates a deep clone of the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#clone) */ clone(): PointCloudClassBreaksRenderer; static fromJSON(json: any): PointCloudClassBreaksRenderer; } interface PointCloudClassBreaksRendererProperties extends PointCloudRendererProperties { /** * Each element in the array is an object that provides information about a class break associated with the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#colorClassBreakInfos) */ colorClassBreakInfos?: PointCloudClassBreaksRendererColorClassBreakInfos[]; /** * The name of the field that is used to drive the color visualization for the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#field) */ field?: string; /** * A transform that is applied to the field value before evaluating the renderer. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#fieldTransformType) */ fieldTransformType?: "none" | "low-four-bit" | "high-four-bit" | "absolute-value" | "modulo-ten"; /** * An object providing options for displaying the renderer in the Legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#legendOptions) */ legendOptions?: PointCloudClassBreaksRendererLegendOptions; } export interface PointCloudClassBreaksRendererColorClassBreakInfos { /** * The minimum value of the break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#colorClassBreakInfos) */ minValue: number; /** * The maximum value of the break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#colorClassBreakInfos) */ maxValue: number; /** * The color used to colorize the points where values are between the `minValue` and `maxValue` of the break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#colorClassBreakInfos) */ color: Color; /** * The label used to describe point in the break. * * [Read more...](global.html) */ label?: string; } export interface PointCloudClassBreaksRendererLegendOptions { /** * Describes the variable driving the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#legendOptions) */ title?: string; } export interface PointCloudRenderer extends Accessor, JSONSupport { } export class PointCloudRenderer { /** * Reduces the brightness of the point's color, based on the value of another field, usually `intensity`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#colorModulation) */ colorModulation: PointCloudRendererColorModulation; /** * Specifies how the size of the points in the point cloud is computed for rendering. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#pointSizeAlgorithm) */ pointSizeAlgorithm: PointCloudRendererPointSizeAlgorithm; /** * The number of points to draw per display inch. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#pointsPerInch) */ pointsPerInch: number; /** * The point cloud renderer type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#type) */ readonly type: "point-cloud-class-breaks" | "point-cloud-rgb" | "point-cloud-stretch" | "point-cloud-unique-value"; /** * A PointCloudRenderer allows you to specify how points in a [PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html) are rendered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html) */ constructor(properties?: PointCloudRendererProperties); /** * Creates a deep clone of the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#clone) */ clone(): PointCloudRenderer; static fromJSON(json: any): PointCloudRenderer; } interface PointCloudRendererProperties { /** * Reduces the brightness of the point's color, based on the value of another field, usually `intensity`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#colorModulation) */ colorModulation?: PointCloudRendererColorModulation; /** * Specifies how the size of the points in the point cloud is computed for rendering. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#pointSizeAlgorithm) */ pointSizeAlgorithm?: PointCloudRendererPointSizeAlgorithm; /** * The number of points to draw per display inch. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#pointsPerInch) */ pointsPerInch?: number; } export interface PointCloudRendererColorModulation { /** * Field to use for the color modulation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#colorModulation) */ field: string; /** * Field value at which the point color becomes darkest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#colorModulation) */ minValue?: number; /** * Field value at which the point color will be left unchanged. * * @default 255 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#colorModulation) */ maxValue?: number; } export interface PointCloudRendererPointSizeAlgorithm { /** * `fixed-size` or `splat`. * * [Read more...](global.html#type) */ type: "fixed-size" | "splat"; /** * Specifies whether `size` is in real world units or screen-space units. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#pointSizeAlgorithm) */ useRealWorldSymbolSizes?: boolean; /** * Point size in meters (`useRealWorldSymbolSizes = true`) or points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#pointSizeAlgorithm) */ size?: number; /** * Specifies the scale factor that is applied to the size estimated by the density. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#pointSizeAlgorithm) */ scaleFactor?: number; } export class PointCloudRGBRenderer extends PointCloudRenderer { /** * The name of the field containing RGB values used to drive the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRGBRenderer.html#field) */ field: string; /** * The type of Renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRGBRenderer.html#type) */ readonly type: "point-cloud-rgb"; /** * PointCloudRGBRenderer defines the color of each point in a [PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html) based on the value of a color attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRGBRenderer.html) */ constructor(properties?: PointCloudRGBRendererProperties); /** * Creates a deep clone of the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRGBRenderer.html#clone) */ clone(): PointCloudRGBRenderer; static fromJSON(json: any): PointCloudRGBRenderer; } interface PointCloudRGBRendererProperties extends PointCloudRendererProperties { /** * The name of the field containing RGB values used to drive the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRGBRenderer.html#field) */ field?: string; } export class PointCloudStretchRenderer extends PointCloudRenderer { /** * The name of the number field whose values are used to drive the continuous color visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#field) */ field: string; /** * A transform that is applied to the field value before evaluating the renderer. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#fieldTransformType) */ fieldTransformType: "none" | "low-four-bit" | "high-four-bit" | "absolute-value" | "modulo-ten"; /** * An object providing options for displaying the renderer in the Legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#legendOptions) */ legendOptions: PointCloudStretchRendererLegendOptions; /** * An array of color value pairs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#stops) */ stops: ColorStop[]; /** * The type of Renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#type) */ readonly type: "point-cloud-stretch"; /** * PointCloudStretchRenderer defines the color of each point in a [PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html) based on the value of a numeric attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html) */ constructor(properties?: PointCloudStretchRendererProperties); /** * Creates a deep clone of the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#clone) */ clone(): PointCloudStretchRenderer; static fromJSON(json: any): PointCloudStretchRenderer; } interface PointCloudStretchRendererProperties extends PointCloudRendererProperties { /** * The name of the number field whose values are used to drive the continuous color visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#field) */ field?: string; /** * A transform that is applied to the field value before evaluating the renderer. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#fieldTransformType) */ fieldTransformType?: "none" | "low-four-bit" | "high-four-bit" | "absolute-value" | "modulo-ten"; /** * An object providing options for displaying the renderer in the Legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#legendOptions) */ legendOptions?: PointCloudStretchRendererLegendOptions; /** * An array of color value pairs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#stops) */ stops?: ColorStopProperties[]; } export interface PointCloudStretchRendererLegendOptions { /** * Describes the variable driving the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#legendOptions) */ title?: string; } export class PointCloudUniqueValueRenderer extends PointCloudRenderer { /** * Each element in the array is an object that matches a unique value with a specific color. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#colorUniqueValueInfos) */ colorUniqueValueInfos: PointCloudUniqueValueRendererColorUniqueValueInfos[]; /** * The name of the field whose values are used to drive the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#field) */ field: string; /** * A transform that is applied to the field value before evaluating the renderer. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#fieldTransformType) */ fieldTransformType: "none" | "low-four-bit" | "high-four-bit" | "absolute-value" | "modulo-ten"; /** * An object providing options for displaying the renderer in the Legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#legendOptions) */ legendOptions: PointCloudUniqueValueRendererLegendOptions; /** * The type of Renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#type) */ readonly type: "point-cloud-unique-value"; /** * PointCloudUniqueValueRenderer allows you to colorize points in a [PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html) based on an attribute value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html) */ constructor(properties?: PointCloudUniqueValueRendererProperties); /** * Creates a deep clone of the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#clone) */ clone(): PointCloudUniqueValueRenderer; static fromJSON(json: any): PointCloudUniqueValueRenderer; } interface PointCloudUniqueValueRendererProperties extends PointCloudRendererProperties { /** * Each element in the array is an object that matches a unique value with a specific color. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#colorUniqueValueInfos) */ colorUniqueValueInfos?: PointCloudUniqueValueRendererColorUniqueValueInfos[]; /** * The name of the field whose values are used to drive the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#field) */ field?: string; /** * A transform that is applied to the field value before evaluating the renderer. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#fieldTransformType) */ fieldTransformType?: "none" | "low-four-bit" | "high-four-bit" | "absolute-value" | "modulo-ten"; /** * An object providing options for displaying the renderer in the Legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#legendOptions) */ legendOptions?: PointCloudUniqueValueRendererLegendOptions; } export interface PointCloudUniqueValueRendererColorUniqueValueInfos { /** * A unique combination of values that will be represented with the given `color`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#colorUniqueValueInfos) */ values: string[]; /** * The color used to represent points whose value matches `values`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#colorUniqueValueInfos) */ color: Color; /** * Label used to describe points matched to the unique value. * * [Read more...](global.html) */ label?: string; } export interface PointCloudUniqueValueRendererLegendOptions { /** * Describes the variable driving the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#legendOptions) */ title?: string; } export interface RasterColormapRenderer extends Accessor, JSONSupport { } export class RasterColormapRenderer { /** * A colormap info array containing mappings for pixel and RGB color values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterColormapRenderer.html#colormapInfos) */ colormapInfos: ColormapInfo[]; /** * The type of Renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterColormapRenderer.html#type) */ readonly type: "raster-colormap"; /** * The RasterColormapRenderer defines the symbology to display raster data based on specific colors, aiding in visual analysis of the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterColormapRenderer.html) */ constructor(properties?: RasterColormapRendererProperties); /** * Creates a deep clone of the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterColormapRenderer.html#clone) */ clone(): RasterColormapRenderer; /** * Creates a new instance [RasterColormapRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterColormapRenderer.html) from an array of color maps where pixel values with its corresponding RGB color values specified. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterColormapRenderer.html#createFromColormap) */ static createFromColormap(colormap: number[][]): RasterColormapRenderer; static fromJSON(json: any): RasterColormapRenderer; } interface RasterColormapRendererProperties { /** * A colormap info array containing mappings for pixel and RGB color values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterColormapRenderer.html#colormapInfos) */ colormapInfos?: ColormapInfoProperties[]; } export interface RasterShadedReliefRenderer extends Accessor, JSONSupport { } export class RasterShadedReliefRenderer { /** * The sun's angle of elevation above the horizon, ranging from 0 to 90 degrees. * * @default 45 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html#altitude) */ altitude: number; /** * The sun's relative position along the horizon, ranging from 0 to 360 degrees. * * @default 315 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html#azimuth) */ azimuth: number; /** * The color ramp to display the shaded relief. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html#colorRamp) */ colorRamp: ColorRamp; /** * The type of hillshading being applied on the elevation surface. * * @default "traditional" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html#hillshadeType) */ hillshadeType: "traditional" | "multi-directional"; /** * Pixel size factor accounts for changes in scale as the viewer zooms in and out on the map display. * * @default 0.024 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html#pixelSizeFactor) */ pixelSizeFactor: number; /** * Pixel Size Power accounts for the altitude changes (or scale) as the viewer zooms in and out on the map display. * * @default 0.664 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html#pixelSizePower) */ pixelSizePower: number; /** * Applies a constant or adjusted z-factor based on resolution changes. * * @default none * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html#scalingType) */ scalingType: "none" | "adjusted"; /** * The type of Renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html#type) */ readonly type: "raster-shaded-relief"; /** * A ratio of z unit / xy unit, with optional exaggeration factored in. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html#zFactor) */ zFactor: number; /** * RasterShadedReliefRenderer produces a grayscale or colored 3D representation of the surface on an [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html) or [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html), with the sun's relative position taken into account for shading the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html) */ constructor(properties?: RasterShadedReliefRendererProperties); /** * Creates a deep clone of the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html#clone) */ clone(): RasterShadedReliefRenderer; static fromJSON(json: any): RasterShadedReliefRenderer; } interface RasterShadedReliefRendererProperties { /** * The sun's angle of elevation above the horizon, ranging from 0 to 90 degrees. * * @default 45 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html#altitude) */ altitude?: number; /** * The sun's relative position along the horizon, ranging from 0 to 360 degrees. * * @default 315 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html#azimuth) */ azimuth?: number; /** * The color ramp to display the shaded relief. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html#colorRamp) */ colorRamp?: ColorRampProperties; /** * The type of hillshading being applied on the elevation surface. * * @default "traditional" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html#hillshadeType) */ hillshadeType?: "traditional" | "multi-directional"; /** * Pixel size factor accounts for changes in scale as the viewer zooms in and out on the map display. * * @default 0.024 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html#pixelSizeFactor) */ pixelSizeFactor?: number; /** * Pixel Size Power accounts for the altitude changes (or scale) as the viewer zooms in and out on the map display. * * @default 0.664 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html#pixelSizePower) */ pixelSizePower?: number; /** * Applies a constant or adjusted z-factor based on resolution changes. * * @default none * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html#scalingType) */ scalingType?: "none" | "adjusted"; /** * A ratio of z unit / xy unit, with optional exaggeration factored in. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html#zFactor) */ zFactor?: number; } export interface RasterStretchRenderer extends Accessor, JSONSupport { } export class RasterStretchRenderer { /** * The stretched values are mapped to this specified color ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#colorRamp) */ colorRamp: ColorRamp; /** * The computeGamma automatically calculates best gamma value to render exported image based on empirical model. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#computeGamma) */ computeGamma: boolean; /** * When Dynamic Range Adjustment is `true`, the statistics based on the current display extent are calculated as you zoom and pan around the image. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#dynamicRangeAdjustment) */ dynamicRangeAdjustment: boolean; /** * The gamma values to be used if [useGamma](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#useGamma) is set to `true`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#gamma) */ gamma: number[]; /** * Applicable when [stretchType](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#stretchType) is `percent-clip`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#maxPercent) */ maxPercent: number; /** * Applicable when [stretchType](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#stretchType) is `percent-clip`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#minPercent) */ minPercent: number; /** * Applicable when [stretchType](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#stretchType) is `standard-deviation`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#numberOfStandardDeviations) */ numberOfStandardDeviations: number; /** * The outputMax denotes the output maximum, which is the highest pixel value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#outputMax) */ outputMax: number; /** * The outputMin denotes the output minimum, which is the lowest pixel value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#outputMin) */ outputMin: number; /** * The sigmoid strength level determines how much of the sigmoidal function will be used in the stretch. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#sigmoidStrengthLevel) */ sigmoidStrengthLevel: number; /** * The input statistics can be specified through the statistics property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#statistics) */ statistics: number[][] | any[] | RasterStretchRendererStatistics; /** * The stretch type defines a histogram stretch that will be applied to the rasters to enhance their appearance. * * @default none * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#stretchType) */ stretchType: "none" | "standard-deviation" | "histogram-equalization" | "min-max" | "percent-clip" | "sigmoid"; /** * The type of Renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#type) */ readonly type: "raster-stretch"; /** * Denotes whether the [gamma](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#gamma) value should be used. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#useGamma) */ useGamma: boolean; /** * RasterStretchRenderer defines the symbology with a gradual ramp of colors for each pixel in a [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html), [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html), and [WCSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html) based on the pixel value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html) */ constructor(properties?: RasterStretchRendererProperties); /** * Creates a deep clone of the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#clone) */ clone(): RasterStretchRenderer; static fromJSON(json: any): RasterStretchRenderer; } interface RasterStretchRendererProperties { /** * The stretched values are mapped to this specified color ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#colorRamp) */ colorRamp?: ColorRampProperties; /** * The computeGamma automatically calculates best gamma value to render exported image based on empirical model. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#computeGamma) */ computeGamma?: boolean; /** * When Dynamic Range Adjustment is `true`, the statistics based on the current display extent are calculated as you zoom and pan around the image. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#dynamicRangeAdjustment) */ dynamicRangeAdjustment?: boolean; /** * The gamma values to be used if [useGamma](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#useGamma) is set to `true`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#gamma) */ gamma?: number[]; /** * Applicable when [stretchType](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#stretchType) is `percent-clip`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#maxPercent) */ maxPercent?: number; /** * Applicable when [stretchType](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#stretchType) is `percent-clip`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#minPercent) */ minPercent?: number; /** * Applicable when [stretchType](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#stretchType) is `standard-deviation`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#numberOfStandardDeviations) */ numberOfStandardDeviations?: number; /** * The outputMax denotes the output maximum, which is the highest pixel value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#outputMax) */ outputMax?: number; /** * The outputMin denotes the output minimum, which is the lowest pixel value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#outputMin) */ outputMin?: number; /** * The sigmoid strength level determines how much of the sigmoidal function will be used in the stretch. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#sigmoidStrengthLevel) */ sigmoidStrengthLevel?: number; /** * The input statistics can be specified through the statistics property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#statistics) */ statistics?: number[][] | any[] | RasterStretchRendererStatistics; /** * The stretch type defines a histogram stretch that will be applied to the rasters to enhance their appearance. * * @default none * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#stretchType) */ stretchType?: "none" | "standard-deviation" | "histogram-equalization" | "min-max" | "percent-clip" | "sigmoid"; /** * Denotes whether the [gamma](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#gamma) value should be used. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#useGamma) */ useGamma?: boolean; } export interface RasterStretchRendererStatistics { /** * The minimum pixel value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#statistics) */ min: number; /** * The maximum pixel value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#statistics) */ max: number; /** * The average pixel value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#statistics) */ avg?: number; /** * The standard deviation of the pixel value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#statistics) */ stddev?: number; } export interface Renderer extends Accessor, JSONSupport { } export class Renderer { /** * Authoring metadata only included in renderers generated from one of the Smart Mapping creator methods, such as [sizeRendererCreator.createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) or [colorRendererCreator.createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#authoringInfo) */ authoringInfo: AuthoringInfo; /** * The renderer type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#type) */ readonly type: "class-breaks" | "dictionary" | "dot-density" | "heatmap" | "pie-chart" | "simple" | "unique-value"; /** * Renderers define how to visually represent each feature in one of the following layer types: * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) */ constructor(properties?: RendererProperties); static fromJSON(json: any): Renderer; } interface RendererProperties { /** * Authoring metadata only included in renderers generated from one of the Smart Mapping creator methods, such as [sizeRendererCreator.createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) or [colorRendererCreator.createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#authoringInfo) */ authoringInfo?: AuthoringInfoProperties; } export interface SimpleRenderer extends Renderer, VisualVariablesMixin { } export class SimpleRenderer { /** * The label for the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#label) */ label: string; /** * The symbol used by the renderer to visualize all features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#symbol) */ symbol: Symbol; /** * The type of renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#type) */ readonly type: "simple"; /** * SimpleRenderer renders all features in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) with one [Symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html) */ constructor(properties?: SimpleRendererProperties); /** * Creates a deep clone of the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#clone) */ clone(): SimpleRenderer; static fromJSON(json: any): SimpleRenderer; } interface SimpleRendererProperties extends RendererProperties, VisualVariablesMixinProperties { /** * The label for the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#label) */ label?: string; /** * The symbol used by the renderer to visualize all features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#symbol) */ symbol?: SymbolProperties; } export interface AttributeColorInfo extends Accessor, JSONSupport { } export class AttributeColorInfo { /** * The color used to render dots representing the given [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AttributeColorInfo.html#field) in a [DotDensityRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html) or the color used to represent a pie chart slice in a [PieChartRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AttributeColorInfo.html#color) */ color: Color; /** * The name of the numeric attribute field represented by the given [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AttributeColorInfo.html#color). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AttributeColorInfo.html#field) */ field: string; /** * The label used to describe the field or attribute in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AttributeColorInfo.html#label) */ label: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AttributeColorInfo.html#valueExpression) */ valueExpression: string; /** * The title identifying and describing the associated [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression as defined in the [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AttributeColorInfo.html#valueExpression) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AttributeColorInfo.html#valueExpressionTitle) */ valueExpressionTitle: string; /** * Defines colors for dots in a [DotDensityRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#attributes), or colors for pie chart slices in a [PieChartRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html#attributes). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AttributeColorInfo.html) */ constructor(properties?: AttributeColorInfoProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AttributeColorInfo.html#clone) */ clone(): AttributeColorInfo; static fromJSON(json: any): AttributeColorInfo; } interface AttributeColorInfoProperties { /** * The color used to render dots representing the given [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AttributeColorInfo.html#field) in a [DotDensityRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html) or the color used to represent a pie chart slice in a [PieChartRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AttributeColorInfo.html#color) */ color?: Color | number[] | string; /** * The name of the numeric attribute field represented by the given [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AttributeColorInfo.html#color). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AttributeColorInfo.html#field) */ field?: string; /** * The label used to describe the field or attribute in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AttributeColorInfo.html#label) */ label?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AttributeColorInfo.html#valueExpression) */ valueExpression?: string; /** * The title identifying and describing the associated [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression as defined in the [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AttributeColorInfo.html#valueExpression) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AttributeColorInfo.html#valueExpressionTitle) */ valueExpressionTitle?: string; } export interface AuthoringInfo extends Accessor, JSONSupport { } export class AuthoringInfo { /** * Indicates which classification method was used if a classed color or classed size renderer was generated using one of the Smart Mapping functions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#classificationMethod) */ classificationMethod: | "equal-interval" | "defined-interval" | "manual" | "natural-breaks" | "quantile" | "standard-deviation"; /** * Indicates the color ramp was used to create the symbols for Unique Value or Class Breaks renderer for Imagery Layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#colorRamp) */ colorRamp: ColorRamp; /** * Only applicable to [HeatmapRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html) created with the [heatmap renderer creator](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#fadeRatio) */ fadeRatio: number; /** * A numeric field used for generating a [relationship renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html) along with [field2](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field2). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field1) */ field1: AuthoringInfoField1; /** * A numeric field used for generating a [relationship renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html) along with [field1](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field1). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field2) */ field2: AuthoringInfoField2; /** * An array of string values representing field names used for creating a [predominance renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#fields) */ fields: string[]; /** * Only applicable to flow renderers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#flowTheme) */ flowTheme: "flow-line" | "wave-front"; /** * The focus of a [relationship renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#focus) */ focus: string; /** * Indicates whether the renderer was created internally by the JS API's rendering engine for default [FeatureReductionCluster](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html) visualizations. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#isAutoGenerated) */ isAutoGenerated: boolean; /** * **Only applicable to renderer used in web scenes.** Indicates the unit used in real-world sizes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#lengthUnit) */ lengthUnit: | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "decimal-degrees"; /** * Indicates the value of the upper handle if a slider was used to generate the dot value for dot density renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#maxSliderValue) */ maxSliderValue: number; /** * Indicates the value of the lower handle if a slider was used to generate the dot value for dot density renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#minSliderValue) */ minSliderValue: number; /** * The number of classes used to classify each field of a [relationship renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#numClasses) */ numClasses: number; /** * Indicates the standard deviation interval for each stop in a classed color or classed size renderer that was generated using the `standard-deviation` classification method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#standardDeviationInterval) */ standardDeviationInterval: number; /** * Only for renderers of type `univariate-color-size` with an `above-and-below` [univariateTheme](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#univariateTheme). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#statistics) */ statistics: AuthoringInfoStatistics; /** * Indicates the renderer type generated from one of the Smart Mapping functions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#type) */ type: | "class-breaks-size" | "class-breaks-color" | "classed-color" | "classed-size" | "flow" | "predominance" | "relationship" | "univariate-color-size"; /** * Only applicable to [univariateColorSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html) renderers with an `above-and-below` [univariateTheme](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#univariateTheme). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#univariateSymbolStyle) */ univariateSymbolStyle: | "caret" | "circle-caret" | "arrow" | "circle-arrow" | "plus-minus" | "circle-plus-minus" | "square" | "circle" | "triangle" | "happy-sad" | "thumb" | "custom"; /** * Only applicable to [univariateColorSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html) renderers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#univariateTheme) */ univariateTheme: "high-to-low" | "above" | "below" | "above-and-below"; /** * Contains authoring properties of visual variables generated from one of the Smart Mapping methods or sliders. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#visualVariables) */ visualVariables: AuthoringInfoVisualVariable[]; /** * Authoring information related to generating renderers and visual variables with the Smart Mapping methods. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html) */ constructor(properties?: AuthoringInfoProperties); /** * Creates a deep clone of the instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#clone) */ clone(): AuthoringInfo; static fromJSON(json: any): AuthoringInfo; } interface AuthoringInfoProperties { /** * Indicates which classification method was used if a classed color or classed size renderer was generated using one of the Smart Mapping functions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#classificationMethod) */ classificationMethod?: | "equal-interval" | "defined-interval" | "manual" | "natural-breaks" | "quantile" | "standard-deviation"; /** * Indicates the color ramp was used to create the symbols for Unique Value or Class Breaks renderer for Imagery Layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#colorRamp) */ colorRamp?: ColorRampProperties; /** * Only applicable to [HeatmapRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html) created with the [heatmap renderer creator](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#fadeRatio) */ fadeRatio?: number; /** * A numeric field used for generating a [relationship renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html) along with [field2](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field2). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field1) */ field1?: AuthoringInfoField1; /** * A numeric field used for generating a [relationship renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html) along with [field1](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field1). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field2) */ field2?: AuthoringInfoField2; /** * An array of string values representing field names used for creating a [predominance renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#fields) */ fields?: string[]; /** * Only applicable to flow renderers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#flowTheme) */ flowTheme?: "flow-line" | "wave-front"; /** * The focus of a [relationship renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#focus) */ focus?: string; /** * Indicates whether the renderer was created internally by the JS API's rendering engine for default [FeatureReductionCluster](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html) visualizations. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#isAutoGenerated) */ isAutoGenerated?: boolean; /** * **Only applicable to renderer used in web scenes.** Indicates the unit used in real-world sizes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#lengthUnit) */ lengthUnit?: | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "decimal-degrees"; /** * Indicates the value of the upper handle if a slider was used to generate the dot value for dot density renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#maxSliderValue) */ maxSliderValue?: number; /** * Indicates the value of the lower handle if a slider was used to generate the dot value for dot density renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#minSliderValue) */ minSliderValue?: number; /** * The number of classes used to classify each field of a [relationship renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#numClasses) */ numClasses?: number; /** * Indicates the standard deviation interval for each stop in a classed color or classed size renderer that was generated using the `standard-deviation` classification method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#standardDeviationInterval) */ standardDeviationInterval?: number; /** * Only for renderers of type `univariate-color-size` with an `above-and-below` [univariateTheme](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#univariateTheme). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#statistics) */ statistics?: AuthoringInfoStatistics; /** * Indicates the renderer type generated from one of the Smart Mapping functions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#type) */ type?: | "class-breaks-size" | "class-breaks-color" | "classed-color" | "classed-size" | "flow" | "predominance" | "relationship" | "univariate-color-size"; /** * Only applicable to [univariateColorSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html) renderers with an `above-and-below` [univariateTheme](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#univariateTheme). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#univariateSymbolStyle) */ univariateSymbolStyle?: | "caret" | "circle-caret" | "arrow" | "circle-arrow" | "plus-minus" | "circle-plus-minus" | "square" | "circle" | "triangle" | "happy-sad" | "thumb" | "custom"; /** * Only applicable to [univariateColorSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html) renderers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#univariateTheme) */ univariateTheme?: "high-to-low" | "above" | "below" | "above-and-below"; /** * Contains authoring properties of visual variables generated from one of the Smart Mapping methods or sliders. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#visualVariables) */ visualVariables?: AuthoringInfoVisualVariableProperties[]; } export interface AuthoringInfoField1 { /** * The name of a numeric field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field1) */ field: string; /** * The name of a numeric field used to normalize the given `field`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field1) */ normalizationField?: string; /** * Describes the class breaks generated for this field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field1) */ classBreakInfos?: AuthoringInfoField1ClassBreakInfos[]; /** * The label used to describe the field or variable in the legend. * * [Read more...](global.html) */ label?: string; } export interface AuthoringInfoField1ClassBreakInfos { /** * The maximum bound of values to visualize in the given field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field1) */ maxValue?: number; /** * The minimum bound of values to visualize in the given field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field1) */ minValue?: number; } export interface AuthoringInfoField2 { /** * The name of a numeric field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field2) */ field: string; /** * The name of a numeric field used to normalize the given `field`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field2) */ normalizationField?: string; /** * Describes the class breaks generated for this field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field2) */ classBreakInfos?: AuthoringInfoField2ClassBreakInfos[]; /** * The label used to describe the field or variable in the legend. * * [Read more...](global.html) */ label?: string; } export interface AuthoringInfoField2ClassBreakInfos { /** * The maximum bound of values to visualize in the given field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field2) */ maxValue?: number; /** * The minimum bound of values to visualize in the given field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field2) */ minValue?: number; } export interface AuthoringInfoStatistics { /** * The maximum data value of the attribute represented by the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#statistics) */ max: number; /** * The minimum data value of the attribute represented by the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#statistics) */ min: number; } export interface AuthoringInfoVisualVariable extends Accessor, JSONSupport { } export class AuthoringInfoVisualVariable { /** * If an age or timeline renderer was generated, indicates the end time of the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#endTime) */ endTime: string | number; /** * Indicates the field name used for generating the data-driven visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#field) */ field: string; /** * Indicates the value of the upper handle if a slider was used to generate the visual variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#maxSliderValue) */ maxSliderValue: number; /** * Indicates the value of the lower handle if a slider was used to generate the visual variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#minSliderValue) */ minSliderValue: number; /** * If an age or timeline renderer was generated, indicates the start time of the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#startTime) */ startTime: string | number; /** * If the UI offers the option to display values based on a ratio or percentage, this indicates which selection was made. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#style) */ style: "percent" | "percent-of-total" | "ratio"; /** * Indicates the theme selected by the user when generating a renderer or visual variable with one of the Smart Mapping functions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#theme) */ theme: "above" | "below" | "above-and-below" | "centered-on" | "extremes" | "high-to-low"; /** * The type of visual variable generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#type) */ type: "color" | "size" | "opacity"; /** * If an age or timeline renderer was generated, indicates the time units used. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#units) */ units: "seconds" | "minutes" | "hours" | "days" | "months" | "years"; /** * Contains authoring properties of visual variables generated from one of the Smart Mapping methods or sliders. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html) */ constructor(properties?: AuthoringInfoVisualVariableProperties); /** * Creates a deep clone of the instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#clone) */ clone(): AuthoringInfoVisualVariable; static fromJSON(json: any): AuthoringInfoVisualVariable; } interface AuthoringInfoVisualVariableProperties { /** * If an age or timeline renderer was generated, indicates the end time of the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#endTime) */ endTime?: string | number; /** * Indicates the field name used for generating the data-driven visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#field) */ field?: string; /** * Indicates the value of the upper handle if a slider was used to generate the visual variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#maxSliderValue) */ maxSliderValue?: number; /** * Indicates the value of the lower handle if a slider was used to generate the visual variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#minSliderValue) */ minSliderValue?: number; /** * If an age or timeline renderer was generated, indicates the start time of the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#startTime) */ startTime?: string | number; /** * If the UI offers the option to display values based on a ratio or percentage, this indicates which selection was made. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#style) */ style?: "percent" | "percent-of-total" | "ratio"; /** * Indicates the theme selected by the user when generating a renderer or visual variable with one of the Smart Mapping functions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#theme) */ theme?: "above" | "below" | "above-and-below" | "centered-on" | "extremes" | "high-to-low"; /** * The type of visual variable generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#type) */ type?: "color" | "size" | "opacity"; /** * If an age or timeline renderer was generated, indicates the time units used. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#units) */ units?: "seconds" | "minutes" | "hours" | "days" | "months" | "years"; } export interface ClassBreakInfo extends Accessor, JSONSupport { } export class ClassBreakInfo { /** * Describes the data represented by the class break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-ClassBreakInfo.html#label) */ label: string; /** * Sets the maximum value for the class break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-ClassBreakInfo.html#maxValue) */ maxValue: number; /** * Sets the minimum value for the class break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-ClassBreakInfo.html#minValue) */ minValue: number; /** * Defines the symbol used to render features with data values that are within the bounds defined for the class break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-ClassBreakInfo.html#symbol) */ symbol: Symbol; /** * Defines a class break for a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-ClassBreakInfo.html) */ constructor(properties?: ClassBreakInfoProperties); /** * Creates a deep clone of the class break info object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-ClassBreakInfo.html#clone) */ clone(): ClassBreakInfo; static fromJSON(json: any): ClassBreakInfo; } interface ClassBreakInfoProperties { /** * Describes the data represented by the class break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-ClassBreakInfo.html#label) */ label?: string; /** * Sets the maximum value for the class break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-ClassBreakInfo.html#maxValue) */ maxValue?: number; /** * Sets the minimum value for the class break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-ClassBreakInfo.html#minValue) */ minValue?: number; /** * Defines the symbol used to render features with data values that are within the bounds defined for the class break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-ClassBreakInfo.html#symbol) */ symbol?: SymbolProperties; } export interface ColormapInfo extends Accessor, JSONSupport { } export class ColormapInfo { /** * The color of a given pixel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-ColormapInfo.html#color) */ color: Color; /** * The label for a given pixel value and color mapping. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-ColormapInfo.html#label) */ label: string; /** * The raster pixel value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-ColormapInfo.html#value) */ value: number; /** * The ColormapInfo describes pixel value, RGB colors and labels to color the raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-ColormapInfo.html) */ constructor(properties?: ColormapInfoProperties); static fromJSON(json: any): ColormapInfo; } interface ColormapInfoProperties { /** * The color of a given pixel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-ColormapInfo.html#color) */ color?: Color; /** * The label for a given pixel value and color mapping. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-ColormapInfo.html#label) */ label?: string; /** * The raster pixel value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-ColormapInfo.html#value) */ value?: number; } export class HeatmapColorStop extends Accessor { /** * The color to shade a given pixel based on its calculated density [ratio](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-HeatmapColorStop.html#ratio). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-HeatmapColorStop.html#color) */ color: Color; /** * The ratio of a pixel's density value to the [maxDensity](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#maxDensity) of the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-HeatmapColorStop.html#ratio) */ ratio: number; /** * This class is used to define an array of objects describing the [HeatmapRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html)'s color ramp and associated density value ratios. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-HeatmapColorStop.html) */ constructor(properties?: HeatmapColorStopProperties); /** * Creates a deep clone of the color stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-HeatmapColorStop.html#clone) */ clone(): HeatmapColorStop; } interface HeatmapColorStopProperties { /** * The color to shade a given pixel based on its calculated density [ratio](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-HeatmapColorStop.html#ratio). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-HeatmapColorStop.html#color) */ color?: Color | number[] | string; /** * The ratio of a pixel's density value to the [maxDensity](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#maxDensity) of the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-HeatmapColorStop.html#ratio) */ ratio?: number; } /** * Provides a utility method used to deserialize a JSON renderer object returned by the REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-jsonUtils.html) */ interface supportJsonUtils { /** * Creates a new instance of an appropriate [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) class and initializes it with values from a JSON object generated from an ArcGIS product. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-jsonUtils.html#fromJSON) */ fromJSON(json: any): Renderer; } export const supportJsonUtils: supportJsonUtils; export interface UniqueValue extends Accessor, JSONSupport { } export class UniqueValue { /** * Defines a value (possibly in combination with [value2](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValue.html#value2) and [value3](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValue.html#value3)) returned from the field referenced in [UniqueValueRenderer.field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field) or returned from an Arcade expression defined in [UniqueValueRenderer.valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#valueExpression) to be categorized in a [UniqueValueClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValue.html#value) */ value: string | number; /** * Defines a value returned from the field referenced in [UniqueValueRenderer.field2](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field2) to be categorized in combination with [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValue.html#value) (and possibly [value3](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValue.html#value3)) in a [UniqueValueClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValue.html#value2) */ value2: string | number; /** * Defines a value returned from the field referenced in [UniqueValueRenderer.field3](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field3) to be categorized in combination with [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValue.html#value) and [value2](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValue.html#value2) in a [UniqueValueClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValue.html#value3) */ value3: string | number; /** * Defines combinations of values to expect from up to three fields of categorical data in a [UniqueValueRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValue.html) */ constructor(properties?: UniqueValueProperties); static fromJSON(json: any): UniqueValue; } interface UniqueValueProperties { /** * Defines a value (possibly in combination with [value2](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValue.html#value2) and [value3](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValue.html#value3)) returned from the field referenced in [UniqueValueRenderer.field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field) or returned from an Arcade expression defined in [UniqueValueRenderer.valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#valueExpression) to be categorized in a [UniqueValueClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValue.html#value) */ value?: string | number; /** * Defines a value returned from the field referenced in [UniqueValueRenderer.field2](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field2) to be categorized in combination with [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValue.html#value) (and possibly [value3](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValue.html#value3)) in a [UniqueValueClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValue.html#value2) */ value2?: string | number; /** * Defines a value returned from the field referenced in [UniqueValueRenderer.field3](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field3) to be categorized in combination with [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValue.html#value) and [value2](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValue.html#value2) in a [UniqueValueClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueClass.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValue.html#value3) */ value3?: string | number; } export interface UniqueValueClass extends Accessor, Clonable, JSONSupport { } export class UniqueValueClass { /** * Describes the [values](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueClass.html#values) represented by the [symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueClass.html#symbol) in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueClass.html#label) */ label: string; /** * Defines the symbol used to represent features containing the given [values](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueClass.html#values). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueClass.html#symbol) */ symbol: Symbol; /** * An array of unique values that should be rendered with the same symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueClass.html#values) */ values: UniqueValue[]; /** * Defines a category within a [UniqueValueGroup](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueGroup.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueClass.html) */ constructor(properties?: UniqueValueClassProperties); static fromJSON(json: any): UniqueValueClass; } interface UniqueValueClassProperties { /** * Describes the [values](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueClass.html#values) represented by the [symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueClass.html#symbol) in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueClass.html#label) */ label?: string; /** * Defines the symbol used to represent features containing the given [values](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueClass.html#values). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueClass.html#symbol) */ symbol?: SymbolProperties; /** * An array of unique values that should be rendered with the same symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueClass.html#values) */ values?: UniqueValueProperties[] | string | number; } export interface UniqueValueGroup extends Accessor, Clonable, JSONSupport { } export class UniqueValueGroup { /** * Specifies the classes (or unique categories) to group under a [heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueGroup.html#heading). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueGroup.html#classes) */ classes: UniqueValueClass[]; /** * The heading to be displayed for the group of unique classes in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueGroup.html#heading) */ heading: string; /** * UniqueValueGroup represents a group of [unique value classes](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueClass.html) (i.e. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueGroup.html) */ constructor(properties?: UniqueValueGroupProperties); static fromJSON(json: any): UniqueValueGroup; } interface UniqueValueGroupProperties { /** * Specifies the classes (or unique categories) to group under a [heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueGroup.html#heading). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueGroup.html#classes) */ classes?: UniqueValueClassProperties[]; /** * The heading to be displayed for the group of unique classes in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueGroup.html#heading) */ heading?: string; } export interface UniqueValueInfo extends Accessor, JSONSupport { } export class UniqueValueInfo { /** * Describes the [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueInfo.html#value) represented by the [symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueInfo.html#symbol). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueInfo.html#label) */ label: string; /** * Defines the symbol used to render features with the provided [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueInfo.html#value). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueInfo.html#symbol) */ symbol: Symbol; /** * Features with this value will be rendered with the given [symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueInfo.html#symbol). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueInfo.html#value) */ value: string | number; /** * Defines the categories of a [UniqueValueRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueInfo.html) */ constructor(properties?: UniqueValueInfoProperties); /** * Creates a deep clone of the unique value info object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueInfo.html#clone) */ clone(): UniqueValueInfo; static fromJSON(json: any): UniqueValueInfo; } interface UniqueValueInfoProperties { /** * Describes the [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueInfo.html#value) represented by the [symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueInfo.html#symbol). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueInfo.html#label) */ label?: string; /** * Defines the symbol used to render features with the provided [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueInfo.html#value). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueInfo.html#symbol) */ symbol?: SymbolProperties; /** * Features with this value will be rendered with the given [symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueInfo.html#symbol). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-UniqueValueInfo.html#value) */ value?: string | number; } /** * Various utilities for accessing renderer colors that match to fields, Arcade expressions, or values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-utils.html) */ interface utils { /** * Resolves with a [FieldToValueColorMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-utils.html#FieldToValueColorMap) that contains the fields and a map of values to its matched color in the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-utils.html#getColorsForRendererValues) */ getColorsForRendererValues(renderer: ClassBreaksRenderer | SimpleRenderer | UniqueValueRenderer): Promise; /** * Resolves with a [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) of fields matched to the color that the field is represented by in the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-utils.html#getColorsFromRenderer) */ getColorsFromRenderer(renderer: | ClassBreaksRenderer | DotDensityRenderer | HeatmapRenderer | PieChartRenderer | SimpleRenderer | UniqueValueRenderer): Promise>; } export const utils: utils; /** * A mapping of the field or Arcade expression to a [ValueToColorMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-utils.html#ValueToColorMap) object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-utils.html#FieldToValueColorMap) */ export type FieldToValueColorMap = globalThis.Map; /** * A Map object that holds a renderer value and its corresponding color. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-utils.html#ValueToColorMap) */ export type ValueToColorMap = globalThis.Map; export interface UniqueValueRenderer extends Renderer, VisualVariablesMixin { } export class UniqueValueRenderer { /** * This property is only relevant when symbolizing polygon features with marker symbols (or [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html)) in the [uniqueValueInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueInfos) of this renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#backgroundFillSymbol) */ backgroundFillSymbol: FillSymbol | PolygonSymbol3D; /** * The label used in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) to describe features assigned the [default symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#defaultSymbol). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#defaultLabel) */ defaultLabel: string; /** * The symbol used to draw all features with values not referenced by [uniqueValueInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueInfos) or [uniqueValueGroups](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueGroups). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#defaultSymbol) */ defaultSymbol: Symbol; /** * The name of the attribute field containing types or categorical values referenced in [uniqueValueInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueInfos) or [uniqueValueGroups](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueGroups). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field) */ field: string; /** * Specifies the name of an additional attribute field used to categorize features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field2) */ field2: string; /** * Specifies the name of a third attribute field used to categorize features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field3) */ field3: string; /** * A string used as a separator between the values in the legend if multiple attribute fields are used to categorize values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#fieldDelimiter) */ fieldDelimiter: string; /** * An object providing options for displaying the renderer in the Legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#legendOptions) */ legendOptions: UniqueValueRendererLegendOptions; /** * Indicates whether the order of the classes or [uniqueValueInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueInfos) in the renderer definition should be used for the feature drawing order of the layer. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#orderByClassesEnabled) */ orderByClassesEnabled: boolean; /** * The type of Renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#type) */ readonly type: "unique-value"; /** * An array of objects defining groups of unique values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueGroups) */ uniqueValueGroups: UniqueValueGroup[]; /** * Defines categories and their corresponding symbols based on a set of values expected from the provided [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field) or [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#valueExpression). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueInfos) */ uniqueValueInfos: UniqueValueInfo[]; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#valueExpression) */ valueExpression: string; /** * The title identifying and describing the associated [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression as defined in the [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#valueExpression) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#valueExpressionTitle) */ valueExpressionTitle: string; /** * UniqueValueRenderer allows you to symbolize features in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) based on one or more categorical attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html) */ constructor(properties?: UniqueValueRendererProperties); /** * Adds a unique value and symbol to the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#addUniqueValueInfo) */ addUniqueValueInfo(valueOrInfo: string | number | any, symbol?: Symbol | SymbolProperties): void; /** * Creates a deep clone of the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#clone) */ clone(): UniqueValueRenderer; /** * Returns rendering and legend information (as defined by the renderer) associated with the given graphic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#getUniqueValueInfo) */ getUniqueValueInfo(graphic: Graphic): Promise; /** * Removes a unique value from the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#removeUniqueValueInfo) */ removeUniqueValueInfo(value: string | number): void; static fromJSON(json: any): UniqueValueRenderer; } interface UniqueValueRendererProperties extends RendererProperties, VisualVariablesMixinProperties { /** * This property is only relevant when symbolizing polygon features with marker symbols (or [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html)) in the [uniqueValueInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueInfos) of this renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#backgroundFillSymbol) */ backgroundFillSymbol?: FillSymbolProperties | (PolygonSymbol3DProperties & { type: "polygon-3d" }); /** * The label used in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) to describe features assigned the [default symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#defaultSymbol). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#defaultLabel) */ defaultLabel?: string; /** * The symbol used to draw all features with values not referenced by [uniqueValueInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueInfos) or [uniqueValueGroups](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueGroups). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#defaultSymbol) */ defaultSymbol?: SymbolProperties; /** * The name of the attribute field containing types or categorical values referenced in [uniqueValueInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueInfos) or [uniqueValueGroups](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueGroups). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field) */ field?: string; /** * Specifies the name of an additional attribute field used to categorize features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field2) */ field2?: string; /** * Specifies the name of a third attribute field used to categorize features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field3) */ field3?: string; /** * A string used as a separator between the values in the legend if multiple attribute fields are used to categorize values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#fieldDelimiter) */ fieldDelimiter?: string; /** * An object providing options for displaying the renderer in the Legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#legendOptions) */ legendOptions?: UniqueValueRendererLegendOptions; /** * Indicates whether the order of the classes or [uniqueValueInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueInfos) in the renderer definition should be used for the feature drawing order of the layer. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#orderByClassesEnabled) */ orderByClassesEnabled?: boolean; /** * An array of objects defining groups of unique values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueGroups) */ uniqueValueGroups?: UniqueValueGroupProperties[]; /** * Defines categories and their corresponding symbols based on a set of values expected from the provided [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field) or [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#valueExpression). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueInfos) */ uniqueValueInfos?: UniqueValueInfoProperties[]; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#valueExpression) */ valueExpression?: string; /** * The title identifying and describing the associated [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression as defined in the [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#valueExpression) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#valueExpressionTitle) */ valueExpressionTitle?: string; } export interface UniqueValueRendererLegendOptions { /** * Describes the variable driving the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#legendOptions) */ title?: string; } export interface VectorFieldRenderer extends Accessor, JSONSupport { } export class VectorFieldRenderer { /** * Attribute field presenting the magnitude. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-VectorFieldRenderer.html#attributeField) */ attributeField: "Magnitude"; /** * Defines the flow direction of the data. * * @default "flow-from" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-VectorFieldRenderer.html#flowRepresentation) */ flowRepresentation: "flow-from" | "flow-to"; /** * Predefined symbol styles used to represent the vector flow. * * @default "single-arrow" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-VectorFieldRenderer.html#style) */ style: | "beaufort-ft" | "beaufort-km" | "beaufort-kn" | "beaufort-m" | "beaufort-mi" | "classified-arrow" | "ocean-current-kn" | "ocean-current-m" | "simple-scalar" | "single-arrow" | "wind-barb"; /** * Determines the density of the symbols. * * @default 50 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-VectorFieldRenderer.html#symbolTileSize) */ symbolTileSize: number; /** * The type of Renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-VectorFieldRenderer.html#type) */ readonly type: "vector-field"; /** * An array of [VisualVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html) objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-VectorFieldRenderer.html#visualVariables) */ visualVariables: VisualVariable[]; /** * The VectorFieldRenderer allows you to display your raster data with vector symbols. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-VectorFieldRenderer.html) */ constructor(properties?: VectorFieldRendererProperties); /** * Creates a deep clone of the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-VectorFieldRenderer.html#clone) */ clone(): VectorFieldRenderer; static fromJSON(json: any): VectorFieldRenderer; } interface VectorFieldRendererProperties { /** * Attribute field presenting the magnitude. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-VectorFieldRenderer.html#attributeField) */ attributeField?: "Magnitude"; /** * Defines the flow direction of the data. * * @default "flow-from" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-VectorFieldRenderer.html#flowRepresentation) */ flowRepresentation?: "flow-from" | "flow-to"; /** * Predefined symbol styles used to represent the vector flow. * * @default "single-arrow" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-VectorFieldRenderer.html#style) */ style?: | "beaufort-ft" | "beaufort-km" | "beaufort-kn" | "beaufort-m" | "beaufort-mi" | "classified-arrow" | "ocean-current-kn" | "ocean-current-m" | "simple-scalar" | "single-arrow" | "wind-barb"; /** * Determines the density of the symbols. * * @default 50 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-VectorFieldRenderer.html#symbolTileSize) */ symbolTileSize?: number; /** * An array of [VisualVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html) objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-VectorFieldRenderer.html#visualVariables) */ visualVariables?: VisualVariableProperties[]; } export interface ColorVariable extends VisualVariable, JSONSupport { } export class ColorVariable { /** * Name of the numeric attribute field by which to normalize the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html#normalizationField) */ normalizationField: string; /** * An array of sequential objects, or stops, that defines a continuous color ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html#stops) */ stops: ColorStop[]; /** * The visual variable type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html#type) */ readonly type: "color"; /** * The color visual variable is used to visualize features along a continuous color ramp based on the values of a numeric attribute [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html#field) or an [expression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html#valueExpression). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html) */ constructor(properties?: ColorVariableProperties); /** * Creates a deep clone of the ColorVariable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html#clone) */ clone(): ColorVariable; static fromJSON(json: any): ColorVariable; } interface ColorVariableProperties extends VisualVariableProperties { /** * Name of the numeric attribute field by which to normalize the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html#normalizationField) */ normalizationField?: string; /** * An array of sequential objects, or stops, that defines a continuous color ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html#stops) */ stops?: ColorStopProperties[]; } export interface OpacityVariable extends VisualVariable, JSONSupport { } export class OpacityVariable { /** * Name of the numeric attribute field by which to normalize the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-OpacityVariable.html#normalizationField) */ normalizationField: string; /** * An array of objects that defines the opacity to apply to features in a layer in a sequence of stops. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-OpacityVariable.html#stops) */ stops: OpacityStop[]; /** * The visual variable type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-OpacityVariable.html#type) */ readonly type: "opacity"; /** * The opacity visual variable defines the opacity of each feature's symbol based on a numeric [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-OpacityVariable.html#field) value or number returned from an [expression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-OpacityVariable.html#valueExpression). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-OpacityVariable.html) */ constructor(properties?: OpacityVariableProperties); /** * Creates a deep clone of the OpacityVariable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-OpacityVariable.html#clone) */ clone(): OpacityVariable; static fromJSON(json: any): OpacityVariable; } interface OpacityVariableProperties extends VisualVariableProperties { /** * Name of the numeric attribute field by which to normalize the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-OpacityVariable.html#normalizationField) */ normalizationField?: string; /** * An array of objects that defines the opacity to apply to features in a layer in a sequence of stops. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-OpacityVariable.html#stops) */ stops?: OpacityStopProperties[]; } export interface RotationVariable extends VisualVariable, JSONSupport { } export class RotationVariable { /** * Only applicable when working in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default heading * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-RotationVariable.html#axis) */ axis: "heading" | "tilt" | "roll"; /** * Defines the origin and direction of rotation depending on how the angle of rotation was measured. * * @default geographic * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-RotationVariable.html#rotationType) */ rotationType: "geographic" | "arithmetic"; /** * The visual variable type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-RotationVariable.html#type) */ readonly type: "rotation"; /** * The rotation visual variable defines how features rendered with [marker symbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MarkerSymbol.html) or [text symbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html) in a MapView are rotated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-RotationVariable.html) */ constructor(properties?: RotationVariableProperties); /** * Creates a deep clone of the RotationVariable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-RotationVariable.html#clone) */ clone(): RotationVariable; static fromJSON(json: any): RotationVariable; } interface RotationVariableProperties extends VisualVariableProperties { /** * Only applicable when working in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default heading * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-RotationVariable.html#axis) */ axis?: "heading" | "tilt" | "roll"; /** * Defines the origin and direction of rotation depending on how the angle of rotation was measured. * * @default geographic * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-RotationVariable.html#rotationType) */ rotationType?: "geographic" | "arithmetic"; } export interface SizeVariable extends VisualVariable, JSONSupport { } export class SizeVariable { /** * Only applicable when working in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default all * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#axis) */ axis: "width" | "depth" | "height" | "width-and-depth" | "all"; /** * The maximum data value used in the size ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#maxDataValue) */ maxDataValue: number; /** * The size used to render a feature containing the maximum data value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#maxSize) */ maxSize: number | ScaleDependentStops; /** * The minimum data value used in the size ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#minDataValue) */ minDataValue: number; /** * The size used to render a feature containing the minimum data value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#minSize) */ minSize: number | ScaleDependentStops; /** * The name of the numeric attribute field used to normalize the data in the given [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#field). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#normalizationField) */ normalizationField: string; /** * An array of objects that defines the mapping of data values returned from [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#field) or [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#valueExpression) to icon sizes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#stops) */ stops: SizeStop[]; /** * This value must be `outline` when scaling polygon outline widths based on the view scale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#target) */ target: string; /** * The visual variable type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#type) */ readonly type: "size"; /** * When setting a size visual variable on a renderer using an [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), this property indicates whether to apply the value defined by the [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#height), [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#width), or [depth](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#depth) properties to the corresponding [axis](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#axis) of this visual variable instead of proportionally scaling this axis' value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#useSymbolValue) */ useSymbolValue: boolean; /** * Specifies how to apply the data value when mapping real-world sizes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#valueRepresentation) */ valueRepresentation: "radius" | "diameter" | "area" | "width" | "distance"; /** * Indicates the unit of measurement used to interpret the value returned by [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#field) or [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#valueExpression). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#valueUnit) */ valueUnit: | "unknown" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "decimal-degrees"; /** * The size visual variable defines the size of individual features in a layer based on a numeric (often thematic) value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) */ constructor(properties?: SizeVariableProperties); /** * Creates a deep clone of the SizeVisualVariable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#clone) */ clone(): SizeVariable; /** * Modifies the SizeVariable in place by flipping the sizes in the [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#stops). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#flipSizes) */ flipSizes(): void; static fromJSON(json: any): SizeVariable; } interface SizeVariableProperties extends VisualVariableProperties { /** * Only applicable when working in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default all * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#axis) */ axis?: "width" | "depth" | "height" | "width-and-depth" | "all"; /** * The maximum data value used in the size ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#maxDataValue) */ maxDataValue?: number; /** * The size used to render a feature containing the maximum data value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#maxSize) */ maxSize?: number | ScaleDependentStops | string; /** * The minimum data value used in the size ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#minDataValue) */ minDataValue?: number; /** * The size used to render a feature containing the minimum data value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#minSize) */ minSize?: number | ScaleDependentStops | string; /** * The name of the numeric attribute field used to normalize the data in the given [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#field). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#normalizationField) */ normalizationField?: string; /** * An array of objects that defines the mapping of data values returned from [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#field) or [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#valueExpression) to icon sizes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#stops) */ stops?: SizeStopProperties[]; /** * This value must be `outline` when scaling polygon outline widths based on the view scale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#target) */ target?: string; /** * When setting a size visual variable on a renderer using an [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), this property indicates whether to apply the value defined by the [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#height), [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#width), or [depth](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#depth) properties to the corresponding [axis](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#axis) of this visual variable instead of proportionally scaling this axis' value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#useSymbolValue) */ useSymbolValue?: boolean; /** * Specifies how to apply the data value when mapping real-world sizes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#valueRepresentation) */ valueRepresentation?: "radius" | "diameter" | "area" | "width" | "distance"; /** * Indicates the unit of measurement used to interpret the value returned by [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#field) or [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#valueExpression). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#valueUnit) */ valueUnit?: | "unknown" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "decimal-degrees"; } /** * Defines a size visual variable with minimum and maximum bounds. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#BoundedMinMax) */ export interface BoundedMinMax { /** * Value must be `size`. * * [Read more...](global.html#type) */ type: string; /** * See [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#field). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#BoundedMinMax) */ field?: string; /** * See [normalizationField](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#normalizationField). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#BoundedMinMax) */ normalizationField?: string; /** * See [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#valueExpression). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#BoundedMinMax) */ valueExpression?: string; /** * See [valueExpressionTitle](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#valueExpressionTitle). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#BoundedMinMax) */ valueExpressionTitle?: string; /** * See [maxDataValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#maxDataValue). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#BoundedMinMax) */ maxDataValue: number; /** * The size used to render a feature containing the maximum data value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#BoundedMinMax) */ maxSize: string | number; /** * See [minDataValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#minDataValue). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#BoundedMinMax) */ minDataValue: number; /** * The size used to render a feature containing the minimum data value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#BoundedMinMax) */ minSize: string | number; } /** * Defines a size visual variable where data values are interpreted as real-world sizes based on a given unit. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#RealWorldSize) */ export interface RealWorldSize { /** * See [axis](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#axis). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#RealWorldSize) */ axis?: string; /** * Value must be `size`. * * [Read more...](global.html#type) */ type: string; /** * See [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#field). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#RealWorldSize) */ field?: string; /** * See [normalizationField](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#normalizationField). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#RealWorldSize) */ normalizationField?: string; /** * See [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#valueExpression). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#RealWorldSize) */ valueExpression?: string; /** * See [valueUnit](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#valueUnit). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#RealWorldSize) */ valueUnit?: string; /** * See [valueRepresentation](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#valueRepresentation). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#RealWorldSize) */ valueRepresentation?: string; } /** * Defines icon sizes in a size visual variable based on minimum and maximum bounds similar to the [BoundedMinMax](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#BoundedMinMax) case. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#ScaleDependentIcons) */ export interface ScaleDependentIcons { /** * Value must be `size`. * * [Read more...](global.html#type) */ type: string; /** * See [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#field). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#ScaleDependentIcons) */ field?: string; /** * See [normalizationField](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#normalizationField). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#ScaleDependentIcons) */ normalizationField?: string; /** * See [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#valueExpression). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#ScaleDependentIcons) */ valueExpression?: string; /** * See [maxDataValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#maxDataValue). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#ScaleDependentIcons) */ maxDataValue: number; /** * An object defining the size of features whose data value (defined in `field` or `valueExpression`) is greater than or equal to the `maxDataValue` for the given view scale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#ScaleDependentIcons) */ maxSize: ScaleDependentStops; /** * See [minDataValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#minDataValue). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#ScaleDependentIcons) */ minDataValue: number; /** * An object defining the size of features whose data value (defined in `field` or `valueExpression`) is less than or equal to the `minDataValue` for the given view scale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#ScaleDependentIcons) */ minSize: ScaleDependentStops; } /** * Defines feature sizes and outline widths in a [size visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#SizeVisualVariable) based on the [MapView.scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#ScaleDependentStops) */ export interface ScaleDependentStops { /** * Value must be `size`. * * [Read more...](global.html#type) */ type: string; /** * This value must be `$view.scale`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#ScaleDependentStops) */ valueExpression: string; /** * This value must be `outline` when scaling polygon outline widths based on the view scale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#ScaleDependentStops) */ target?: string; /** * An array of objects that define the size of the icon (or alternatively the width of the polygon outline) at the given scale `value`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#ScaleDependentStops) */ stops: SizeStop[]; } /** * Defines two or more stops at which feature sizes are mapped to data values in a size visual variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#ThematicStops) */ export interface ThematicStops { /** * Value must be `size`. * * [Read more...](global.html#type) */ type: string; /** * See [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#field). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#ThematicStops) */ field?: string; /** * See [normalizationField](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#normalizationField). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#ThematicStops) */ normalizationField?: string; /** * See [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#valueExpression). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#ThematicStops) */ valueExpression?: string; /** * An array of objects defining the thematic size ramp in a sequence of data or expression stops. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#ThematicStops) */ stops: SizeStop[]; } export interface ColorSizeStop extends Accessor, JSONSupport { } export class ColorSizeStop { /** * The [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) used to render features with the given [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorSizeStop.html#value). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorSizeStop.html#color) */ color: Color; /** * A string value used to label the stop in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorSizeStop.html#label) */ label: string; /** * The size value in points used to render features with the given [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorSizeStop.html#value). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorSizeStop.html#size) */ size: number; /** * Specifies the data value to map to the given [size](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorSizeStop.html#size) and [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorSizeStop.html#color). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorSizeStop.html#value) */ value: number; /** * Defines how to data values should be represented in the [ColorSizeSlider](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider.html) with an associated color and size. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorSizeStop.html) */ constructor(properties?: ColorSizeStopProperties); /** * Creates a deep clone of the ColorSizeStop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorSizeStop.html#clone) */ clone(): ColorSizeStop; static fromJSON(json: any): ColorSizeStop; } interface ColorSizeStopProperties { /** * The [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) used to render features with the given [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorSizeStop.html#value). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorSizeStop.html#color) */ color?: Color | number[] | string; /** * A string value used to label the stop in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorSizeStop.html#label) */ label?: string; /** * The size value in points used to render features with the given [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorSizeStop.html#value). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorSizeStop.html#size) */ size?: number | string; /** * Specifies the data value to map to the given [size](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorSizeStop.html#size) and [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorSizeStop.html#color). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorSizeStop.html#value) */ value?: number; } export interface ColorStop extends Accessor, JSONSupport { } export class ColorStop { /** * The [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) used to render features with the given [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorStop.html#value). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorStop.html#color) */ color: Color; /** * A string value used to label the stop along the color ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorStop.html#label) */ label: string; /** * Specifies the data value to map to the given [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorStop.html#color). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorStop.html#value) */ value: number; /** * Defines a color stop used for creating a continuous color visualization in a [color visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html#stops). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorStop.html) */ constructor(properties?: ColorStopProperties); /** * Creates a deep clone of the ColorStop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorStop.html#clone) */ clone(): ColorStop; static fromJSON(json: any): ColorStop; } interface ColorStopProperties { /** * The [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) used to render features with the given [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorStop.html#value). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorStop.html#color) */ color?: Color | number[] | string; /** * A string value used to label the stop along the color ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorStop.html#label) */ label?: string; /** * Specifies the data value to map to the given [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorStop.html#color). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-ColorStop.html#value) */ value?: number; } export interface OpacityStop extends Accessor, JSONSupport { } export class OpacityStop { /** * A string value used to label the stop in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-OpacityStop.html#label) */ label: string; /** * The opacity value (between `0.0` and `1.0`) used to render features with the given [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-OpacityStop.html#value). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-OpacityStop.html#opacity) */ opacity: number; /** * Specifies the data value to map to the given [opacity value](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-OpacityStop.html#opacity). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-OpacityStop.html#value) */ value: number; /** * Defines an opacity stop used for creating a continuous opacity visualization in a [opacity visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-OpacityVariable.html#stops). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-OpacityStop.html) */ constructor(properties?: OpacityStopProperties); /** * Creates a deep clone of the OpacityStop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-OpacityStop.html#clone) */ clone(): OpacityStop; static fromJSON(json: any): OpacityStop; } interface OpacityStopProperties { /** * A string value used to label the stop in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-OpacityStop.html#label) */ label?: string; /** * The opacity value (between `0.0` and `1.0`) used to render features with the given [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-OpacityStop.html#value). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-OpacityStop.html#opacity) */ opacity?: number | number[] | string; /** * Specifies the data value to map to the given [opacity value](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-OpacityStop.html#opacity). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-OpacityStop.html#value) */ value?: number; } export interface SizeStop extends Accessor, JSONSupport { } export class SizeStop { /** * A string value used to label the stop in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-SizeStop.html#label) */ label: string; /** * The size value in points (between `0` and `90`) used to render features with the given [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-SizeStop.html#value). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-SizeStop.html#size) */ size: number; /** * Specifies the data value to map to the given [size](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-SizeStop.html#size). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-SizeStop.html#value) */ value: number; /** * Defines a size stop used for creating a continuous size visualization in a [size visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#stops). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-SizeStop.html) */ constructor(properties?: SizeStopProperties); /** * Creates a deep clone of the SizeStop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-SizeStop.html#clone) */ clone(): SizeStop; static fromJSON(json: any): SizeStop; } interface SizeStopProperties { /** * A string value used to label the stop in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-SizeStop.html#label) */ label?: string; /** * The size value in points (between `0` and `90`) used to render features with the given [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-SizeStop.html#value). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-SizeStop.html#size) */ size?: number | string; /** * Specifies the data value to map to the given [size](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-SizeStop.html#size). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-support-SizeStop.html#value) */ value?: number; } export interface VisualVariable extends Accessor, JSONSupport { } export class VisualVariable { /** * The name of the numeric attribute field that contains the data values used to determine the color/opacity/size/rotation of each feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html#field) */ field: string; /** * An object providing options for displaying the visual variable in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html#legendOptions) */ legendOptions: VisualVariableLegendOptions; /** * The visual variable type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html#type) */ readonly type: "color" | "opacity" | "rotation" | "size"; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html#valueExpression) */ valueExpression: string; /** * The title identifying and describing the associated [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression as defined in the [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html#valueExpression) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html#valueExpressionTitle) */ valueExpressionTitle: string; /** * The visual variable base class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html) */ constructor(properties?: VisualVariableProperties); static fromJSON(json: any): VisualVariable; } interface VisualVariableProperties { /** * The name of the numeric attribute field that contains the data values used to determine the color/opacity/size/rotation of each feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html#field) */ field?: string; /** * An object providing options for displaying the visual variable in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html#legendOptions) */ legendOptions?: VisualVariableLegendOptions; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html#valueExpression) */ valueExpression?: string; /** * The title identifying and describing the associated [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression as defined in the [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html#valueExpression) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html#valueExpressionTitle) */ valueExpressionTitle?: string; } export interface VisualVariableLegendOptions { /** * Indicates whether to show the visual variable in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html#legendOptions) */ showLegend?: boolean; /** * The title describing the visualization of the visual variable in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html#legendOptions) */ title?: string; } /** * ClassBreaksRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers.html#ClassBreaksRenderer) */ export type renderersClassBreaksRenderer = ClassBreaksRenderer; /** * DictionaryRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers.html#DictionaryRenderer) */ export type renderersDictionaryRenderer = DictionaryRenderer; /** * DotDensityRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers.html#DotDensityRenderer) */ export type renderersDotDensityRenderer = DotDensityRenderer; /** * HeatmapRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers.html#HeatmapRenderer) */ export type renderersHeatmapRenderer = HeatmapRenderer; /** * PieChartRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers.html#PieChartRenderer) */ export type renderersPieChartRenderer = PieChartRenderer; /** * Renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers.html#Renderer) */ export type renderersRenderer = HeatmapRenderer | RendererWithVisualVariables; /** * RendererWithVisualVariables. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers.html#RendererWithVisualVariables) */ export type RendererWithVisualVariables = | SimpleRenderer | ClassBreaksRenderer | UniqueValueRenderer | DotDensityRenderer | DictionaryRenderer | PieChartRenderer; /** * SimpleRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers.html#SimpleRenderer) */ export type renderersSimpleRenderer = SimpleRenderer; /** * UniqueValueRenderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers.html#UniqueValueRenderer) */ export type renderersUniqueValueRenderer = UniqueValueRenderer; /** * Retrieves data from a remote server or uploads a file. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html) */ interface request { /** * Retrieves data from a remote server or uploads a file from a user's computer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) */ esriRequest(url: string | URL, options?: RequestOptions): Promise; } const __requestMapped: request; export const request: typeof __requestMapped.esriRequest; /** * The specification of the [details object](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html#details) returned in an [Error](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html) object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#EsriErrorDetails) */ export interface EsriErrorDetails { /** * A function to retrieve headers sent from the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#EsriErrorDetails) */ getHeader: GetHeader; /** * A function for retrieving all headers sent from the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#EsriErrorDetails) */ getAllHeaders: GetAllHeaders; /** * The status code of the http response. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#EsriErrorDetails) */ httpStatus: number; /** * The error message code. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#EsriErrorDetails) */ messageCode: string; /** * Additional error message(s). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#EsriErrorDetails) */ messages: string[]; /** * The raw error object if the server returned a JSON error, or the response text otherwise. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#EsriErrorDetails) */ raw: any | string; /** * The options used in the http request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#EsriErrorDetails) */ requestOptions: RequestOptions; /** * Indicates if the request required https. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#EsriErrorDetails) */ ssl: boolean; /** * The error message subcode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#EsriErrorDetails) */ subCode: number; /** * The URL of the request that returned an error message. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#EsriErrorDetails) */ url: string; } export type GetAllHeaders = () => string[][]; export type GetHeader = (headerName: string) => string; /** * An object with the following properties that describe the request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) */ export interface RequestOptions { /** * Indicates if and how requests to ArcGIS Services are authenticated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) */ authMode?: "auto" | "anonymous" | "immediate" | "no-prompt"; /** * If uploading a file, specify the form data or element used to submit the file here. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) */ body?: FormData | HTMLFormElement | string; /** * If `true`, the browser will send a request to the server instead of using the browser's local cache. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) */ cacheBust?: boolean; /** * Headers to use for the request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) */ headers?: any; /** * Indicates if the request should be made using the HTTP DELETE, HEAD, POST, or PUT method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) */ method?: "auto" | "delete" | "head" | "post" | "put"; /** * Query parameters for the request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) */ query?: any | URLSearchParams; /** * Response format. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) */ responseType?: "json" | "text" | "array-buffer" | "blob" | "image" | "native" | "document" | "xml"; /** * [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) */ signal?: AbortSignal; /** * Indicates the amount of time in milliseconds to wait for a response from the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) */ timeout?: number; /** * Indicates the request should use the proxy. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) */ useProxy?: boolean; /** * Indicates if cross-site `Access-Control` requests should use credentials. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) */ withCredentials?: boolean; } /** * Returns a promise that resolves to an object with the following specification. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestResponse) */ export interface RequestResponse { /** * The requested data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestResponse) */ data?: any; /** * Method for getting a header sent from the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestResponse) */ getHeader?: GetHeader; /** * Method for getting all headers sent from the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestResponse) */ getAllHeaders?: GetAllHeaders; /** * _Since 4.26_ The status code of the http response. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestResponse) */ httpStatus?: number; /** * The options specified by the user in the data request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestResponse) */ requestOptions?: RequestOptions; /** * Indicates if the request required https. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestResponse) */ ssl?: boolean; /** * The URL used to request the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestResponse) */ url?: string; } /** * Helps you find closest facilities around any location (incident) on a network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-closestFacility.html) */ interface closestFacility { /** * Solves the closest facility. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-closestFacility.html#solve) */ solve(url: string, params: ClosestFacilityParameters, requestOptions?: any): Promise; } export const closestFacility: closestFacility; export class FeatureService { /** * Describes the layer's supported capabilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#capabilities) */ capabilities: FeatureServiceCapabilities; /** * Indicates whether the instance has loaded. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#loaded) */ readonly loaded: boolean; /** * The Error object returned if an error occurred while loading. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#loadError) */ readonly loadError: Error; /** * Represents the status of a [load](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#load) operation. * * @default not-loaded * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#loadStatus) */ readonly loadStatus: "not-loaded" | "loading" | "failed" | "loaded"; /** * The absolute URL of the REST endpoint for the feature service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#url) */ url: string; /** * Describes the service's userTypeExtensions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#userTypeExtensions) */ userTypeExtensions: string; /** * The url that points to the utility network layer, if it exists. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#utilityNetworkUrl) */ readonly utilityNetworkUrl: string; /** * The url to the version management service, if the data is versioned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#versionManagementServiceUrl) */ readonly versionManagementServiceUrl: string; constructor(properties?: any); /** * Applies edits to features in the feature service layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits) */ applyEdits(edits: FeatureServiceApplyEditsEdits[], options?: FeatureServiceApplyEditsOptions): Promise; /** * Triggers the loading of the feature service instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#load) */ load(): Promise; } /** * Describes the layer's supported capabilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ export interface FeatureServiceCapabilities { /** * Describes characteristics of the data in the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ data: FeatureServiceCapabilitiesData; /** * Describes editing capabilities that can be performed on the features in the layer via [applyEdits()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ editing: FeatureServiceCapabilitiesEditing; /** * Describes operations that can be performed on features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ operations: FeatureServiceCapabilitiesOperations; /** * Describes [query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) operations that can be performed on the Feature Service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ query: FeatureServiceCapabilitiesQuery; /** * Describes the synchronization capabilities of a service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ sync: CapabilitiesSync; } export interface FeatureServiceApplyEditsEdits { /** * Specifies the layer id of the layer that needs to be edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits) */ id: number; identifierFields: FeatureServiceApplyEditsEditsIdentifierFields; /** * An array or a [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of features to be added. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits) */ addFeatures?: Graphic[] | Collection; /** * An array or a [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of features to be updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits) */ updateFeatures?: Graphic[] | Collection; /** * An array or a [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of features, or an array of objects with `objectId` or `globalId` of each feature to be deleted. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits) */ deleteFeatures?: Graphic[] | Collection | any[]; /** * An array of attachments to be added. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits) */ addAttachments?: AttachmentEdit[]; /** * An array of attachments to be updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits) */ updateAttachments?: AttachmentEdit[]; /** * An array of [globalId](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#AttachmentEdit)s for attachments to be deleted. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits) */ deleteAttachments?: string[]; } export interface FeatureServiceApplyEditsEditsIdentifierFields { /** * Specifies the globalIdField of the layer being editied. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits) */ globalIdField?: string; /** * Specifies the objectIdField of the layer being edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits) */ objectIdField: string; } export interface FeatureServiceApplyEditsOptions { /** * The geodatabase version to apply the edits. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits) */ gdbVersion?: string; /** * Indicates whether the edits can be applied using globalIds of features or attachments. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits) */ globalIdUsed?: boolean; /** * Added at 10.5 and works with ArcGIS Server services only. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits) */ honorSequenceOfEdits?: boolean; /** * This option was added at 10.6. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits) */ usePreviousEditMoment?: boolean; /** * When this parameter is set to true, edits returned by the return service edits option will be in the source spatial reference of the layer they belong to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits) */ returnServiceEditsInSourceSR?: boolean; } /** * Results returned from the [applyEdits](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#ServiceEditsResult) */ export interface ServiceEditsResult { /** * The layerId of the feature layer where features were edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#ServiceEditsResult) */ id: number; /** * Results returned from an add operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#ServiceEditsResult) */ addFeatureResults: any[]; /** * Results returned from an update operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#ServiceEditsResult) */ updateFeatureResults: any[]; /** * Results returned from a delete operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#ServiceEditsResult) */ deleteFeatureResults: any[]; /** * Results returned from an add attachments operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#ServiceEditsResult) */ addAttachmentResults: any[]; /** * Results returned from an update attachments operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#ServiceEditsResult) */ updateAttachmentResults: any[]; /** * Results returned from a delete attachments operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#ServiceEditsResult) */ deleteAttachmentResults: any[]; /** * Object containing all edited features belonging to the specified layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#ServiceEditsResult) */ editedFeatures?: any[]; /** * Returns the editMoment of an edit. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#ServiceEditsResult) */ editMoment?: number; } export interface FeatureServiceCapabilitiesData { /** * Indicates if the feature service is versioned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ isVersioned: boolean; } export interface FeatureServiceCapabilitiesEditing { /** * Indicates if the `globalId` values provided by the client are used in [applyEdits](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ supportsGlobalId: boolean; /** * Indicates that the service supports returning edits in the source spatial reference of the layer they belong to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ supportsReturnServiceEditsInSourceSpatialReference: boolean; /** * Indicates if the service supports async apply edits. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ supportsAsyncApplyEdits: boolean; /** * Indicates whether the service supports splitting features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ supportsSplit: boolean; } export interface FeatureServiceCapabilitiesOperations { /** * Indicates if new features can be [added](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits) to the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ supportsAdd: boolean; /** * Indicates whether the service supports change tracking for features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ supportsChangeTracking: boolean; /** * Indicates if features can be [deleted](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits) from the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ supportsDelete: boolean; /** * Indicates if features in the service can be [edited](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ supportsEditing: boolean; /** * Indicates if features in the service can be [queried](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#queryFeatures). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ supportsQuery: boolean; /** * Indicates whether the service supports querying data elements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ supportsQueryDataElements: boolean; /** * Indicates whether the service supports querying domains. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ supportsQueryDomains: boolean; /** * Indicates whether the service supports querying contingent values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ supportsQueryContingentValues: boolean; /** * Indicates whether the service supports synchronization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ supportsSync: boolean; /** * Indicates whether the service supports updating features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ supportsUpdate: boolean; } export interface FeatureServiceCapabilitiesQuery { /** * The maximum number of records that will be returned for a given query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ maxRecordCount: number; /** * This property is used to limit the number of records returned based on a factor of the `query.maxRecordCount`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ maxRecordCountFactor: number; } export interface CapabilitiesSync { /** * Indicates whether the service supports asynchronous synchronization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ supportsAsync: boolean; /** * Indicates the supported sync data options for the service * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ supportedSyncDataOptions: CapabilitiesSyncSupportedSyncDataOptions; } export interface CapabilitiesSyncSupportedSyncDataOptions { /** * Indicates whether annotations should be included in the sync data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ annotations: boolean; /** * Indicates whether dimensions should be included in the sync data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ dimensions: boolean; /** * Indicates whether contingent values should be included in the sync data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ contingentValues: boolean; /** * Indicates whether attribute rules should be included in the sync data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ attributeRules: boolean; /** * Indicates whether the utility network system should be included in the sync data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ utilityNetworkSystem: boolean; /** * Indicates whether the full annotation model should be included in the sync data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ annotationFullModel: boolean; /** * Indicates whether 3D objects should be included in the sync data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ include3DObjects: boolean; /** * Indicates whether missing utility network layers should be included in the sync data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ utilityNetworkMissingLayers: boolean; /** * Indicates whether true curves should be preserved in the sync data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#Capabilities) */ preserveTrueCurves: boolean; } /** * Provides utility methods for creating [FeatureServices](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-utils.html) */ interface featureServiceUtils { /** * Used to create an instance of [FeatureService](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html) from an array of [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-utils.html#createFeatureServices) */ createFeatureServices(layers: FeatureLayer[]): Promise>; } export const featureServiceUtils: featureServiceUtils; /** * Results returned from the [createFeatureService](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-utils.html#createFeatureService) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-utils.html#FeatureServiceResourcesBundle) */ export interface FeatureServiceResourcesBundle { /** * Returns a featureService object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-utils.html#FeatureServiceResourcesBundle) */ featureService: FeatureService; /** * Returns an array of [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-utils.html#FeatureServiceResourcesBundle) */ layers: FeatureLayer[]; } /** * Search a map service exposed by the ArcGIS Server REST API based on a string value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-find.html) */ interface find { /** * Sends a request to the ArcGIS REST map service resource to perform a search based on the input [params](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-find.html#find) */ find(url: string, params: FindParameters | FindParametersProperties, requestOptions?: any): Promise; } export const find: find; /** * Represents geometry service resources exposed by the ArcGIS REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html) */ interface geometryService { /** * Computes the area and length for the input [polygons](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#areasAndLengths) */ areasAndLengths(url: string, areasAndLengthsParameters: AreasAndLengthsParameters, requestOptions?: any): Promise; /** * The Auto Complete operation is performed on a geometry service resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#autoComplete) */ autoComplete(url: string, polygons: Polygon[], polylines: Polyline[], requestOptions?: any): Promise; /** * Creates buffer polygons at a specified distance around the given geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#buffer) */ buffer(url: string, bufferParameters: BufferParameters, requestOptions?: any): Promise; /** * The convexHull operation is performed on a geometry service resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#convexHull) */ convexHull(url: string, geometries: Geometry[], requestOptions?: any): Promise; /** * The cut operation is performed on a geometry service resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#cut) */ cut(url: string, geometries: Geometry[], cutter: Polyline, requestOptions?: any): Promise; /** * The densify operation is performed on a geometry service resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#densify) */ densify(url: string, densifyParameters: DensifyParameters, requestOptions?: any): Promise; /** * The difference operation is performed on a geometry service resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#difference) */ difference(url: string, geometries: Geometry[], geometry: Geometry, requestOptions?: any): Promise; /** * Measures the planar or geodesic distance between geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#distance) */ distance(url: string, distanceParameters: DistanceParameters, requestOptions?: any): Promise; /** * Converts an array of well-known strings into xy-coordinates based on the conversion type and spatial reference supplied by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#fromGeoCoordinateString) */ fromGeoCoordinateString(url: string, params: geometryServiceFromGeoCoordinateStringParams, requestOptions?: any): Promise; /** * Generalizes the input geometries using the Douglas-Peucker algorithm. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#generalize) */ generalize(url: string, generalizeParameters: GeneralizeParameters, requestOptions?: any): Promise; /** * The intersect operation is performed on a geometry service resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#intersect) */ intersect(url: string, geometries: Geometry[], intersector: Geometry, requestOptions?: any): Promise; /** * Calculates an interior point for each polygon specified. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#labelPoints) */ labelPoints(url: string, polygons: Polygon[], requestOptions?: any): Promise; /** * Gets the lengths for a [Geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html) when the geometry type is [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#lengths) */ lengths(url: string, lengthsParameters: LengthsParameters, requestOptions?: any): Promise; /** * Constructs the offset of the input geometries based on a planar distance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#offset) */ offset(url: string, offsetParameters: OffsetParameters, requestOptions?: any): Promise; /** * Projects a set of geometries to a new spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#project) */ project(url: string, projectParameters: ProjectParameters, requestOptions?: any): Promise; /** * Computes the set of pairs of geometries from the input geometry arrays that belong to the specified relation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#relation) */ relation(url: string, relationParameters: RelationParameters, requestOptions?: any): Promise; /** * The reshape operation is performed on a geometry service resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#reshape) */ reshape(url: string, geometry: Geometry, reshaper: Polyline, requestOptions?: any): Promise; /** * Alters the given geometries to make their definitions topologically legal with respect to their geometry type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#simplify) */ simplify(url: string, geometries: Geometry[], requestOptions?: any): Promise; /** * Converts an array of XY-coordinates into well-known strings based on the conversion type and spatial reference supplied by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#toGeoCoordinateString) */ toGeoCoordinateString(url: string, params: geometryServiceToGeoCoordinateStringParams, requestOptions?: any): Promise; /** * Trims or extends the input polylines using the user specified guide polyline. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#trimExtend) */ trimExtend(url: string, trimExtendParameters: TrimExtendParameters, requestOptions?: any): Promise; /** * The union operation is performed on a geometry service resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#union) */ union(url: string, geometries: Geometry[], requestOptions?: any): Promise; } export const geometryService: geometryService; export interface geometryServiceFromGeoCoordinateStringParams { /** * An array of formatted strings as specified by `conversionType`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#fromGeoCoordinateString) */ strings: string[]; /** * The spatial reference or well-known ID to convert the input string coordinates to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#fromGeoCoordinateString) */ sr: SpatialReference | string | number; /** * The conversion type of the input strings. * * @default mrgs * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#fromGeoCoordinateString) */ conversionType?: "mrgs" | "usng" | "utm" | "geo-ref" | "gars" | "dms" | "ddm" | "dd"; /** * Conversion options for mrgs, utm and gars conversion types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#fromGeoCoordinateString) */ conversionMode?: string; } export interface geometryServiceToGeoCoordinateStringParams { /** * The spatial reference (or WKID of the spatial reference) of the XY-coordinates to be converted. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#toGeoCoordinateString) */ sr: SpatialReference | string | number; /** * An array of XY-coordinates (in JSON format) to be converted. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#toGeoCoordinateString) */ coordinates: number[][]; /** * The conversion type of the input strings. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#toGeoCoordinateString) */ conversionType: "mgrs" | "usng" | "utm" | "geo-ref" | "gars" | "dms" | "ddm" | "dd"; /** * Conversion options for mgrs and utm conversion types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#toGeoCoordinateString) */ conversionMode?: string; /** * The number of digits to output for each of the numerical portions in the string. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#toGeoCoordinateString) */ numOfDigits?: number; /** * If `true`, then numeric portions of the string are rounded to the nearest whole magnitude as specified by `numOfDigits`. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#toGeoCoordinateString) */ rounding?: boolean; /** * If `true`, then spaces are added between components of the string. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#toGeoCoordinateString) */ addSpaces?: boolean; } /** * Represents a GP resource exposed by the ArcGIS REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geoprocessor.html) */ interface geoprocessor { /** * Sends a request to the server to execute a synchronous GP task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geoprocessor.html#execute) */ execute(url: string, params?: any, options?: GPOptions, requestOptions?: any): Promise; /** * Submits a job to the server for asynchronous processing by the GP task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geoprocessor.html#submitJob) */ submitJob(url: string, params?: any, options?: GPOptions, requestOptions?: any): Promise; } export const geoprocessor: geoprocessor; /** * A convenience module for providing input options for the geoprocessing service return values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geoprocessor-GPOptions.html) */ interface GPOptions { /** * The spatial reference of the output geometries. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geoprocessor-GPOptions.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * ProcessExtent, if specified, will only process features that overlap this extent. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geoprocessor-GPOptions.html#processExtent) */ processExtent: Extent; /** * The spatial reference that the model will use to perform geometry operations. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geoprocessor-GPOptions.html#processSpatialReference) */ processSpatialReference: SpatialReference; /** * When `true`, individual values in a value table will be prefixed with the associated column name. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geoprocessor-GPOptions.html#returnColumnName) */ returnColumnName: boolean; /** * If `true`, m-values will be included in the results if the features have m-values. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geoprocessor-GPOptions.html#returnM) */ returnM: boolean; /** * If `true`, z-values will be included in the results if the features have z-values. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geoprocessor-GPOptions.html#returnZ) */ returnZ: boolean; } export const GPOptions: GPOptions; /** * Performs an identify operation on the layers of a map service exposed by the ArcGIS Server REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-identify.html) */ interface identify { /** * Sends a request to the ArcGIS REST map service resource to identify features based on the [IdentifyParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html) specified. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-identify.html#identify) */ identify(url: string, params: IdentifyParameters, requestOptions?: any): Promise; } export const identify: identify; /** * Performs various operations on an image service resource: * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html) */ interface imageService { /** * Computes the rotation angle of a [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html) at a given location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#computeAngles) */ computeAngles(url: string, parameters: ImageAngleParameters | ImageAngleParametersProperties, requestOptions?: any): Promise; /** * Computes histograms based on the provided [ImageHistogramParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#computeHistograms) */ computeHistograms(url: string, parameters: ImageHistogramParameters | ImageHistogramParametersProperties, requestOptions?: any): Promise; /** * Computes the corresponding pixel location in columns and rows for an [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html) based on input geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#computePixelSpaceLocations) */ computePixelSpaceLocations(url: string, parameters: ImagePixelLocationParameters, requestOptions?: any): Promise; /** * Computes [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterBandStatistics) and [histograms](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#RasterHistogram) for the provided [ImageHistogramParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#computeStatisticsHistograms) */ computeStatisticsHistograms(url: string, parameters: ImageHistogramParameters | ImageHistogramParametersProperties, requestOptions?: any): Promise; /** * Finds images based on the provided [FindImagesParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindImagesParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#findImages) */ findImages(url: string, parameters: FindImagesParameters | FindImagesParametersProperties, requestOptions?: any): Promise; /** * Returns sample point locations, pixel values and corresponding resolutions of the source data for a given geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#getSamples) */ getSamples(url: string, parameters: ImageSampleParameters | ImageSampleParametersProperties, requestOptions?: any): Promise; /** * Sends a request to the ArcGIS REST image service resource to identify content based on the [ImageIdentifyParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html) specified in the `params` argument. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#identify) */ identify(url: string, params: ImageIdentifyParameters, requestOptions?: any): Promise; /** * Convert a geometry from an image space to a map space using the provided [ImageToMapParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#imageToMap) */ imageToMap(url: string, parameters: ImageToMapParameters | ImageToMapParametersProperties, requestOptions?: any): Promise; /** * Creates a map space geometry from multiray image space geometries using the provided [ImageToMapMultirayParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapMultirayParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#imageToMapMultiray) */ imageToMapMultiray(url: string, parameters: ImageToMapMultirayParameters | ImageToMapMultirayParametersProperties, requestOptions?: any): Promise; /** * Converts a given geometry from a map space to an image space using the provided [MapToImageParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MapToImageParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#mapToImage) */ mapToImage(url: string, parameters: MapToImageParameters | MapToImageParametersProperties, requestOptions?: any): Promise; /** * Calculates the area and perimeter of a given geometry on an image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#measureAreaAndPerimeter) */ measureAreaAndPerimeter(url: string, parameters: ImageAreaParameters | ImageAreaParametersProperties, requestOptions?: any): Promise; /** * Measures the area and the perimeter of a polygon in an image space on a selected raster when the following conditions are met: * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#measureAreaFromImage) */ measureAreaFromImage(url: string, parameters: MeasureFromImageParameters | MeasureFromImageParametersProperties, requestOptions?: any): Promise; /** * Calculates the distance and angle between two points on an image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#measureDistanceAndAngle) */ measureDistanceAndAngle(url: string, parameters: ImageDistanceParameters | ImageDistanceParametersProperties, requestOptions?: any): Promise; /** * Calculates the height of an object between two points on an image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#measureHeight) */ measureHeight(url: string, parameters: ImageHeightParameters | ImageHeightParametersProperties, requestOptions?: any): Promise; /** * Measures the length of a polyline in an image space on a selected raster when the following conditions are met: * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#measureLengthFromImage) */ measureLengthFromImage(url: string, parameters: MeasureFromImageParameters | MeasureFromImageParametersProperties, requestOptions?: any): Promise; /** * Returns the location for a given point or centroid of a given area on an image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#measurePointOrCentroid) */ measurePointOrCentroid(parameters: ImagePointParameters | ImagePointParametersProperties, requestOptions?: any): Promise; /** * Returns the boundary of an image for the provided [ImageBoundaryParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageBoundaryParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#queryBoundary) */ queryBoundary(url: string, parameters: ImageBoundaryParameters | ImageBoundaryParametersProperties, requestOptions?: any): Promise; /** * Returns GPS information for the provided [ImageGPSInfoParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfoParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#queryGPSInfo) */ queryGPSInfo(url: string, parameters: ImageGPSInfoParameters | ImageGPSInfoParametersProperties, requestOptions?: any): Promise; } export const imageService: imageService; export interface DataModel extends Accessor, JSONSupport { } export class DataModel { /** * Indicates if the data in the graph is managed by ArcGIS Knowledge. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-DataModel.html#arcgisManaged) */ readonly arcgisManaged: boolean; /** * A list of the [entity types](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) contained in the knowledge graph including their associated properties. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-DataModel.html#entityTypes) */ readonly entityTypes: EntityType[]; /** * Information about the global ID for the knowledge graph. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-DataModel.html#identifierInfo) */ readonly identifierInfo: DataModelIdentifierInfo; /** * A list of the [relationship types](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html) in the knowledge graph including their associated properties. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-DataModel.html#relationshipTypes) */ readonly relationshipTypes: RelationshipType[]; /** * List of the search indexes in the knowledge graph. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-DataModel.html#searchIndexes) */ readonly searchIndexes: SearchIndex[]; /** * Specifies [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) information for the knowledge graph. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-DataModel.html#spatialReference) */ readonly spatialReference: SpatialReference; /** * Indicates whether users can make changes to the data model. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-DataModel.html#strict) */ readonly strict: boolean; /** * The date the data model was last updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-DataModel.html#timestamp) */ readonly timestamp: Date; /** * The data model defines the [entity types](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) and [relationship types](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html) in a knowledge graph service as well as some additional settings. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-DataModel.html) */ constructor(properties?: DataModelProperties); static fromJSON(json: any): DataModel; } interface DataModelProperties { } export interface DataModelIdentifierInfo { /** * Information on the type and format of the universally unique identifier * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-DataModel.html#identifierInfo) */ identifierMappingInfo: DataModelIdentifierInfoIdentifierMappingInfo; /** * Information on how the unique identifier is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-DataModel.html#identifierInfo) */ identifierGenerationInfo: any; /** * Information on the format of the unique identifier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-DataModel.html#identifierInfo) */ uuidMethodHint: "esriUUIDESRI" | "UUID_RFC_4122"; } export interface DataModelIdentifierInfoIdentifierMappingInfo { /** * Indicates the type of the ID. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-DataModel.html#identifierInfo) */ identifierInfoType: "esriIdentifierInfoTypeUniformProperty" | "esriIdentifierInfoTypeDatabaseNative"; /** * Properties of database native identifier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-DataModel.html#identifierInfo) */ databaseNativeIdentifier: any; /** * Properties of the user defined unique identifier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-DataModel.html#identifierInfo) */ uniformPropertyIdentifier: DataModelIdentifierInfoIdentifierMappingInfoUniformPropertyIdentifier; } export interface DataModelIdentifierInfoIdentifierMappingInfoUniformPropertyIdentifier { /** * The name of the unique identifier property for all records. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-DataModel.html#identifierInfo) */ identifierPropertyName: string; } export class Entity extends GraphNamedObject { /** * An entity is a specific instance of an [EntityType](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) that can exist in the [knowledge graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html) */ constructor(properties?: EntityProperties); static fromJSON(json: any): Entity; } interface EntityProperties extends GraphNamedObjectProperties { } export class EntityType extends GraphObjectType { /** * An entity type defines a homogeneous collection of [entities](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html) with a common set of properties and a spatial feature type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) */ constructor(properties?: EntityTypeProperties); static fromJSON(json: any): EntityType; } interface EntityTypeProperties extends GraphObjectTypeProperties { } export interface FieldIndex extends Accessor, JSONSupport { } export class FieldIndex { /** * Specifies if the field is indexed in ascending order. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-FieldIndex.html#ascending) */ ascending: boolean; /** * Description of the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-FieldIndex.html#description) */ description: string; /** * The ordered field names included in this index. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-FieldIndex.html#fieldNames) */ fieldNames: string[]; /** * The name of the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-FieldIndex.html#name) */ name: string; /** * Specifies if the values in the field are unique (no duplicate values). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-FieldIndex.html#unique) */ unique: boolean; /** * Defines an index on fields associated with an [entity type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) or [relationship type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-FieldIndex.html) */ constructor(properties?: FieldIndexProperties); static fromJSON(json: any): FieldIndex; } interface FieldIndexProperties { /** * Specifies if the field is indexed in ascending order. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-FieldIndex.html#ascending) */ ascending?: boolean; /** * Description of the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-FieldIndex.html#description) */ description?: string; /** * The ordered field names included in this index. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-FieldIndex.html#fieldNames) */ fieldNames?: string[]; /** * The name of the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-FieldIndex.html#name) */ name?: string; /** * Specifies if the values in the field are unique (no duplicate values). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-FieldIndex.html#unique) */ unique?: boolean; } export class GraphApplyEdits extends Accessor { /** * A list of [entities](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html) to add to the [knowledge graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEdits.html#entityAdds) */ entityAdds: Entity[]; /** * A list of objects containing an [entity type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) and the ids of the [entities](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html) of that type to delete. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEdits.html#entityDeletes) */ entityDeletes: GraphNamedObjectDeletes[]; /** * A list of [entities](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html) with the modified properties to update in the [knowledge graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEdits.html#entityUpdates) */ entityUpdates: Entity[]; /** * Additional options to set an [input quantization](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-InputQuantizationParameters.html) for any geometries being added to the graph and to automatically delete all relationships associated with a deleted entity. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEdits.html#options) */ options: GraphApplyEditsOptions; /** * A list of [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html) to add to the [knowledge graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEdits.html#relationshipAdds) */ relationshipAdds: knowledgeGraphRelationship[]; /** * A list of objects containing a [relationship type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html), and the ids of the [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html) of that type to delete. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEdits.html#relationshipDeletes) */ relationshipDeletes: GraphNamedObjectDeletes[]; /** * A list of [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html) with modified properties to update in the [knowledge graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEdits.html#relationshipUpdates) */ relationshipUpdates: knowledgeGraphRelationship[]; /** * This class defines [entities](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html) and [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html) to add, delete, and update in a knowledge graph service's [graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html) resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEdits.html) */ constructor(properties?: GraphApplyEditsProperties); } interface GraphApplyEditsProperties { /** * A list of [entities](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html) to add to the [knowledge graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEdits.html#entityAdds) */ entityAdds?: EntityProperties[]; /** * A list of objects containing an [entity type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) and the ids of the [entities](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html) of that type to delete. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEdits.html#entityDeletes) */ entityDeletes?: GraphNamedObjectDeletes[]; /** * A list of [entities](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html) with the modified properties to update in the [knowledge graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEdits.html#entityUpdates) */ entityUpdates?: EntityProperties[]; /** * Additional options to set an [input quantization](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-InputQuantizationParameters.html) for any geometries being added to the graph and to automatically delete all relationships associated with a deleted entity. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEdits.html#options) */ options?: GraphApplyEditsOptions; /** * A list of [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html) to add to the [knowledge graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEdits.html#relationshipAdds) */ relationshipAdds?: knowledgeGraphRelationshipProperties[]; /** * A list of objects containing a [relationship type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html), and the ids of the [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html) of that type to delete. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEdits.html#relationshipDeletes) */ relationshipDeletes?: GraphNamedObjectDeletes[]; /** * A list of [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html) with modified properties to update in the [knowledge graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEdits.html#relationshipUpdates) */ relationshipUpdates?: knowledgeGraphRelationshipProperties[]; } export interface GraphApplyEditsOptions { /** * Custom [quantization parameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-InputQuantizationParameters.html) for input geometry that compresses geometry for transfer to the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEdits.html#options) */ inputQuantizationParameters: InputQuantizationParameters; /** * If `true`, deleting an entity will automatically delete all relationships connected to that entity. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEdits.html#options) */ cascadeDelete: boolean; } /** * GraphNamedObjectDeletes represents the list of [GraphNamedObjects](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphNamedObject.html) ([entities](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html) or [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html)) of a specific type that will be deleted from a knowledge graph. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEdits.html#GraphNamedObjectDeletes) */ export interface GraphNamedObjectDeletes { /** * The name of the [EntityType](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) that the entities belongs to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEdits.html#GraphNamedObjectDeletes) */ typeName: string; /** * A list of the ids of the specified type to delete. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEdits.html#GraphNamedObjectDeletes) */ ids: string[]; } export class GraphApplyEditsResult extends Accessor { /** * Returns a list of objects for each [entity type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) or [relationship type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html) that added, updated or deleted records by [executeApplyEdits()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeApplyEdits). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEditsResult.html#editResults) */ editResults: EditResultsObject[]; /** * The error message explaining information about why [executeApplyEdits()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeApplyEdits) failed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEditsResult.html#error) */ error: GraphApplyEditsResultError; /** * If `true` there was an error processing [executeApplyEdits()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeApplyEdits). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEditsResult.html#hasError) */ hasError: any; /** * The result of an [executeApplyEdits()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeApplyEdits) performed on a knowledge graph service's [graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html) resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEditsResult.html) */ constructor(properties?: GraphApplyEditsResultProperties); } interface GraphApplyEditsResultProperties { /** * Returns a list of objects for each [entity type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) or [relationship type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html) that added, updated or deleted records by [executeApplyEdits()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeApplyEdits). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEditsResult.html#editResults) */ editResults?: EditResultsObject[]; /** * The error message explaining information about why [executeApplyEdits()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeApplyEdits) failed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEditsResult.html#error) */ error?: GraphApplyEditsResultError; /** * If `true` there was an error processing [executeApplyEdits()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeApplyEdits). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEditsResult.html#hasError) */ hasError?: any; } /** * editResultsObject returns a list of all [entities](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html) and [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html) of each [type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphObjectType.html) that was added, updated or deleted from the [KnowledgeGraph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html) as well as any errors that occurred during the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEditsResult.html#editResultsObject) */ export interface EditResultsObject { /** * The name of the [EntityType](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) or [RelationshipType](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html) that had changed items. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEditsResult.html#editResultsObject) */ typeName: string; /** * A list of objects containing the id and error information for every added entity or relationship. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEditsResult.html#editResultsObject) */ adds: NamedObjectEditResults[]; /** * A list of objects containing the id and error information for every updated entity or relationship. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEditsResult.html#editResultsObject) */ updates: NamedObjectEditResults[]; /** * A list of objects containing the id and error information for every deleted entity or relationship. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEditsResult.html#editResultsObject) */ deletes: NamedObjectEditResults[]; } export interface GraphApplyEditsResultError { /** * Error code returned from the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEditsResult.html#error) */ errorCode: any; /** * Description of the error. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEditsResult.html#error) */ errorMessage: string; } /** * NamedObjectEditResults contains the `id` of the [GraphNamedObject](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphNamedObject.html) ([Entity](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html) or [Relationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html)) that was added, updated or deleted from the [KnowledgeGraph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html) as well as any errors that occurred during the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEditsResult.html#NamedObjectEditResults) */ export interface NamedObjectEditResults { /** * The id of the [Entity](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html) or [Relationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html) that was added, updated or deleted from the knowledge graph. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEditsResult.html#NamedObjectEditResults) */ id: string; /** * Indicates any errors caused during the operation applied to this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEditsResult.html#NamedObjectEditResults) */ error: NamedObjectEditResultsError; } export interface NamedObjectEditResultsError { /** * Error code returned from the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEditsResult.html#NamedObjectEditResults) */ errorCode: any; /** * Description of the error. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphApplyEditsResult.html#NamedObjectEditResults) */ errorMessage: string; } export class GraphNamedObject extends GraphObject { /** * The unique ID of the object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphNamedObject.html#id) */ id: string; /** * Specifies the name for all similar types of objects ([entities](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html) or [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html)) defined in the knowledge graph. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphNamedObject.html#typeName) */ typeName: string; /** * The parent class for an [Entity](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html) or [Relationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html) that is defined in the graph schema. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphNamedObject.html) */ constructor(properties?: GraphNamedObjectProperties); static fromJSON(json: any): GraphNamedObject; } interface GraphNamedObjectProperties extends GraphObjectProperties { /** * The unique ID of the object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphNamedObject.html#id) */ id?: string; /** * Specifies the name for all similar types of objects ([entities](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html) or [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html)) defined in the knowledge graph. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphNamedObject.html#typeName) */ typeName?: string; } export interface GraphObject extends Accessor, JSONSupport { } export class GraphObject { /** * The properties of the graph object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphObject.html#properties) */ properties: any; /** * This is the parent class of all objects that can be represented on a graph structure or graph query - [Entity](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html), [Relationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html), [Path](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Path.html), and anonymous object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphObject.html) */ constructor(properties?: GraphObjectProperties); static fromJSON(json: any): GraphObject; } interface GraphObjectProperties { /** * The properties of the graph object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphObject.html#properties) */ properties?: any; } export interface GraphObjectType extends Accessor, JSONSupport { } export class GraphObjectType { /** * The display name of the graph object type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphObjectType.html#alias) */ alias: string; /** * Specifies [index fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-FieldIndex.html) for a graph object type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphObjectType.html#fieldIndexes) */ fieldIndexes: FieldIndex[]; /** * The name of the graph object type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphObjectType.html#name) */ name: string; /** * Specifies the [properties](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html) of a graph object type such as an [EntityType](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) or [RelationshipType](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphObjectType.html#properties) */ properties: GraphProperty[]; /** * The object type's role in the knowledge graph. * * @default "Regular" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphObjectType.html#role) */ role: string; /** * Parent object for [entity types](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) and [relationship types](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html) defined in the graph schema. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphObjectType.html) */ constructor(properties?: GraphObjectTypeProperties); static fromJSON(json: any): GraphObjectType; } interface GraphObjectTypeProperties { /** * The display name of the graph object type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphObjectType.html#alias) */ alias?: string; /** * Specifies [index fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-FieldIndex.html) for a graph object type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphObjectType.html#fieldIndexes) */ fieldIndexes?: FieldIndexProperties[]; /** * The name of the graph object type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphObjectType.html#name) */ name?: string; /** * Specifies the [properties](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html) of a graph object type such as an [EntityType](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) or [RelationshipType](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphObjectType.html#properties) */ properties?: GraphPropertyProperties[]; /** * The object type's role in the knowledge graph. * * @default "Regular" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphObjectType.html#role) */ role?: string; } export interface GraphProperty extends Accessor, JSONSupport { } export class GraphProperty { /** * The display name for the property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#alias) */ alias: string; /** * Specifies a default value for the object type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#defaultValue) */ defaultValue: any; /** * Specifies whether the property is visible by default. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#defaultVisibility) */ defaultVisibility: boolean; /** * Specifies whether the property is editable. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#editable) */ editable: boolean; /** * Specifies the field type for the property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#fieldType) */ fieldType: | "esriFieldTypeSmallInteger" | "esriFieldTypeInteger" | "esriFieldTypeSingle" | "esriFieldTypeDouble" | "esriFieldTypeString" | "esriFieldTypeDate" | "esriFieldTypeOID" | "esriFieldTypeGeometry" | "esriFieldTypeBlob" | "esriFieldTypeRaster" | "esriFieldTypeGUID" | "esriFieldTypeGlobalID" | "esriFieldTypeXML" | "esriFieldTypeBigInteger" | "esriFieldTypeTimestampOffset" | "esriFieldTypeTimeOnly" | "esriFieldTypeDateOnly"; /** * Specifies the geometry type for the property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#geometryType) */ geometryType: string; /** * Specifies whether the property has an m-value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#hasM) */ hasM: boolean; /** * Specifies whether property has a z-value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#hasZ) */ hasZ: boolean; /** * The name of the property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#name) */ name: string; /** * Specifies whether the property can be `null`. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#nullable) */ nullable: boolean; /** * Specifies whether the property is required. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#required) */ required: boolean; /** * Specifies the role of the property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#role) */ role: | "esriGraphPropertyRegular" | "esriGraphPropertyDocumentName" | "esriGraphPropertyDocumentTitle" | "esriGraphPropertyDocumentUrl" | "esriGraphPropertyDocumentText" | "esriGraphPropertyDocumentKeywords" | "esriGraphPropertyDocumentContentType" | "esriGraphPropertyDocumentMetadata" | "esriGraphPropertyDocumentFileExtension"; /** * Specifies if the property is system maintained. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#systemMaintained) */ systemMaintained: boolean; /** * Specifies the properties of for [entity types](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) and [relationship types](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html) defined in the graph schema by the [data model](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-DataModel.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html) */ constructor(properties?: GraphPropertyProperties); static fromJSON(json: any): GraphProperty; } interface GraphPropertyProperties { /** * The display name for the property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#alias) */ alias?: string; /** * Specifies a default value for the object type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#defaultValue) */ defaultValue?: any; /** * Specifies whether the property is visible by default. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#defaultVisibility) */ defaultVisibility?: boolean; /** * Specifies whether the property is editable. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#editable) */ editable?: boolean; /** * Specifies the field type for the property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#fieldType) */ fieldType?: | "esriFieldTypeSmallInteger" | "esriFieldTypeInteger" | "esriFieldTypeSingle" | "esriFieldTypeDouble" | "esriFieldTypeString" | "esriFieldTypeDate" | "esriFieldTypeOID" | "esriFieldTypeGeometry" | "esriFieldTypeBlob" | "esriFieldTypeRaster" | "esriFieldTypeGUID" | "esriFieldTypeGlobalID" | "esriFieldTypeXML" | "esriFieldTypeBigInteger" | "esriFieldTypeTimestampOffset" | "esriFieldTypeTimeOnly" | "esriFieldTypeDateOnly"; /** * Specifies the geometry type for the property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#geometryType) */ geometryType?: string; /** * Specifies whether the property has an m-value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#hasM) */ hasM?: boolean; /** * Specifies whether property has a z-value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#hasZ) */ hasZ?: boolean; /** * The name of the property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#name) */ name?: string; /** * Specifies whether the property can be `null`. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#nullable) */ nullable?: boolean; /** * Specifies whether the property is required. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#required) */ required?: boolean; /** * Specifies the role of the property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#role) */ role?: | "esriGraphPropertyRegular" | "esriGraphPropertyDocumentName" | "esriGraphPropertyDocumentTitle" | "esriGraphPropertyDocumentUrl" | "esriGraphPropertyDocumentText" | "esriGraphPropertyDocumentKeywords" | "esriGraphPropertyDocumentContentType" | "esriGraphPropertyDocumentMetadata" | "esriGraphPropertyDocumentFileExtension"; /** * Specifies if the property is system maintained. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html#systemMaintained) */ systemMaintained?: boolean; } export class GraphQuery extends Accessor { /** * The Esri implementation of [openCypher](https://opencypher.org/) query to be executed against the knowledge graph. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphQuery.html#openCypherQuery) */ openCypherQuery: string; /** * Defines the query operation performed on a knowledge graph service's [graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html) resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphQuery.html) */ constructor(properties?: GraphQueryProperties); } interface GraphQueryProperties { /** * The Esri implementation of [openCypher](https://opencypher.org/) query to be executed against the knowledge graph. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphQuery.html#openCypherQuery) */ openCypherQuery?: string; } export class GraphQueryResult extends Accessor { /** * An array of the result types that are returned from a search or query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphQueryResult.html#resultRows) */ resultRows: ( | Path | GraphObject | Geometry | Date | string | number | null | (Path | GraphObject | Geometry | Date | string | number | null)[] )[][]; /** * The results of a [executeQuery()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeQuery) or [executeSearch()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeSearch) on a knowledge graph service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphQueryResult.html) */ constructor(properties?: GraphQueryResultProperties); } interface GraphQueryResultProperties { /** * An array of the result types that are returned from a search or query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphQueryResult.html#resultRows) */ resultRows?: ( | PathProperties | GraphObjectProperties | GeometryProperties | DateProperties | string | number | null | (PathProperties | GraphObjectProperties | GeometryProperties | DateProperties | string | number | null)[] )[][]; } export class GraphQueryStreaming extends GraphQuery { /** * Custom quantization parameters for input geometry that compresses geometry for transfer to the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphQueryStreaming.html#bindGeometryQuantizationParameters) */ bindGeometryQuantizationParameters: InputQuantizationParameters; /** * Specifies a set of parameters containing data to be included in the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphQueryStreaming.html#bindParameters) */ bindParameters: HashMap< HashMap | number | string | Date | Geometry | (HashMap | number | string | Date | Geometry)[] >; /** * Used to project the geometry onto a virtual grid, likely representing pixels on the screen. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphQueryStreaming.html#outputQuantizationParameters) */ outputQuantizationParameters: OutputQuantizationParameters; /** * Defines a streaming query operation performed on a [knowledge graph service's](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html) [graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html) resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphQueryStreaming.html) */ constructor(properties?: GraphQueryStreamingProperties); } interface GraphQueryStreamingProperties extends GraphQueryProperties { /** * Custom quantization parameters for input geometry that compresses geometry for transfer to the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphQueryStreaming.html#bindGeometryQuantizationParameters) */ bindGeometryQuantizationParameters?: InputQuantizationParametersProperties; /** * Specifies a set of parameters containing data to be included in the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphQueryStreaming.html#bindParameters) */ bindParameters?: HashMap< | HashMap | number | string | DateProperties | GeometryProperties | (HashMap | number | string | DateProperties | GeometryProperties)[] >; /** * Used to project the geometry onto a virtual grid, likely representing pixels on the screen. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphQueryStreaming.html#outputQuantizationParameters) */ outputQuantizationParameters?: OutputQuantizationParametersProperties; } export class GraphQueryStreamingResult extends Accessor { /** * Readable stream of objects matching [executeSearchStreaming()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeSearchStreaming) or [executeQueryStreaming()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeQueryStreaming) criteria. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphQueryStreamingResult.html#resultRowsStream) */ resultRowsStream: any; /** * The result of a [executeSearchStreaming()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeSearchStreaming) or [executeQueryStreaming()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeQueryStreaming) on a knowledge graph service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphQueryStreamingResult.html) */ constructor(properties?: GraphQueryStreamingResultProperties); } interface GraphQueryStreamingResultProperties { /** * Readable stream of objects matching [executeSearchStreaming()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeSearchStreaming) or [executeQueryStreaming()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeQueryStreaming) criteria. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphQueryStreamingResult.html#resultRowsStream) */ resultRowsStream?: any; } export class GraphSearch extends Accessor { /** * The text to search for in the knowledge graph. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphSearch.html#searchQuery) */ searchQuery: string; /** * Specifies whether to search [entities](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html), [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html), or both. * * @default "both" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphSearch.html#typeCategoryFilter) */ typeCategoryFilter: "entity" | "relationship" | "both"; /** * The search operation is performed on a [knowledge graph service's](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html) [graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html) resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphSearch.html) */ constructor(properties?: GraphSearchProperties); } interface GraphSearchProperties { /** * The text to search for in the knowledge graph. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphSearch.html#searchQuery) */ searchQuery?: string; /** * Specifies whether to search [entities](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html), [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html), or both. * * @default "both" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphSearch.html#typeCategoryFilter) */ typeCategoryFilter?: "entity" | "relationship" | "both"; } export class GraphSearchStreaming extends GraphSearch { /** * Specifies list of IDs to search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphSearchStreaming.html#idsFilter) */ idsFilter: string[]; /** * Specifies list of names of [entity types](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html#name) or [relationship types](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html#name) to search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphSearchStreaming.html#namedTypesFilter) */ namedTypesFilter: string[]; /** * The maximum number of results returned from the search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphSearchStreaming.html#num) */ num: number; /** * If `true`, returns the IDs of objects that match the search, the names of the properties that matched the search term, scores and highlights of the result set. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphSearchStreaming.html#returnSearchContext) */ returnSearchContext: boolean; /** * The index of the first result to return. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphSearchStreaming.html#start) */ start: number; /** * The search operation is performed on a knowledge graph service's [graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html) resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphSearchStreaming.html) */ constructor(properties?: GraphSearchStreamingProperties); } interface GraphSearchStreamingProperties extends GraphSearchProperties { /** * Specifies list of IDs to search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphSearchStreaming.html#idsFilter) */ idsFilter?: string[]; /** * Specifies list of names of [entity types](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html#name) or [relationship types](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html#name) to search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphSearchStreaming.html#namedTypesFilter) */ namedTypesFilter?: string[]; /** * The maximum number of results returned from the search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphSearchStreaming.html#num) */ num?: number; /** * If `true`, returns the IDs of objects that match the search, the names of the properties that matched the search term, scores and highlights of the result set. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphSearchStreaming.html#returnSearchContext) */ returnSearchContext?: boolean; /** * The index of the first result to return. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphSearchStreaming.html#start) */ start?: number; } export class InputQuantizationParameters extends Accessor { /** * Origin of M-Values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-InputQuantizationParameters.html#mFalseOrigin) */ mFalseOrigin: number; /** * Number of significant digits for M-Values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-InputQuantizationParameters.html#mResolution) */ mResolution: number; /** * False origin of x values of the quantization grid. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-InputQuantizationParameters.html#xFalseOrigin) */ xFalseOrigin: number; /** * Number of significant digits for the x and y coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-InputQuantizationParameters.html#xyResolution) */ xyResolution: number; /** * False origin for y-values of the quantization grid. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-InputQuantizationParameters.html#yFalseOrigin) */ yFalseOrigin: number; /** * The false origin of the Z-values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-InputQuantizationParameters.html#zFalseOrigin) */ zFalseOrigin: number; /** * Number of significant digits of the Z-Values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-InputQuantizationParameters.html#zResolution) */ zResolution: number; /** * Custom quantization parameters for input geometry that compresses geometry for transfer to the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-InputQuantizationParameters.html) */ constructor(properties?: InputQuantizationParametersProperties); } interface InputQuantizationParametersProperties { /** * Origin of M-Values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-InputQuantizationParameters.html#mFalseOrigin) */ mFalseOrigin?: number; /** * Number of significant digits for M-Values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-InputQuantizationParameters.html#mResolution) */ mResolution?: number; /** * False origin of x values of the quantization grid. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-InputQuantizationParameters.html#xFalseOrigin) */ xFalseOrigin?: number; /** * Number of significant digits for the x and y coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-InputQuantizationParameters.html#xyResolution) */ xyResolution?: number; /** * False origin for y-values of the quantization grid. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-InputQuantizationParameters.html#yFalseOrigin) */ yFalseOrigin?: number; /** * The false origin of the Z-values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-InputQuantizationParameters.html#zFalseOrigin) */ zFalseOrigin?: number; /** * Number of significant digits of the Z-Values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-InputQuantizationParameters.html#zResolution) */ zResolution?: number; } export interface KnowledgeGraph extends Accessor, JSONSupport { } export class KnowledgeGraph { /** * The [data model](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-DataModel.html) of the knowledge graph service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html#dataModel) */ readonly dataModel: DataModel; /** * The [service definition](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html) of the knowledge graph service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html#serviceDefinition) */ readonly serviceDefinition: ServiceDefinition; /** * The url to a hosted knowledge graph. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html#url) */ url: string; /** * The knowledge graph associated with the [knowledgeGraphService](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html) */ constructor(properties?: KnowledgeGraphProperties); static fromJSON(json: any): KnowledgeGraph; } interface KnowledgeGraphProperties { /** * The url to a hosted knowledge graph. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html#url) */ url?: string; } export class OutputQuantizationParameters extends Accessor { /** * An extent defining the quantization grid bounds. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-OutputQuantizationParameters.html#extent) */ extent: OutputQuantizationParametersExtent; /** * Geometry coordinates are optimized for viewing and displaying of data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-OutputQuantizationParameters.html#quantizeMode) */ quantizeMode: "view" | "edit"; /** * The size of one pixel in the units of the [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-OutputQuantizationParameters.html#tolerance) */ tolerance: number; /** * Used to project the geometry onto a virtual grid, likely representing pixels on the screen. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-OutputQuantizationParameters.html) */ constructor(properties?: OutputQuantizationParametersProperties); } interface OutputQuantizationParametersProperties { /** * An extent defining the quantization grid bounds. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-OutputQuantizationParameters.html#extent) */ extent?: OutputQuantizationParametersExtent; /** * Geometry coordinates are optimized for viewing and displaying of data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-OutputQuantizationParameters.html#quantizeMode) */ quantizeMode?: "view" | "edit"; /** * The size of one pixel in the units of the [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-OutputQuantizationParameters.html#tolerance) */ tolerance?: number; } export interface OutputQuantizationParametersExtent { /** * Maximum horizontal grid bounds. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-OutputQuantizationParameters.html#extent) */ xmax: number; /** * Minimum horizontal grid bounds. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-OutputQuantizationParameters.html#extent) */ xmin: number; /** * Maximum vertical grid bounds. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-OutputQuantizationParameters.html#extent) */ ymax: number; /** * Minimum vertical grid bounds. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-OutputQuantizationParameters.html#extent) */ ymin: number; } export interface Path extends Accessor, JSONSupport { } export class Path { /** * Array of [entities](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html) and [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html) where the first element is the starting entity of the path, the final element is the ending entity of the path, and intermediary elements are entities and relationships connecting the two. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Path.html#path) */ path: GraphObject[]; /** * An object containing all [entities](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html) and [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html) required to traverse a graph from one entity to another. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Path.html) */ constructor(properties?: PathProperties); static fromJSON(json: any): Path; } interface PathProperties { /** * Array of [entities](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html) and [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html) where the first element is the starting entity of the path, the final element is the ending entity of the path, and intermediary elements are entities and relationships connecting the two. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Path.html#path) */ path?: GraphObjectProperties[]; } export class knowledgeGraphRelationship extends GraphNamedObject { /** * The ID of the destination entity of the relationship (i.e. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html#destinationId) */ destinationId: string; /** * The ID of the origin entity of the relationship (i.e. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html#originId) */ originId: string; /** * A relationship is an instance of a [relationship type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html) that defines an association between two [entities](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html) */ constructor(properties?: knowledgeGraphRelationshipProperties); static fromJSON(json: any): knowledgeGraphRelationship; } interface knowledgeGraphRelationshipProperties extends GraphNamedObjectProperties { /** * The ID of the destination entity of the relationship (i.e. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html#destinationId) */ destinationId?: string; /** * The ID of the origin entity of the relationship (i.e. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html#originId) */ originId?: string; } export class RelationshipType extends GraphObjectType { /** * Specifies valid origin and destination [entity type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) pairs for this relationship. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html#endPoints) */ endPoints: RelationshipTypeEndPoints[]; /** * A relationship type defines a homogenous collection of [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html) that can exist between two [entity types](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html), with a common set of properties. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html) */ constructor(properties?: RelationshipTypeProperties); static fromJSON(json: any): RelationshipType; } interface RelationshipTypeProperties extends GraphObjectTypeProperties { /** * Specifies valid origin and destination [entity type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) pairs for this relationship. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html#endPoints) */ endPoints?: RelationshipTypeEndPoints[]; } export interface RelationshipTypeEndPoints { /** * The `name` of the origin [entity type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html#endPoints) */ originEntityType: string; /** * The `name` of the destination [entity type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html#endPoints) */ destinationEntityType: string; } export class SearchIndex extends Accessor { /** * Additional analyzers for string processing during search such as support for languages. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-SearchIndex.html#analyzers) */ readonly analyzers: SearchIndexAnalyzers[]; /** * The name of the search index. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-SearchIndex.html#name) */ readonly name: string; /** * A map of the named types and their properties that are included in the search index. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-SearchIndex.html#searchProperties) */ readonly searchProperties: SearchIndexSearchProperties[]; /** * Specifies if the index supports searching entities, relationships or both. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-SearchIndex.html#supportedCategory) */ readonly supportedCategory: "esriTypeEntity" | "esriTypeRelationship" | "esriTypeBoth"; /** * Defines a search index for a [KnowledgeGraph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-SearchIndex.html) */ constructor(properties?: SearchIndexProperties); } interface SearchIndexProperties { } export interface SearchIndexAnalyzers { /** * The name of the analyzer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-SearchIndex.html#analyzers) */ name: string; } export interface SearchIndexSearchProperties { /** * The properties of the named type that are included in the search index. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-SearchIndex.html#searchProperties) */ propertyNames: string[]; } export interface ServiceDefinition extends Accessor, JSONSupport { } export class ServiceDefinition { /** * Indicates if geometry data in the graph can be modified. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#allowGeometryUpdates) */ readonly allowGeometryUpdates: boolean; /** * Specifies the operational capabilities of the knowledge graph. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#capabilities) */ readonly capabilities: string[]; /** * Copyright information for the knowledge graph. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#copyrightText) */ readonly copyrightText: string; /** * The version number of the ArcGIS Enterprise instance where the knowledge graph service is hosted. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#currentVersion) */ readonly currentVersion: number; /** * Indicates if data editing is not supported. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#dataEditingNotSupported) */ readonly dataEditingNotSupported: boolean; /** * Specifies the timezone for dateTime fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#dateFieldsTimeReference) */ readonly dateFieldsTimeReference: ServiceDefinitionDateFieldsTimeReference; /** * The description of the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#description) */ readonly description: string; /** * The maximum number of records returned by a [query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeQuery) operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#maxRecordCount) */ readonly maxRecordCount: number; /** * Indicates if the knowledge graph schema (data model) can be edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#schemaEditingNotSupported) */ readonly schemaEditingNotSupported: boolean; /** * The maximum number of records returned by a [search](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeSearch) operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#searchMaxRecordCount) */ readonly searchMaxRecordCount: number; /** * specifies the details of the index, edit, search and geometry capabilities of the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#serviceCapabilities) */ readonly serviceCapabilities: ServiceDefinitionServiceCapabilities; /** * The ArcGIS Enterprise Portal item id of the knowledge graph service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#serviceItemId) */ readonly serviceItemId: string; /** * Specifies the [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) information for the knowledge graph service. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#spatialReference) */ readonly spatialReference: SpatialReference; /** * The query formats supported by the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#supportedQueryFormats) */ readonly supportedQueryFormats: string[]; /** * Indicates if the service supports entity types with a document role. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#supportsDocuments) */ readonly supportsDocuments: boolean; /** * Indicates if the services supports search operations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#supportSearch) */ readonly supportSearch: boolean; /** * The units for the spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#units) */ readonly units: string; /** * Outlines the service capabilities for a [knowledgeGraphService](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html) */ constructor(properties?: ServiceDefinitionProperties); static fromJSON(json: any): ServiceDefinition; } interface ServiceDefinitionProperties { } export interface ServiceDefinitionDateFieldsTimeReference { /** * Indicates if datetime fields respects daylight savings. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#dateFieldsTimeReference) */ respectsDaylightSaving: boolean; /** * the timezone for all datetime fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#dateFieldsTimeReference) */ timeZone: string; } export interface ServiceDefinitionServiceCapabilities { /** * Information on the supported capabilities of indexes in the knowledge graph service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#serviceCapabilities) */ indexCapabilities: ServiceDefinitionServiceCapabilitiesIndexCapabilities; /** * Information on the supported capabilities of the the [executeApplyEdits](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeApplyEdits) operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#serviceCapabilities) */ applyEditsCapabilities: ServiceDefinitionServiceCapabilitiesApplyEditsCapabilities; /** * Information on the supported capabilities of [search](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeSearch) operations in the knowledge graph service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#serviceCapabilities) */ searchCapabilities: ServiceDefinitionServiceCapabilitiesSearchCapabilities; /** * Information on the supported capabilities of geometries in the knowledge graph service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#serviceCapabilities) */ geometryCapabilities: ServiceDefinitionServiceCapabilitiesGeometryCapabilities; } export interface ServiceDefinitionServiceCapabilitiesApplyEditsCapabilities { /** * If `true`, when an apply edits operation fails, the data will revert to it's state before the change. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#serviceCapabilities) */ graphDefaultRollbackOnFailure: boolean; } export interface ServiceDefinitionServiceCapabilitiesGeometryCapabilities { /** * The maximum bounding rectangle size along the x-axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#serviceCapabilities) */ geometryMaxBoundingRectangleSizeX: number; /** * The maximum bounding rectangle size along the y-axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#serviceCapabilities) */ geometryMaxBoundingRectangleSizeY: number; /** * Specifies if the knowledge graph service supports m-values on geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#serviceCapabilities) */ supportsMValues: number; /** * Specifies if the knowledge graph service supports z-values on geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#serviceCapabilities) */ supportsZValues: number; /** * Specifies what geometry types are supported by the graph such as `Point`, `Multipoint`, `Polyline`, `Polygon`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#serviceCapabilities) */ supportedGeometryTypes: string[]; } export interface ServiceDefinitionServiceCapabilitiesIndexCapabilities { /** * Specifies if the service supports indexes in descending order. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#serviceCapabilities) */ supportsDescendingIndex: boolean; /** * Specifies if the system supports creating unique constraints for relationship types * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#serviceCapabilities) */ supportsUniqueRelationshipConstraint: boolean; /** * Specifies if the service supports indexes on relationships. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#serviceCapabilities) */ supportsRelationshipIndex: boolean; } export interface ServiceDefinitionServiceCapabilitiesSearchCapabilities { /** * The search category filters supported by this service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#serviceCapabilities) */ searchTypeFilterCapabilities: "esriTypeEntity" | "esriTypeRelationship" | "esriTypeBoth"; /** * Specifies if search strings can contain a leading wildcard operator (`*`). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html#serviceCapabilities) */ allowLeadingWildcardQueries: boolean; } /** * A knowledge graph service is associated with several resources. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html) */ interface knowledgeGraphService { /** * Add, delete, or update [entities](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html) and [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html) in a [knowledge graph service's](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html) [graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html) resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeApplyEdits) */ executeApplyEdits(graph: KnowledgeGraph, edits: GraphApplyEdits, requestOptions?: RequestOptions): Promise; /** * Executes a query on [knowledge graph service's](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html) [graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html) resource using the Esri implementation of [openCypher](https://opencypher.org/) and returns the results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeQuery) */ executeQuery(graph: KnowledgeGraph, queryArguments: GraphQuery, requestOptions?: RequestOptions): Promise; /** * Execute a streaming query on a [knowledge graph service's](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html) [graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html) resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeQueryStreaming) */ executeQueryStreaming(graph: KnowledgeGraph, queryArguments: GraphQueryStreaming, requestOptions?: RequestOptions): Promise; /** * Search the knowledge graph using a full-text index that is automatically built on the property values in the graph and returns the result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeSearch) */ executeSearch(graph: KnowledgeGraph, searchArguments: GraphSearch, requestOptions?: RequestOptions): Promise; /** * Execute a streaming search on a [knowledge graph service's](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html) [graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html) resource. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeSearchStreaming) */ executeSearchStreaming(graph: KnowledgeGraph, searchArguments: GraphSearchStreaming, requestOptions?: any): Promise; /** * Retrieves the knowledge graph service based on the URL provided. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#fetchKnowledgeGraph) */ fetchKnowledgeGraph(url: string): Promise; /** * Refreshes the [data model](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-DataModel.html) of the [knowledge graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#refreshDataModel) */ refreshDataModel(graph: KnowledgeGraph): void; } export const knowledgeGraphService: knowledgeGraphService; /** * A convenience module for importing [locator](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html) functions when developing with [TypeScript](https://developers.arcgis.com/javascript/latest/typescript-setup/). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html) */ interface locator { /** * Find address candidates for multiple input addresses. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#addressesToLocations) */ addressesToLocations(url: string, params: locatorAddressesToLocationsParams, requestOptions?: any): Promise; /** * Sends a request to the ArcGIS REST geocode resource to find candidates for a single address specified in the address parameter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#addressToLocations) */ addressToLocations(url: string, params: locatorAddressToLocationsParams, requestOptions?: any): Promise; /** * Locates an address based on a given point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#locationToAddress) */ locationToAddress(url: string, params: locatorLocationToAddressParams, requestOptions?: any): Promise; /** * Get character by character auto complete suggestions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#suggestLocations) */ suggestLocations(url: string, params: locatorSuggestLocationsParams, requestOptions?: any): Promise; } export const locator: locator; export interface locatorAddressesToLocationsParams { /** * The input addresses in the format supported by the geocode service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#addressesToLocations) */ addresses: any[]; /** * Limits the results to only search in the country provided. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#addressesToLocations) */ countryCode?: string; /** * Limit result to one or more categories. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#addressesToLocations) */ categories?: string[]; /** * Define the type of location, either `"street"` or `"rooftop"`, of the point returned from the [World Geocoding Service](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#addressesToLocations) */ locationType?: string; /** * The spatial reference of the output geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#addressesToLocations) */ outSpatialReference?: SpatialReference; } export interface locatorAddressToLocationsParams { /** * The address argument is data object that contains properties representing the various address fields accepted by the corresponding geocode service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#addressToLocations) */ address: any; /** * Limit result to one or more categories. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#addressToLocations) */ categories?: string[]; /** * Limit result to a specific country. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#addressToLocations) */ countryCode?: string; /** * Allows the results of single geocode transactions to be persisted. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#addressToLocations) */ forStorage?: boolean; /** * Used to weight returned results for a specified area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#addressToLocations) */ location?: Point; /** * Define the type of location, either `"street"` or `"rooftop"`, of the point returned from the [World Geocoding Service](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#addressToLocations) */ locationType?: string; /** * A `suggestLocations` result ID (magicKey). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#addressToLocations) */ magicKey?: string; /** * Maximum results to return from the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#addressToLocations) */ maxLocations?: number; /** * The list of fields included in the returned result set. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#addressToLocations) */ outFields?: string[]; /** * The spatial reference of the output geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#addressToLocations) */ outSpatialReference?: SpatialReference; /** * Defines the extent within which the geocode server will search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#addressToLocations) */ searchExtent?: Extent; } export interface locatorLocationToAddressParams { /** * The point at which to search for the closest address. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#locationToAddress) */ location: Point; /** * Define the type of location, either `"street"` or `"rooftop"`, of the point returned from the [World Geocoding Service](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#locationToAddress) */ locationType?: string; /** * The spatial reference of the output geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#locationToAddress) */ outSpatialReference?: SpatialReference; } export interface locatorSuggestLocationsParams { /** * A place or address type which can be used to filter suggest results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#suggestLocations) */ categories?: string[]; /** * Defines a normalized location point that is used to sort geocoding candidates based upon their proximity to the given location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#suggestLocations) */ location: Point; /** * The input text entered by a user which is used by the suggest operation to generate a list of possible matches. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#suggestLocations) */ text: string; } /** * Describes the object representing the result of the [suggestLocations()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#suggestLocations) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#SuggestionResult) */ export interface SuggestionResult { /** * Indicates if the result is a Collection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#SuggestionResult) */ isCollection: boolean; /** * ID used in combination with the `text` property to uniquely identify a suggestion. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#SuggestionResult) */ magicKey: string; /** * The string name of the suggested location to geocode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#SuggestionResult) */ text: string; } /** * The utility network associations model connectivity, containment, and structure relations between assets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-queryAssociations.html) */ interface queryAssociations { /** * Returns all associations filtered by the [QueryAssociationsParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsParameters.html) in a utility network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-queryAssociations.html#queryAssociations) */ queryAssociations(url: string, props: QueryAssociationsParameters, requestOptions?: any): Promise; } export const queryAssociations: queryAssociations; export interface AggregatedGeometry extends Accessor, JSONSupport { } export class AggregatedGeometry { /** * A [polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) geometry representing a union of all polyline features encountered during the trace and specified by the output. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-AggregatedGeometry.html#line) */ line: Polyline; /** * A [multi-point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html) geometry representing a union of all point features encountered during the trace and specified by the output The aggregated geometries will only include geometries that belong to features with `assetgroups/assettypes` specified in the trace output. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-AggregatedGeometry.html#multipoint) */ multipoint: Multipoint; /** * A [polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) geometry representing a union of all polygon features encountered during the trace and specified by the output. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-AggregatedGeometry.html#polygon) */ polygon: Polygon; /** * A class that defines an aggregation of geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-AggregatedGeometry.html) */ constructor(properties?: AggregatedGeometryProperties); static fromJSON(json: any): AggregatedGeometry; } interface AggregatedGeometryProperties { /** * A [polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) geometry representing a union of all polyline features encountered during the trace and specified by the output. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-AggregatedGeometry.html#line) */ line?: PolylineProperties; /** * A [multi-point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html) geometry representing a union of all point features encountered during the trace and specified by the output The aggregated geometries will only include geometries that belong to features with `assetgroups/assettypes` specified in the trace output. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-AggregatedGeometry.html#multipoint) */ multipoint?: MultipointProperties; /** * A [polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) geometry representing a union of all polygon features encountered during the trace and specified by the output. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-AggregatedGeometry.html#polygon) */ polygon?: PolygonProperties; } export interface Association extends Accessor, JSONSupport { } export class Association { /** * The type of association. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html#associationType) */ associationType: string; /** * Error code returned from the server for a failed associations query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html#errorCode) */ errorCode: number; /** * Message returned from the server for a failed associations query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html#errorMessage) */ errorMessage: string; /** * The from side network element of the association. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html#fromNetworkElement) */ fromNetworkElement: NetworkElement; /** * The globalId (UUID) of the association record, uniquely identifes this association row. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html#globalId) */ globalId: string; /** * Specifies the content visibility on the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html#isContentVisible) */ isContentVisible: boolean; /** * The synthesized [polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) geometry created between the two network elements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html#line) */ line: Polyline; /** * This double parameter of value of 0-1 indicates a percentage along the line of where the trace location is placed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html#percentAlong) */ percentAlong: number; /** * Indicates the type of association a feature or object participates in, the role the network feature plays in the association relationship, and any properties that are set. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html#status) */ status: number; /** * The to side network element of the association. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html#toNetworkElement) */ toNetworkElement: NetworkElement; /** * The utility network associations model connectivity, containment and structure relations between assets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html) */ constructor(properties?: AssociationProperties); static fromJSON(json: any): Association; } interface AssociationProperties { /** * The type of association. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html#associationType) */ associationType?: string; /** * Error code returned from the server for a failed associations query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html#errorCode) */ errorCode?: number; /** * Message returned from the server for a failed associations query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html#errorMessage) */ errorMessage?: string; /** * The from side network element of the association. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html#fromNetworkElement) */ fromNetworkElement?: NetworkElementProperties; /** * The globalId (UUID) of the association record, uniquely identifes this association row. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html#globalId) */ globalId?: string; /** * Specifies the content visibility on the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html#isContentVisible) */ isContentVisible?: boolean; /** * The synthesized [polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) geometry created between the two network elements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html#line) */ line?: PolylineProperties; /** * This double parameter of value of 0-1 indicates a percentage along the line of where the trace location is placed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html#percentAlong) */ percentAlong?: number; /** * Indicates the type of association a feature or object participates in, the role the network feature plays in the association relationship, and any properties that are set. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html#status) */ status?: number; /** * The to side network element of the association. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html#toNetworkElement) */ toNetworkElement?: NetworkElementProperties; } export interface AssociationGeometriesResult extends Accessor, JSONSupport { } export class AssociationGeometriesResult { /** * List of returned [associations](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html) filtered based on the input parameters in [SynthesizeAssociationGeometriesParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-SynthesizeAssociationGeometriesParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-AssociationGeometriesResult.html#associations) */ associations: Association[]; /** * Indicates whether the [maxGeometryCount](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#maxGeometryCount) has exceeded. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-AssociationGeometriesResult.html#maxGeometryCountExceeded) */ maxGeometryCountExceeded: boolean; /** * This class defines the results of the function [synthesizeAssociationGeometries](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-synthesizeAssociationGeometries.html) which takes an extent and returns an [AggregatedGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-AggregatedGeometry.html) of all [associations](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html) within the extent based on the defined parameters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-AssociationGeometriesResult.html) */ constructor(properties?: AssociationGeometriesResultProperties); static fromJSON(json: any): AssociationGeometriesResult; } interface AssociationGeometriesResultProperties { /** * List of returned [associations](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html) filtered based on the input parameters in [SynthesizeAssociationGeometriesParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-SynthesizeAssociationGeometriesParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-AssociationGeometriesResult.html#associations) */ associations?: AssociationProperties[]; /** * Indicates whether the [maxGeometryCount](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#maxGeometryCount) has exceeded. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-AssociationGeometriesResult.html#maxGeometryCountExceeded) */ maxGeometryCountExceeded?: boolean; } export interface FunctionResult extends Accessor, JSONSupport { } export class FunctionResult { /** * The aggregate function type used in the supplied trace configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-FunctionResult.html#functionType) */ readonly functionType: "add" | "subtract" | "average" | "count" | "min" | "max"; /** * The name of the function result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-FunctionResult.html#networkAttributeName) */ readonly networkAttributeName: string; /** * Actual result of the aggregate function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-FunctionResult.html#result) */ readonly result: number; /** * A trace can optionally return a aggregated function result if the trace configuration asked for it. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-FunctionResult.html) */ constructor(properties?: FunctionResultProperties); static fromJSON(json: any): FunctionResult; } interface FunctionResultProperties { } export interface NetworkElement extends Accessor, JSONSupport { } export class NetworkElement { /** * The asset group code that this network element represents. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-NetworkElement.html#assetGroupCode) */ assetGroupCode: number; /** * The asset type code discriminator this network element represents. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-NetworkElement.html#assetTypeCode) */ assetTypeCode: number; /** * The globalId of the feature the network element belongs to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-NetworkElement.html#globalId) */ globalId: string; /** * The network source Id of the feature the network element belongs to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-NetworkElement.html#networkSourceId) */ networkSourceId: number; /** * The objectId of the feature the network element belongs to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-NetworkElement.html#objectId) */ objectId: number; /** * Applicable to edge elements, represents a double value (0 to 1) where this edge element starts. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-NetworkElement.html#positionFrom) */ positionFrom: number; /** * Applicable to edge elements, represents a double value (0 to 1) where this edge element ends. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-NetworkElement.html#positionTo) */ positionTo: number; /** * The terminal id defined at the network element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-NetworkElement.html#terminalId) */ terminalId: number; /** * The network element is a representation of how the network topology defines its graph. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-NetworkElement.html) */ constructor(properties?: NetworkElementProperties); static fromJSON(json: any): NetworkElement; } interface NetworkElementProperties { /** * The asset group code that this network element represents. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-NetworkElement.html#assetGroupCode) */ assetGroupCode?: number; /** * The asset type code discriminator this network element represents. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-NetworkElement.html#assetTypeCode) */ assetTypeCode?: number; /** * The globalId of the feature the network element belongs to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-NetworkElement.html#globalId) */ globalId?: string; /** * The network source Id of the feature the network element belongs to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-NetworkElement.html#networkSourceId) */ networkSourceId?: number; /** * The objectId of the feature the network element belongs to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-NetworkElement.html#objectId) */ objectId?: number; /** * Applicable to edge elements, represents a double value (0 to 1) where this edge element starts. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-NetworkElement.html#positionFrom) */ positionFrom?: number; /** * Applicable to edge elements, represents a double value (0 to 1) where this edge element ends. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-NetworkElement.html#positionTo) */ positionTo?: number; /** * The terminal id defined at the network element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-NetworkElement.html#terminalId) */ terminalId?: number; } export interface QueryAssociationsParameters extends Accessor, JSONSupport { } export class QueryAssociationsParameters { /** * The [NetworkElements](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-NetworkElement.html) for which the association is queried. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsParameters.html#elements) */ elements: NetworkElement[]; /** * The geodatabase version to execute the function against. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsParameters.html#gdbVersion) */ gdbVersion: string; /** * The date/timestamp (in UTC) to execute the function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsParameters.html#moment) */ moment: Date; /** * Specifies whether to return logically deleted associations. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsParameters.html#returnDeletes) */ returnDeletes: boolean; /** * Specifies an array of [Association](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html) types to be queried. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsParameters.html#types) */ types: string[]; /** * QueryAssociationsParameters describes the parameters required to execute the [queryAssociations()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-queryAssociations.html) function, which returns a list of [associations](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html) filtered by the parameters set. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsParameters.html) */ constructor(properties?: QueryAssociationsParametersProperties); static fromJSON(json: any): QueryAssociationsParameters; } interface QueryAssociationsParametersProperties { /** * The [NetworkElements](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-NetworkElement.html) for which the association is queried. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsParameters.html#elements) */ elements?: NetworkElementProperties[]; /** * The geodatabase version to execute the function against. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsParameters.html#gdbVersion) */ gdbVersion?: string; /** * The date/timestamp (in UTC) to execute the function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsParameters.html#moment) */ moment?: DateProperties; /** * Specifies whether to return logically deleted associations. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsParameters.html#returnDeletes) */ returnDeletes?: boolean; /** * Specifies an array of [Association](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html) types to be queried. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsParameters.html#types) */ types?: string[]; } export interface QueryAssociationsResult extends Accessor, JSONSupport { } export class QueryAssociationsResult { /** * List of [associations](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html) returned filtered based on the input parameters in [QueryAssociationsParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsResult.html#associations) */ associations: Association[]; /** * Defines the results of the [queryAssociations()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-queryAssociations.html) function which takes in [QueryAssociationsParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsParameters.html) and returns an [QueryAssociationsResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsResult.html) of all [associations](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html) filtered by the parameters set. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsResult.html) */ constructor(properties?: QueryAssociationsResultProperties); static fromJSON(json: any): QueryAssociationsResult; } interface QueryAssociationsResultProperties { /** * List of [associations](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html) returned filtered based on the input parameters in [QueryAssociationsParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsResult.html#associations) */ associations?: AssociationProperties[]; } export interface SynthesizeAssociationGeometriesParameters extends Accessor, JSONSupport { } export class SynthesizeAssociationGeometriesParameters { /** * The extent used to execute a spatial query to retrieve the associations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#extent) */ extent: Extent; /** * The geodatabase version to execute the function against. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#gdbVersion) */ gdbVersion: string; /** * A number that indicates the maximum associations that should be synthesized after which the operation should immediately return. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#maxGeometryCount) */ maxGeometryCount: number; /** * The date/timestamp (in UTC) to execute the function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#moment) */ moment: Date; /** * The spatial reference that should be used to project the synthesized geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * Indicates whether to synthesize and return structual attachment associations. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#returnAttachmentAssociations) */ returnAttachmentAssociations: boolean; /** * Indicates whether to synthesize and return connectivity associations. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#returnConnectivityAssociations) */ returnConnectivityAssociations: boolean; /** * Indicates whether to synthesize and return containment associations. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#returnContainmentAssociations) */ returnContainmentAssociations: boolean; /** * This class describes the parameters required to execute the synthesizeAssociationGeometries function which synthesizes and returns the associations geometries in a given extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-SynthesizeAssociationGeometriesParameters.html) */ constructor(properties?: SynthesizeAssociationGeometriesParametersProperties); static fromJSON(json: any): SynthesizeAssociationGeometriesParameters; } interface SynthesizeAssociationGeometriesParametersProperties { /** * The extent used to execute a spatial query to retrieve the associations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#extent) */ extent?: ExtentProperties; /** * The geodatabase version to execute the function against. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#gdbVersion) */ gdbVersion?: string; /** * A number that indicates the maximum associations that should be synthesized after which the operation should immediately return. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#maxGeometryCount) */ maxGeometryCount?: number; /** * The date/timestamp (in UTC) to execute the function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#moment) */ moment?: DateProperties; /** * The spatial reference that should be used to project the synthesized geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; /** * Indicates whether to synthesize and return structual attachment associations. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#returnAttachmentAssociations) */ returnAttachmentAssociations?: boolean; /** * Indicates whether to synthesize and return connectivity associations. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#returnConnectivityAssociations) */ returnConnectivityAssociations?: boolean; /** * Indicates whether to synthesize and return containment associations. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#returnContainmentAssociations) */ returnContainmentAssociations?: boolean; } export interface TraceLocation extends Accessor, JSONSupport { } export class TraceLocation { /** * The globalId (UUID) of the feature to start or stop the trace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceLocation.html#globalId) */ globalId: string; /** * This indicates whether this barrier starting location should be skipped (filtered) when a trace attempts to find upstream controllers. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceLocation.html#isFilterBarrier) */ isFilterBarrier: boolean; /** * This double parameter of value of 0-1 indicates a percentage along the line of where the trace location is placed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceLocation.html#percentAlong) */ percentAlong: number; /** * The terminal Id to place the starting location at. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceLocation.html#terminalId) */ terminalId: number; /** * The type of the trace location; `starting-point` defines where the trace should start and `barrier` defines where the trace should stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceLocation.html#type) */ type: "starting-point" | "barrier"; /** * To perform the trace analytic, users can optionally supply a list of locations in forms of globalIds (UUID) and terminals. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceLocation.html) */ constructor(properties?: TraceLocationProperties); static fromJSON(json: any): TraceLocation; } interface TraceLocationProperties { /** * The globalId (UUID) of the feature to start or stop the trace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceLocation.html#globalId) */ globalId?: string; /** * This indicates whether this barrier starting location should be skipped (filtered) when a trace attempts to find upstream controllers. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceLocation.html#isFilterBarrier) */ isFilterBarrier?: boolean; /** * This double parameter of value of 0-1 indicates a percentage along the line of where the trace location is placed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceLocation.html#percentAlong) */ percentAlong?: number; /** * The terminal Id to place the starting location at. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceLocation.html#terminalId) */ terminalId?: number; /** * The type of the trace location; `starting-point` defines where the trace should start and `barrier` defines where the trace should stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceLocation.html#type) */ type?: "starting-point" | "barrier"; } export interface TraceParameters extends Accessor, JSONSupport { } export class TraceParameters { /** * The geodatabase version to execute the function against. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#gdbVersion) */ gdbVersion: string; /** * The date/timestamp (in UTC) to execute the function at a given time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#moment) */ moment: Date; /** * The globalId (UUID) of the named trace configuration persisted in the network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#namedTraceConfigurationGlobalId) */ namedTraceConfigurationGlobalId: string; /** * The spatial reference that should be used to project the [aggregated geometries](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-AggregatedGeometry.html) returned by the trace (if applicable). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * Parameter specifying the types of results to return after running a trace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#resultTypes) */ resultTypes: ResultTypeJSON[]; /** * Defines the properties of a trace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#traceConfiguration) */ traceConfiguration: UNTraceConfiguration; /** * The list of starting points and barriers that will define where the trace starts and stops. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#traceLocations) */ traceLocations: TraceLocation[]; /** * The trace type defined in this trace configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#traceType) */ traceType: | "connected" | "upstream" | "downstream" | "shortest-path" | "subnetwork" | "subnetwork-controllers" | "loops" | "isolation"; /** * The list of parameters that are needed to determine how the trace analytic will be executed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html) */ constructor(properties?: TraceParametersProperties); static fromJSON(json: any): TraceParameters; } interface TraceParametersProperties { /** * The geodatabase version to execute the function against. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#gdbVersion) */ gdbVersion?: string; /** * The date/timestamp (in UTC) to execute the function at a given time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#moment) */ moment?: DateProperties; /** * The globalId (UUID) of the named trace configuration persisted in the network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#namedTraceConfigurationGlobalId) */ namedTraceConfigurationGlobalId?: string; /** * The spatial reference that should be used to project the [aggregated geometries](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-AggregatedGeometry.html) returned by the trace (if applicable). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; /** * Parameter specifying the types of results to return after running a trace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#resultTypes) */ resultTypes?: ResultTypeJSON[]; /** * Defines the properties of a trace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#traceConfiguration) */ traceConfiguration?: UNTraceConfiguration; /** * The list of starting points and barriers that will define where the trace starts and stops. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#traceLocations) */ traceLocations?: TraceLocationProperties[]; /** * The trace type defined in this trace configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#traceType) */ traceType?: | "connected" | "upstream" | "downstream" | "shortest-path" | "subnetwork" | "subnetwork-controllers" | "loops" | "isolation"; } /** * ResultTypeJSON specifies the type of results to return after running a trace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#ResultTypeJSON) */ export interface ResultTypeJSON { /** * Specifies whether to return type `"elements"` or `"aggregatedGeometry"`. * * [Read more...](global.html#type) */ type: "elements" | "aggregatedGeometry"; /** * Specifies whether to return geometry values in resultTypes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#ResultTypeJSON) */ includeGeometry: boolean; /** * Specifies whether to return propagated values in resultTypes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#ResultTypeJSON) */ includePropagatedValues: boolean; /** * Specifies the network attribute names. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#ResultTypeJSON) */ networkAttributeNames: string[]; /** * Specifies the name of a predefined Diagram Template. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#ResultTypeJSON) */ diagramTemplateName: string; /** * Specifies the types of output fields that can be generated from geoprocessing tools. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceParameters.html#ResultTypeJSON) */ resultTypeFields: any[]; } export interface TraceResult extends Accessor, JSONSupport { } export class TraceResult { /** * This property defines an aggregation of geometries returned by the trace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceResult.html#aggregatedGeometry) */ aggregatedGeometry: AggregatedGeometry; /** * An array of network elements returned by the trace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceResult.html#elements) */ elements: NetworkElement[]; /** * Returns an array of function aggregation results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceResult.html#globalFunctionResults) */ globalFunctionResults: FunctionResult[]; /** * This parameter is specific to the K-Nearest Neighbors Algorithm, when the neariest filter is provided in the trace configuration. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceResult.html#kFeaturesForKNNFound) */ kFeaturesForKNNFound: boolean; /** * Returns `true` if the starting points in the network trace operation are ignored. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceResult.html#startingPointsIgnored) */ startingPointsIgnored: boolean; /** * Returns any warnings encountered by the trace operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceResult.html#warnings) */ warnings: string[]; /** * This class defines the collection of results returned from the trace function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceResult.html) */ constructor(properties?: TraceResultProperties); static fromJSON(json: any): TraceResult; } interface TraceResultProperties { /** * This property defines an aggregation of geometries returned by the trace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceResult.html#aggregatedGeometry) */ aggregatedGeometry?: AggregatedGeometryProperties; /** * An array of network elements returned by the trace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceResult.html#elements) */ elements?: NetworkElementProperties[]; /** * Returns an array of function aggregation results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceResult.html#globalFunctionResults) */ globalFunctionResults?: FunctionResultProperties[]; /** * This parameter is specific to the K-Nearest Neighbors Algorithm, when the neariest filter is provided in the trace configuration. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceResult.html#kFeaturesForKNNFound) */ kFeaturesForKNNFound?: boolean; /** * Returns `true` if the starting points in the network trace operation are ignored. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceResult.html#startingPointsIgnored) */ startingPointsIgnored?: boolean; /** * Returns any warnings encountered by the trace operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-TraceResult.html#warnings) */ warnings?: string[]; } export interface ValidateNetworkTopologyParameters extends Accessor, JSONSupport { } export class ValidateNetworkTopologyParameters { /** * Specifies the geodatabase version name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyParameters.html#gdbVersion) */ gdbVersion: string; /** * Specifies the GUID used to lock the version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyParameters.html#sessionID) */ sessionID: string; /** * Specifies the envelope of the area to validate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyParameters.html#validateArea) */ validateArea: Extent; /** * Specifies the set of features and objects to validate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyParameters.html#validationSet) */ validationSet: ValidationSetItemJSON[]; /** * Specifies the validation to perform. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyParameters.html#validationType) */ validationType: "normal" | "rebuild" | "force-rebuild"; /** * ValidateNetworkTopologyParameters describes the optional and required parameters for validating a network topology. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyParameters.html) */ constructor(properties?: ValidateNetworkTopologyParametersProperties); static fromJSON(json: any): ValidateNetworkTopologyParameters; } interface ValidateNetworkTopologyParametersProperties { /** * Specifies the geodatabase version name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyParameters.html#gdbVersion) */ gdbVersion?: string; /** * Specifies the GUID used to lock the version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyParameters.html#sessionID) */ sessionID?: string; /** * Specifies the envelope of the area to validate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyParameters.html#validateArea) */ validateArea?: ExtentProperties; /** * Specifies the set of features and objects to validate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyParameters.html#validationSet) */ validationSet?: ValidationSetItemJSON[]; /** * Specifies the validation to perform. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyParameters.html#validationType) */ validationType?: "normal" | "rebuild" | "force-rebuild"; } /** * ValidationSetItemJSON represents the set of features and objects to validate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyParameters.html#ValidationSetItemJSON) */ export interface ValidationSetItemJSON { /** * The network source id of the. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyParameters.html#ValidationSetItemJSON) */ sourceId: number; /** * An array of globalId strings to validate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyParameters.html#ValidationSetItemJSON) */ globalIds: string[]; } /** * Class that holds the returned object after running the [Network.validateTopology()](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#validateTopology) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyResult.html) */ interface ValidateNetworkTopologyResult { /** * Returns dirty area count if using Utility Network Verison 3, otherwise will return 0. * * @deprecated since version 4.28. Dirty area count was implemented in the original version of utility network, but as of * schema version 4 of the utility network, this is no longer supported. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyResult.html#dirtyAreaCount) */ dirtyAreaCount: number; /** * Contains information about the subnetworks that are marked as dirty during the validation process, along with the domain network and tier containing the subnetwork. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyResult.html#discoveredSubnetworks) */ discoveredSubnetworks: Subnetwork[]; /** * If `maxRecordCount` is configured for a layer, `exceededTransferLimit` will be `true` if a query matches more than the `maxRecordCount` features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyResult.html#exceededTransferLimit) */ exceededTransferLimit: boolean; /** * If the current feature service contains no dirty areas, full update will return true. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyResult.html#fullUpdate) */ fullUpdate: boolean; /** * The date/timestamp (in UTC) when the validate process was executed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyResult.html#moment) */ moment: Date; /** * The serviceEdits returns full features including the original features prior to delete, the original and current features for updates, and the current rows for inserts, which may contain implicit changes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyResult.html#serviceEdits) */ serviceEdits: ValidateServiceEdits[]; /** * If error features are created during the validation process validateErrorsCreated will be true. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyResult.html#validateErrorsCreated) */ validateErrorsCreated: boolean; } export const ValidateNetworkTopologyResult: ValidateNetworkTopologyResult; /** * The Subnetwork object represents the domain name, tier name, and subnetwork via fulfilling the promise returned from running the [Network.validateTopology()](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-Network.html#validateTopology) function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyResult.html#Subnetwork) */ export interface Subnetwork { /** * The domain name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyResult.html#Subnetwork) */ domain: string; /** * The tier name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyResult.html#Subnetwork) */ tier: string; /** * The subnetwork name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyResult.html#Subnetwork) */ subnetwork: string; } /** * ValidateServiceEdits represents the layerId and editedFeatures. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyResult.html#ValidateServiceEdits) */ export interface ValidateServiceEdits { /** * The layerId of the layer with ServiceEdits. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyResult.html#ValidateServiceEdits) */ layerId: number; /** * The editedFeatures object returns full features including the original features prior to delete, the original and current features for updates, and the current rows for inserts, which may contain implicit changes (for example, as a result of a calculation rule). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-ValidateNetworkTopologyResult.html#ValidateServiceEdits) */ editedFeatures?: any; } /** * The utility network associations model connectivity, containment, and structure relations between assets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-synthesizeAssociationGeometries.html) */ interface synthesizeAssociationGeometries { /** * Given an extent, returns all associations within this extent and their synthesized geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-synthesizeAssociationGeometries.html#synthesizeAssociationGeometries) */ synthesizeAssociationGeometries(url: string, params: SynthesizeAssociationGeometriesParameters, requestOptions?: any): Promise; } export const synthesizeAssociationGeometries: synthesizeAssociationGeometries; /** * Trace is the core analytic of the utility network, by providing a set of parameters, you can start the trace in one or more features and traverse the network topology satisfying the parameters until the trace stops at end points or when the definition of the trace condition barriers are met. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-trace.html) */ interface trace { /** * The trace function takes a set of parameters, executes the trace analytic on the backend, and returns trace results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-trace.html#trace) */ trace(url: string, params: TraceParameters, requestOptions?: any): Promise; } export const trace: trace; /** * This modules contains functions for working with network services. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networkService.html) */ interface networkService { /** * Retrieve a description of the network service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networkService.html#fetchServiceDescription) */ fetchServiceDescription(url: string, apiKey?: string, requestOptions?: any): Promise; } export const networkService: networkService; /** * The network service description. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networkService.html#ServiceDescription) */ export interface ServiceDescription { /** * Server version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networkService.html#ServiceDescription) */ currentVersion: number; /** * Default travel mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networkService.html#ServiceDescription) */ defaultTravelMode: TravelMode; /** * Available travel modes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networkService.html#ServiceDescription) */ supportedTravelModes: TravelMode[]; } /** * Find [places](/documentation/mapping-apis-and-services/places/) within a search distance of a geographic point or within an extent, or find more information about specific places. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-places.html) */ interface places { /** * Get place details, including name, address, description, and other attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-places.html#fetchPlace) */ fetchPlace(params: FetchPlaceParameters, requestOptions?: any): Promise; /** * A nearby search that finds places within a given radius of a location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-places.html#queryPlacesNearPoint) */ queryPlacesNearPoint(params: PlacesQueryParameters, requestOptions?: any): Promise; /** * A search that finds places within a given extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-places.html#queryPlacesWithinExtent) */ queryPlacesWithinExtent(params: PlacesQueryParameters, requestOptions?: any): Promise; } export const places: places; /** * The print module provides an `executePrint` method that generates a printer-ready version of the map using an [Export Web Map Task](https://developers.arcgis.com/rest/services-reference/export-web-map-task.htm) available with ArGIS Server 10.1 and later. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html) */ interface print { /** * Sends a request to the print service to create a printable static image of the map using the options specified in the [PrintParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html#execute) */ execute(url: string, params: PrintParameters, requestOptions?: any): Promise; /** * Request the mode for the print request service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html#getMode) */ getMode(url: string): string; } export const print: print; /** * Represents the response of the [execute()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html#execute) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html#PrintResponse) */ export interface PrintResponse { /** * URL pointing to the location of the generated printout of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html#PrintResponse) */ url: string; } /** * Executes different types of query operations on a layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html) */ interface query { /** * Query information about attachments associated with features from a [feature layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) specified in the url parameter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html#executeAttachmentQuery) */ executeAttachmentQuery(url: string, attachmentQuery: AttachmentQuery | AttachmentQueryProperties, requestOptions?: any): Promise; /** * Gets a count of the number of features that satisfy the input query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html#executeForCount) */ executeForCount(url: string, query: Query | QueryProperties, requestOptions?: any): Promise; /** * Gets the extent of the features that satisfy the input query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html#executeForExtent) */ executeForExtent(url: string, params: Query, requestOptions?: any): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the layer specified in the url parameter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html#executeForIds) */ executeForIds(url: string, query: Query | QueryProperties, requestOptions?: any): Promise; /** * Executes a [TopFeaturesQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html) against a feature service and returns the count of features or records that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html#executeForTopCount) */ executeForTopCount(url: string, topFeaturesQuery: TopFeaturesQuery, requestOptions?: any): Promise; /** * Executes a [TopFeaturesQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html) against a feature service and returns the [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html#executeForTopExtents) */ executeForTopExtents(url: string, topFeaturesQuery: TopFeaturesQuery, outSpatialReference: SpatialReference, requestOptions?: any): Promise; /** * Executes a [TopFeaturesQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html) against a feature service and returns an array of Object IDs of features that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html#executeForTopIds) */ executeForTopIds(url: string, topFeaturesQuery: TopFeaturesQuery, outSpatialReference: SpatialReference, requestOptions?: any): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the layer specified in the url parameter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html#executeQueryJSON) */ executeQueryJSON(url: string, query: Query | QueryProperties, requestOptions?: any): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against the layer specified in the url parameter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html#executeQueryPBF) */ executeQueryPBF(url: string, query: Query | QueryProperties, requestOptions?: any): Promise; /** * Executes a [RelationshipQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html) against the layer or table specified in the url parameter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html#executeRelationshipQuery) */ executeRelationshipQuery(url: string, relationshipQuery: RelationshipQuery | RelationshipQueryProperties, requestOptions?: any): Promise; /** * Executes a [TopFeaturesQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html) against a feature service and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html) once the promise resolves. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html#executeTopFeaturesQuery) */ executeTopFeaturesQuery(url: string, topFeaturesQuery: TopFeaturesQuery, outSpatialReference: SpatialReference, requestOptions?: any): Promise; } export const query: query; export interface AttachmentInfo extends Accessor, JSONSupport { } export class AttachmentInfo { /** * The content type of the attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#contentType) */ contentType: string; /** * An array of [ExifInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#ExifInfo) for the attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#exifInfo) */ exifInfo: ExifInfo[]; /** * The global identifier for the attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#globalId) */ globalId: string; /** * The identifier for the attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#id) */ id: number; /** * Keywords used for the attachments. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#keywords) */ keywords: string; /** * String value indicating the name of the file attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#name) */ name: string; /** * The [OrientationInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#OrientationInfo) for the attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#orientationInfo) */ readonly orientationInfo: OrientationInfo; /** * The parent or the feature global id of the attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#parentGlobalId) */ parentGlobalId: number; /** * The parent or the feature object id of the attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#parentObjectId) */ parentObjectId: number; /** * The file size of the attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#size) */ size: number; /** * The URL of the attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#url) */ url: string; /** * The `AttachmentInfo` class returns information about attachments associated with a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html) */ constructor(properties?: AttachmentInfoProperties); /** * Creates a deep clone of the AttachmentInfo class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#clone) */ clone(): AttachmentInfo; static fromJSON(json: any): AttachmentInfo; } interface AttachmentInfoProperties { /** * The content type of the attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#contentType) */ contentType?: string; /** * An array of [ExifInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#ExifInfo) for the attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#exifInfo) */ exifInfo?: ExifInfo[]; /** * The global identifier for the attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#globalId) */ globalId?: string; /** * The identifier for the attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#id) */ id?: number; /** * Keywords used for the attachments. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#keywords) */ keywords?: string; /** * String value indicating the name of the file attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#name) */ name?: string; /** * The parent or the feature global id of the attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#parentGlobalId) */ parentGlobalId?: number; /** * The parent or the feature object id of the attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#parentObjectId) */ parentObjectId?: number; /** * The file size of the attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#size) */ size?: number; /** * The URL of the attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#url) */ url?: string; } /** * An array of [Exchangeable image file format](https://en.wikipedia.org/wiki/Exif) information for the attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#ExifInfo) */ export interface ExifInfo { /** * The file name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#ExifInfo) */ name?: string; /** * Array of tag objects containing the following properties: * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#ExifInfo) */ tags?: ExifInfoTags[]; } /** * An object containing properties specific to the orientation of an image attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#OrientationInfo) */ export interface OrientationInfo { /** * The identifer for the orientation info. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#OrientationInfo) */ id?: number; /** * The rotation value for the attached image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#OrientationInfo) */ rotation?: number; /** * Indicates whether the image displays mirrored. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#OrientationInfo) */ mirrored?: boolean; } export interface ExifInfoTags { /** * The tag name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#ExifInfo) */ name: string; /** * The tag description. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#ExifInfo) */ description: string; /** * The value of the tag. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#ExifInfo) */ value: any; } /** * Find routes between two or more locations and optionally get driving directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-route.html) */ interface route { /** * Solves the route against the route layer with the route parameters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-route.html#solve) */ solve(url: string, params: RouteParameters, requestOptions?: any): Promise; } export const route: route; /** * With the Service area service, you can find the area that can be reached from the input location within a given travel time or travel distance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-serviceArea.html) */ interface serviceArea { /** * Determines the service area based on a set of parameters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-serviceArea.html#solve) */ solve(url: string, params: ServiceAreaParameters, requestOptions?: any): Promise; } export const serviceArea: serviceArea; export interface AddressCandidate extends Accessor, JSONSupport { } export class AddressCandidate { /** * Address of the candidate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AddressCandidate.html#address) */ address: string; /** * Name value pairs of field name and field value as defined in `outFields` in [locator.addressToLocations()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#addressToLocations). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AddressCandidate.html#attributes) */ attributes: any; /** * The minimum and maximum X and Y coordinates of a bounding box of the address candidate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AddressCandidate.html#extent) */ extent: Extent; /** * The [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) object representing the location of the [address](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AddressCandidate.html#address). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AddressCandidate.html#location) */ location: Point; /** * Numeric score between `0` and `100` for geocode candidates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AddressCandidate.html#score) */ score: number; /** * Represents the result of a geocode service operation as a list of address candidates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AddressCandidate.html) */ constructor(properties?: AddressCandidateProperties); static fromJSON(json: any): AddressCandidate; } interface AddressCandidateProperties { /** * Address of the candidate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AddressCandidate.html#address) */ address?: string; /** * Name value pairs of field name and field value as defined in `outFields` in [locator.addressToLocations()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#addressToLocations). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AddressCandidate.html#attributes) */ attributes?: any; /** * The minimum and maximum X and Y coordinates of a bounding box of the address candidate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AddressCandidate.html#extent) */ extent?: ExtentProperties; /** * The [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) object representing the location of the [address](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AddressCandidate.html#address). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AddressCandidate.html#location) */ location?: PointProperties; /** * Numeric score between `0` and `100` for geocode candidates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AddressCandidate.html#score) */ score?: number; } export class AlgorithmicColorRamp extends ColorRamp { /** * The algorithm used to generate the colors between the `fromColor` and `toColor`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AlgorithmicColorRamp.html#algorithm) */ algorithm: "cie-lab" | "lab-lch" | "hsv"; /** * The first color in the color ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AlgorithmicColorRamp.html#fromColor) */ fromColor: Color; /** * The last color in the color ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AlgorithmicColorRamp.html#toColor) */ toColor: Color; /** * A string value representing the color ramp type. * * @default algorithmic * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AlgorithmicColorRamp.html#type) */ readonly type: "algorithmic"; /** * Creates a color ramp for use in a raster renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AlgorithmicColorRamp.html) */ constructor(properties?: AlgorithmicColorRampProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AlgorithmicColorRamp.html#clone) */ clone(): AlgorithmicColorRamp; static fromJSON(json: any): AlgorithmicColorRamp; } interface AlgorithmicColorRampProperties extends ColorRampProperties { /** * The algorithm used to generate the colors between the `fromColor` and `toColor`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AlgorithmicColorRamp.html#algorithm) */ algorithm?: "cie-lab" | "lab-lch" | "hsv"; /** * The first color in the color ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AlgorithmicColorRamp.html#fromColor) */ fromColor?: Color; /** * The last color in the color ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AlgorithmicColorRamp.html#toColor) */ toColor?: Color; } export interface AreasAndLengthsParameters extends Accessor, JSONSupport { } export class AreasAndLengthsParameters { /** * The area unit in which areas of polygons will be calculated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AreasAndLengthsParameters.html#areaUnit) */ areaUnit: | "acres" | "hectares" | "square-miles" | "square-kilometers" | "square-meters" | "square-feet" | "square-yards"; /** * Defines the type of calculation for the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AreasAndLengthsParameters.html#calculationType) */ calculationType: "planar" | "geodesic" | "preserve-shape"; /** * The length unit in which perimeters of polygons will be calculated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AreasAndLengthsParameters.html#lengthUnit) */ lengthUnit: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards"; /** * Polygon geometries for which to compute areas and lengths. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AreasAndLengthsParameters.html#polygons) */ polygons: Polygon[]; /** * Input parameters for the areasAndLengths() method on the GeometryService. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AreasAndLengthsParameters.html) */ constructor(properties?: AreasAndLengthsParametersProperties); static fromJSON(json: any): AreasAndLengthsParameters; } interface AreasAndLengthsParametersProperties { /** * The area unit in which areas of polygons will be calculated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AreasAndLengthsParameters.html#areaUnit) */ areaUnit?: | "acres" | "hectares" | "square-miles" | "square-kilometers" | "square-meters" | "square-feet" | "square-yards"; /** * Defines the type of calculation for the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AreasAndLengthsParameters.html#calculationType) */ calculationType?: "planar" | "geodesic" | "preserve-shape"; /** * The length unit in which perimeters of polygons will be calculated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AreasAndLengthsParameters.html#lengthUnit) */ lengthUnit?: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards"; /** * Polygon geometries for which to compute areas and lengths. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AreasAndLengthsParameters.html#polygons) */ polygons?: PolygonProperties[]; } export interface AttachmentQuery extends Accessor, JSONSupport { } export class AttachmentQuery { /** * The where clause to be applied to attachment queries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#attachmentsWhere) */ attachmentsWhere: string; /** * The file format that is supported by query attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#attachmentTypes) */ attachmentTypes: string[]; /** * Indicates if the service should cache the attachment query results. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#cacheHint) */ cacheHint: boolean; /** * An array of globalIds for the features in the layer being queried. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#globalIds) */ globalIds: number[]; /** * Used to query for attachments that match the provided `keywords`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#keywords) */ keywords: string[]; /** * Used to query for attachments that match this `name`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#name) */ name: string; /** * The number of features to retrieve. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#num) */ num: number; /** * An array of objectIds of the features to be queried for attachments. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#objectIds) */ objectIds: number[]; /** * If `true`, the [Exchangeable image file format](https://en.wikipedia.org/wiki/Exif) for the attachment will be included in [attachmentInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#exifInfo). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#returnMetadata) */ returnMetadata: boolean; /** * The file size of the attachment is specified in bytes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#size) */ size: number[]; /** * This option fetches query results by skipping a specified number of records. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#start) */ start: number; /** * The `where` clause to be applied to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#where) */ where: string; /** * This class defines parameters for executing queries for feature attachments from a [feature layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html) */ constructor(properties?: AttachmentQueryProperties); /** * Creates a deep clone of AttachmentQuery object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#clone) */ clone(): AttachmentQuery; static fromJSON(json: any): AttachmentQuery; } interface AttachmentQueryProperties { /** * The where clause to be applied to attachment queries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#attachmentsWhere) */ attachmentsWhere?: string; /** * The file format that is supported by query attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#attachmentTypes) */ attachmentTypes?: string[]; /** * Indicates if the service should cache the attachment query results. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#cacheHint) */ cacheHint?: boolean; /** * An array of globalIds for the features in the layer being queried. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#globalIds) */ globalIds?: number[]; /** * Used to query for attachments that match the provided `keywords`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#keywords) */ keywords?: string[]; /** * Used to query for attachments that match this `name`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#name) */ name?: string; /** * The number of features to retrieve. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#num) */ num?: number; /** * An array of objectIds of the features to be queried for attachments. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#objectIds) */ objectIds?: number[]; /** * If `true`, the [Exchangeable image file format](https://en.wikipedia.org/wiki/Exif) for the attachment will be included in [attachmentInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html#exifInfo). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#returnMetadata) */ returnMetadata?: boolean; /** * The file size of the attachment is specified in bytes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#size) */ size?: number[]; /** * This option fetches query results by skipping a specified number of records. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#start) */ start?: number; /** * The `where` clause to be applied to the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#where) */ where?: string; } export class BaseImageMeasureParameters { /** * Specifies the [mosaic rule](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html) on how individual images should be mosaicked when the measure is computed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-BaseImageMeasureParameters.html#mosaicRule) */ mosaicRule: MosaicRule; /** * Specifies the pixel size. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-BaseImageMeasureParameters.html#pixelSize) */ pixelSize: PixelSize; } interface BaseImageMeasureParametersProperties { /** * Specifies the [mosaic rule](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html) on how individual images should be mosaicked when the measure is computed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-BaseImageMeasureParameters.html#mosaicRule) */ mosaicRule?: MosaicRuleProperties; /** * Specifies the pixel size. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-BaseImageMeasureParameters.html#pixelSize) */ pixelSize?: PixelSize; } export class BaseImageMeasureResult { /** * Name of the raster dataset used in the area and height measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-BaseImageMeasureResult.html#name) */ name: string; /** * Sensor name of the raster dataset used in the area and height measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-BaseImageMeasureResult.html#sensorName) */ sensorName: string; } interface BaseImageMeasureResultProperties { /** * Name of the raster dataset used in the area and height measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-BaseImageMeasureResult.html#name) */ name?: string; /** * Sensor name of the raster dataset used in the area and height measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-BaseImageMeasureResult.html#sensorName) */ sensorName?: string; } export interface BufferParameters extends Accessor, JSONSupport { } export class BufferParameters { /** * The spatial reference in which the geometries are buffered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-BufferParameters.html#bufferSpatialReference) */ bufferSpatialReference: SpatialReference; /** * The distances the input features are buffered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-BufferParameters.html#distances) */ distances: number[]; /** * If the input geometries are in a geographic coordinate system, set geodesic to `true` to generate a buffer polygon using a geodesic distance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-BufferParameters.html#geodesic) */ geodesic: boolean; /** * The input geometries to buffer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-BufferParameters.html#geometries) */ geometries: Geometry[]; /** * The spatial reference for the returned geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-BufferParameters.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * If `true`, all geometries buffered at a given distance are unioned into a single (possibly multipart) polygon, and the unioned geometry is placed in the output array. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-BufferParameters.html#unionResults) */ unionResults: boolean; /** * The units for calculating each buffer distance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-BufferParameters.html#unit) */ unit: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards"; /** * Sets the distances, units, and other parameters for the [buffer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#buffer) method on the [geometryService](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-BufferParameters.html) */ constructor(properties?: BufferParametersProperties); static fromJSON(json: any): BufferParameters; } interface BufferParametersProperties { /** * The spatial reference in which the geometries are buffered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-BufferParameters.html#bufferSpatialReference) */ bufferSpatialReference?: SpatialReferenceProperties; /** * The distances the input features are buffered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-BufferParameters.html#distances) */ distances?: number[]; /** * If the input geometries are in a geographic coordinate system, set geodesic to `true` to generate a buffer polygon using a geodesic distance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-BufferParameters.html#geodesic) */ geodesic?: boolean; /** * The input geometries to buffer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-BufferParameters.html#geometries) */ geometries?: GeometryProperties[]; /** * The spatial reference for the returned geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-BufferParameters.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; /** * If `true`, all geometries buffered at a given distance are unioned into a single (possibly multipart) polygon, and the unioned geometry is placed in the output array. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-BufferParameters.html#unionResults) */ unionResults?: boolean; /** * The units for calculating each buffer distance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-BufferParameters.html#unit) */ unit?: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards"; } export class CameraInfo extends JSONSupport { /** * Camera id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-CameraInfo.html#id) */ id: string; /** * Camera information returned as a result of running [ImageryLayer.queryGPSInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#queryGPSInfo) or [imageService.queryGPSInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#queryGPSInfo) methods. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-CameraInfo.html) */ constructor(properties?: CameraInfoProperties); static fromJSON(json: any): CameraInfo; } interface CameraInfoProperties { /** * Camera id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-CameraInfo.html#id) */ id?: string; } export interface ClosestFacilityParameters extends Accessor, JSONSupport, Clonable { } export class ClosestFacilityParameters { /** * Use this property to specify whether the operation should accumulate values other than the value specified for [impedanceAttribute](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#impedanceAttribute). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#accumulateAttributes) */ accumulateAttributes: ( | "kilometers" | "miles" | "minutes" | "travel-time" | "truck-minutes" | "truck-travel-time" | "walk-time" | string )[]; /** * An authorization string used to access a resource or service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#apiKey) */ apiKey: string; /** * Use this property to specify additional values required by an attribute or restriction, such as to specify whether the restriction prohibits, avoids, or prefers travel on restricted roads. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#attributeParameterValues) */ attributeParameterValues: AttributeParameterValue[]; /** * The travel time or travel distance value at which to stop searching for facilities for a given incident. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#defaultCutoff) */ defaultCutoff: number; /** * The number of closest facilities to find per incident. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#defaultTargetFacilityCount) */ defaultTargetFacilityCount: number; /** * The language that will be used when generating travel directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#directionsLanguage) */ directionsLanguage: string; /** * Specify the units for displaying travel distance in the driving directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#directionsLengthUnits) */ directionsLengthUnits: | "centimeters" | "decimal-degrees" | "decimeters" | "feet" | "inches" | "kilometers" | "meters" | "miles" | "millimeters" | "nautical-miles" | "points" | "yards"; /** * Define the content and verbosity of the driving directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#directionsOutputType) */ directionsOutputType: | "complete" | "complete-no-events" | "featuresets" | "instructions-only" | "standard" | "summary-only"; /** * Specify the name of the formatting style for the directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#directionsStyleName) */ directionsStyleName: "desktop" | "navigation" | "campus"; /** * Set the time-based impedance attribute to display the duration of a maneuver, such as "Go northwest on Alvorado St. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#directionsTimeAttribute) */ directionsTimeAttribute: "travel-time" | "truck-travel-time" | "walk-time" | "minutes" | "truck-time" | string; /** * One or more locations that are searched for when finding the closest location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#facilities) */ facilities: DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#geometryPrecision) */ geometryPrecision: number; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#geometryPrecisionM) */ geometryPrecisionM: number; /** * Use this property to specify the number of decimal places in the response geometries returned by a solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#geometryPrecisionZ) */ geometryPrecisionZ: number; /** * Specify whether invalid input locations should be ignored when finding the best solution. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#ignoreInvalidLocations) */ ignoreInvalidLocations: boolean; /** * Specifies the impedance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#impedanceAttribute) */ impedanceAttribute: | "kilometers" | "miles" | "minutes" | "travel-time" | "truck-minutes" | "truck-travel-time" | "walk-time" | string; /** * One or more locations from which the service searches for the nearby locations * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#incidents) */ incidents: DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl; /** * Use this property to specify by how much you want to simplify the route geometry returned by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#outputGeometryPrecision) */ outputGeometryPrecision: number; /** * Use this property to specify the units for the value specified for the [outputGeometryPrecision](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#outputGeometryPrecision) parameter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#outputGeometryPrecisionUnits) */ outputGeometryPrecisionUnits: | "centimeters" | "decimal-degrees" | "decimeters" | "feet" | "inches" | "kilometers" | "meters" | "miles" | "millimeters" | "nautical-miles" | "points" | "yards"; /** * Use this property to specify the type of route features that are output by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#outputLines) */ outputLines: "none" | "straight" | "true-shape" | "true-shape-with-measure"; /** * Use this property to specify the spatial reference of the geometries, such as line or point features, returned by a solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * Specify additional settings that can influence the behavior of the solver when finding solutions for the network analysis problems. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#overrides) */ overrides: any; /** * Use this property to specify one or more points that will act as temporary restrictions or represent additional time or distance that may be required to travel on the underlying streets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#pointBarriers) */ pointBarriers: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl; /** * Use this property to specify polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#polygonBarriers) */ polygonBarriers: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl; /** * Use this property to specify one or more lines that prohibit travel anywhere the lines intersect the streets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#polylineBarriers) */ polylineBarriers: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl; /** * Use this property to specify if the Object IDs specified for input locations such as stops or barriers should be preserved when the input locations are returned as output. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#preserveObjectID) */ preserveObjectID: boolean; /** * Use this property to specify which restrictions should be honored by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#restrictionAttributes) */ restrictionAttributes: ( | "any-hazmat-prohibited" | "avoid-carpool-roads" | "avoid-express-lanes" | "avoid-ferries" | "avoid-gates" | "avoid-limited-access-roads" | "avoid-private-roads" | "avoid-roads-unsuitable-for-pedestrians" | "avoid-stairways" | "avoid-toll-roads" | "avoid-toll-roads-for-trucks" | "avoid-truck-restricted-roads" | "avoid-unpaved-roads" | "axle-count-restriction" | "driving-a-bus" | "driving-a-taxi" | "driving-a-truck" | "driving-an-automobile" | "driving-an-emergency-vehicle" | "height-restriction" | "kingpin-to-rear-axle-length-restriction" | "length-restriction" | "preferred-for-pedestrians" | "riding-a-motorcycle" | "roads-under-construction-prohibited" | "semi-or-tractor-with-one-or-more-trailers-prohibited" | "single-axle-vehicles-prohibited" | "tandem-axle-vehicles-prohibited" | "through-traffic-prohibited" | "truck-with-trailers-restriction" | "use-preferred-hazmat-routes" | "use-preferred-truck-routes" | "walking" | "weight-restriction" | string )[]; /** * Specifies how U-Turns should be handled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#restrictUTurns) */ restrictUTurns: "allow-backtrack" | "at-dead-ends-only" | "no-backtrack" | "at-dead-ends-and-intersections"; /** * Specify whether the operation should generate driving directions for each route. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnDirections) */ returnDirections: boolean; /** * Determines if facilities will be returned by the service. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnFacilities) */ returnFacilities: boolean; /** * Determines if incidents will be returned by the service. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnIncidents) */ returnIncidents: boolean; /** * Specify whether [point barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#pointBarriers) will be returned by the routing operation. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnPointBarriers) */ returnPointBarriers: boolean; /** * Specify whether [polygon barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#polygonBarriers) will be returned by the routing operation. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnPolygonBarriers) */ returnPolygonBarriers: boolean; /** * Specify whether [polyline barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#polylineBarriers) will be returned by the routing operation. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnPolylineBarriers) */ returnPolylineBarriers: boolean; /** * Use this property to specify if the operation should return routes. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnRoutes) */ returnRoutes: boolean; /** * Specify whether traversed edges will be returned by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnTraversedEdges) */ returnTraversedEdges: boolean; /** * Specify whether traversed junctions will be returned by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnTraversedJunctions) */ returnTraversedJunctions: boolean; /** * Specify whether traversed turns will be returned by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnTraversedTurns) */ returnTraversedTurns: boolean; /** * Include z values for the returned geometries if supported by the underlying network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnZ) */ returnZ: boolean; /** * Specify the time and date to depart from or arrive at incidents or facilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#timeOfDay) */ timeOfDay: Date | "now"; /** * Specify the time zone or zones of the [timeOfDay](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#timeOfDay) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#timeOfDayIsUTC) */ timeOfDayIsUTC: boolean; /** * The [timeOfDay](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#timeOfDay) parameter value represents the arrival or departure time for the routes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#timeOfDayUsage) */ timeOfDayUsage: "start" | "end"; /** * Specifies how the travel direction for the closest facility search will be measured. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#travelDirection) */ travelDirection: "from-facility" | "to-facility"; /** * A travel mode represents a means of transportation, such as driving or walking. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#travelMode) */ travelMode: TravelMode; /** * Specify whether hierarchy should be used when finding the shortest paths. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#useHierarchy) */ useHierarchy: boolean; /** * ClosestFacilityParameters provides the input parameters for a [closestFacility](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-closestFacility.html) request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html) */ constructor(properties?: ClosestFacilityParametersProperties); static fromJSON(json: any): ClosestFacilityParameters; } interface ClosestFacilityParametersProperties { /** * Use this property to specify whether the operation should accumulate values other than the value specified for [impedanceAttribute](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#impedanceAttribute). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#accumulateAttributes) */ accumulateAttributes?: ( | "kilometers" | "miles" | "minutes" | "travel-time" | "truck-minutes" | "truck-travel-time" | "walk-time" | string )[]; /** * An authorization string used to access a resource or service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#apiKey) */ apiKey?: string; /** * Use this property to specify additional values required by an attribute or restriction, such as to specify whether the restriction prohibits, avoids, or prefers travel on restricted roads. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#attributeParameterValues) */ attributeParameterValues?: AttributeParameterValue[]; /** * The travel time or travel distance value at which to stop searching for facilities for a given incident. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#defaultCutoff) */ defaultCutoff?: number; /** * The number of closest facilities to find per incident. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#defaultTargetFacilityCount) */ defaultTargetFacilityCount?: number; /** * The language that will be used when generating travel directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#directionsLanguage) */ directionsLanguage?: string; /** * Specify the units for displaying travel distance in the driving directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#directionsLengthUnits) */ directionsLengthUnits?: | "centimeters" | "decimal-degrees" | "decimeters" | "feet" | "inches" | "kilometers" | "meters" | "miles" | "millimeters" | "nautical-miles" | "points" | "yards"; /** * Define the content and verbosity of the driving directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#directionsOutputType) */ directionsOutputType?: | "complete" | "complete-no-events" | "featuresets" | "instructions-only" | "standard" | "summary-only"; /** * Specify the name of the formatting style for the directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#directionsStyleName) */ directionsStyleName?: "desktop" | "navigation" | "campus"; /** * Set the time-based impedance attribute to display the duration of a maneuver, such as "Go northwest on Alvorado St. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#directionsTimeAttribute) */ directionsTimeAttribute?: "travel-time" | "truck-travel-time" | "walk-time" | "minutes" | "truck-time" | string; /** * One or more locations that are searched for when finding the closest location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#facilities) */ facilities?: | (DataLayerProperties & { type: "layer" }) | FeatureSetProperties | NetworkFeatureSetProperties | NetworkUrlProperties; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#geometryPrecision) */ geometryPrecision?: number; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#geometryPrecisionM) */ geometryPrecisionM?: number; /** * Use this property to specify the number of decimal places in the response geometries returned by a solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#geometryPrecisionZ) */ geometryPrecisionZ?: number; /** * Specify whether invalid input locations should be ignored when finding the best solution. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#ignoreInvalidLocations) */ ignoreInvalidLocations?: boolean; /** * Specifies the impedance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#impedanceAttribute) */ impedanceAttribute?: | "kilometers" | "miles" | "minutes" | "travel-time" | "truck-minutes" | "truck-travel-time" | "walk-time" | string; /** * One or more locations from which the service searches for the nearby locations * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#incidents) */ incidents?: | (DataLayerProperties & { type: "layer" }) | FeatureSetProperties | NetworkFeatureSetProperties | NetworkUrlProperties; /** * Use this property to specify by how much you want to simplify the route geometry returned by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#outputGeometryPrecision) */ outputGeometryPrecision?: number; /** * Use this property to specify the units for the value specified for the [outputGeometryPrecision](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#outputGeometryPrecision) parameter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#outputGeometryPrecisionUnits) */ outputGeometryPrecisionUnits?: | "centimeters" | "decimal-degrees" | "decimeters" | "feet" | "inches" | "kilometers" | "meters" | "miles" | "millimeters" | "nautical-miles" | "points" | "yards"; /** * Use this property to specify the type of route features that are output by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#outputLines) */ outputLines?: "none" | "straight" | "true-shape" | "true-shape-with-measure"; /** * Use this property to specify the spatial reference of the geometries, such as line or point features, returned by a solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; /** * Specify additional settings that can influence the behavior of the solver when finding solutions for the network analysis problems. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#overrides) */ overrides?: any; /** * Use this property to specify one or more points that will act as temporary restrictions or represent additional time or distance that may be required to travel on the underlying streets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#pointBarriers) */ pointBarriers?: | CollectionProperties | (DataLayerProperties & { type: "layer" }) | FeatureSetProperties | NetworkFeatureSetProperties | NetworkUrlProperties; /** * Use this property to specify polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#polygonBarriers) */ polygonBarriers?: | CollectionProperties | (DataLayerProperties & { type: "layer" }) | FeatureSetProperties | NetworkFeatureSetProperties | NetworkUrlProperties; /** * Use this property to specify one or more lines that prohibit travel anywhere the lines intersect the streets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#polylineBarriers) */ polylineBarriers?: | CollectionProperties | (DataLayerProperties & { type: "layer" }) | FeatureSetProperties | NetworkFeatureSetProperties | NetworkUrlProperties; /** * Use this property to specify if the Object IDs specified for input locations such as stops or barriers should be preserved when the input locations are returned as output. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#preserveObjectID) */ preserveObjectID?: boolean; /** * Use this property to specify which restrictions should be honored by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#restrictionAttributes) */ restrictionAttributes?: ( | "any-hazmat-prohibited" | "avoid-carpool-roads" | "avoid-express-lanes" | "avoid-ferries" | "avoid-gates" | "avoid-limited-access-roads" | "avoid-private-roads" | "avoid-roads-unsuitable-for-pedestrians" | "avoid-stairways" | "avoid-toll-roads" | "avoid-toll-roads-for-trucks" | "avoid-truck-restricted-roads" | "avoid-unpaved-roads" | "axle-count-restriction" | "driving-a-bus" | "driving-a-taxi" | "driving-a-truck" | "driving-an-automobile" | "driving-an-emergency-vehicle" | "height-restriction" | "kingpin-to-rear-axle-length-restriction" | "length-restriction" | "preferred-for-pedestrians" | "riding-a-motorcycle" | "roads-under-construction-prohibited" | "semi-or-tractor-with-one-or-more-trailers-prohibited" | "single-axle-vehicles-prohibited" | "tandem-axle-vehicles-prohibited" | "through-traffic-prohibited" | "truck-with-trailers-restriction" | "use-preferred-hazmat-routes" | "use-preferred-truck-routes" | "walking" | "weight-restriction" | string )[]; /** * Specifies how U-Turns should be handled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#restrictUTurns) */ restrictUTurns?: "allow-backtrack" | "at-dead-ends-only" | "no-backtrack" | "at-dead-ends-and-intersections"; /** * Specify whether the operation should generate driving directions for each route. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnDirections) */ returnDirections?: boolean; /** * Determines if facilities will be returned by the service. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnFacilities) */ returnFacilities?: boolean; /** * Determines if incidents will be returned by the service. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnIncidents) */ returnIncidents?: boolean; /** * Specify whether [point barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#pointBarriers) will be returned by the routing operation. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnPointBarriers) */ returnPointBarriers?: boolean; /** * Specify whether [polygon barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#polygonBarriers) will be returned by the routing operation. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnPolygonBarriers) */ returnPolygonBarriers?: boolean; /** * Specify whether [polyline barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#polylineBarriers) will be returned by the routing operation. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnPolylineBarriers) */ returnPolylineBarriers?: boolean; /** * Use this property to specify if the operation should return routes. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnRoutes) */ returnRoutes?: boolean; /** * Specify whether traversed edges will be returned by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnTraversedEdges) */ returnTraversedEdges?: boolean; /** * Specify whether traversed junctions will be returned by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnTraversedJunctions) */ returnTraversedJunctions?: boolean; /** * Specify whether traversed turns will be returned by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnTraversedTurns) */ returnTraversedTurns?: boolean; /** * Include z values for the returned geometries if supported by the underlying network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnZ) */ returnZ?: boolean; /** * Specify the time and date to depart from or arrive at incidents or facilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#timeOfDay) */ timeOfDay?: DateProperties | "now"; /** * Specify the time zone or zones of the [timeOfDay](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#timeOfDay) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#timeOfDayIsUTC) */ timeOfDayIsUTC?: boolean; /** * The [timeOfDay](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#timeOfDay) parameter value represents the arrival or departure time for the routes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#timeOfDayUsage) */ timeOfDayUsage?: "start" | "end"; /** * Specifies how the travel direction for the closest facility search will be measured. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#travelDirection) */ travelDirection?: "from-facility" | "to-facility"; /** * A travel mode represents a means of transportation, such as driving or walking. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#travelMode) */ travelMode?: TravelModeProperties; /** * Specify whether hierarchy should be used when finding the shortest paths. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#useHierarchy) */ useHierarchy?: boolean; } /** * An object describing the parameter values for the [attributeParameterValues](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#attributeParameterValues) property of [ClosestFacilityParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#AttributeParameterValue) */ export interface AttributeParameterValue { /** * The name of the restriction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#AttributeParameterValue) */ attributeName: string; /** * The name of the parameter associated with the restriction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#AttributeParameterValue) */ parameterName: string; /** * The value for `parameterName`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#AttributeParameterValue) */ value: string | number; } export interface ClosestFacilitySolveResult extends Accessor, JSONSupport { } export class ClosestFacilitySolveResult { /** * Direction lines contains a set of line features for each segment of the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#directionLines) */ directionLines: FeatureSet; /** * Direction points contains a set of point features representing the direction maneuvers such as arriving to or departing from a stop, turning left or right, and other events along your route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#directionPoints) */ directionPoints: FeatureSet; /** * Directions are returned if [ClosestFacilityParameters.returnDirections](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnDirections) is set to `true` and [ClosestFacilityParameters.directionsOutputType](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#directionsOutputType) is set to `complete`, `complete-no-events`, `instructions-only', `standard` or `summary-only` in a [closestFacility.solve()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-closestFacility.html#solve) request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#directions) */ directions: DirectionsFeatureSet[]; /** * This provides access to the output facilities from a closest facility analysis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#facilities) */ facilities: FeatureSet; /** * This provides access to the locations used as starting or ending points in a closest facility analysis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#incidents) */ incidents: FeatureSet; /** * An array of processing [messages](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-NAMessage.html) generated by the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#messages) */ messages: NAMessage[]; /** * A set of features representing point barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#pointBarriers) */ pointBarriers: FeatureSet; /** * A set of features representing polygon barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#polygonBarriers) */ polygonBarriers: FeatureSet; /** * A set of features representing polyline barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#polylineBarriers) */ polylineBarriers: FeatureSet; /** * A set of features representing routes between the facilities and the incidents. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#routes) */ routes: FeatureSet; /** * This provides access to the edges that are traversed while solving a network analysis layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#traversedEdges) */ traversedEdges: FeatureSet; /** * This provides access to the junctions that are traversed while solving a network analysis layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#traversedJunctions) */ traversedJunctions: FeatureSet; /** * This provides access to the turns that are traversed while solving a network analysis layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#traversedTurns) */ traversedTurns: FeatureSet; /** * The result from [closestFacility](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-closestFacility.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html) */ constructor(properties?: ClosestFacilitySolveResultProperties); static fromJSON(json: any): ClosestFacilitySolveResult; } interface ClosestFacilitySolveResultProperties { /** * Direction lines contains a set of line features for each segment of the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#directionLines) */ directionLines?: FeatureSetProperties; /** * Direction points contains a set of point features representing the direction maneuvers such as arriving to or departing from a stop, turning left or right, and other events along your route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#directionPoints) */ directionPoints?: FeatureSetProperties; /** * Directions are returned if [ClosestFacilityParameters.returnDirections](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#returnDirections) is set to `true` and [ClosestFacilityParameters.directionsOutputType](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html#directionsOutputType) is set to `complete`, `complete-no-events`, `instructions-only', `standard` or `summary-only` in a [closestFacility.solve()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-closestFacility.html#solve) request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#directions) */ directions?: DirectionsFeatureSetProperties[]; /** * This provides access to the output facilities from a closest facility analysis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#facilities) */ facilities?: FeatureSetProperties; /** * This provides access to the locations used as starting or ending points in a closest facility analysis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#incidents) */ incidents?: FeatureSetProperties; /** * An array of processing [messages](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-NAMessage.html) generated by the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#messages) */ messages?: NAMessageProperties[]; /** * A set of features representing point barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#pointBarriers) */ pointBarriers?: FeatureSetProperties; /** * A set of features representing polygon barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#polygonBarriers) */ polygonBarriers?: FeatureSetProperties; /** * A set of features representing polyline barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#polylineBarriers) */ polylineBarriers?: FeatureSetProperties; /** * A set of features representing routes between the facilities and the incidents. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#routes) */ routes?: FeatureSetProperties; /** * This provides access to the edges that are traversed while solving a network analysis layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#traversedEdges) */ traversedEdges?: FeatureSetProperties; /** * This provides access to the junctions that are traversed while solving a network analysis layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#traversedJunctions) */ traversedJunctions?: FeatureSetProperties; /** * This provides access to the turns that are traversed while solving a network analysis layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html#traversedTurns) */ traversedTurns?: FeatureSetProperties; } export interface ColorRamp extends Accessor, JSONSupport { } export class ColorRamp { /** * A string value representing the color ramp type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ColorRamp.html#type) */ readonly type: "algorithmic" | "multipart"; /** * A ColorRamp object is used to specify a range of colors that are applied to a group of symbols or pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ColorRamp.html) */ constructor(properties?: ColorRampProperties); static fromJSON(json: any): ColorRamp; } interface ColorRampProperties { } export interface DataFile extends Accessor, JSONSupport { } export class DataFile { /** * The ID of the uploaded file returned as a result of the upload operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DataFile.html#itemId) */ itemId: string; /** * URL to the location of the data file. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DataFile.html#url) */ url: string; /** * A geoprocessing data object containing a data source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DataFile.html) */ constructor(properties?: DataFileProperties); static fromJSON(json: any): DataFile; } interface DataFileProperties { /** * The ID of the uploaded file returned as a result of the upload operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DataFile.html#itemId) */ itemId?: string; /** * URL to the location of the data file. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DataFile.html#url) */ url?: string; } export interface DataLayer extends Accessor, JSONSupport { } export class DataLayer { /** * If true, restricted network elements should be considered when finding network locations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DataLayer.html#doNotLocateOnRestrictedElements) */ doNotLocateOnRestrictedElements: boolean; /** * The geometry to apply to the spatial filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DataLayer.html#geometry) */ geometry: Geometry; /** * The type of geometry specified by the [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DataLayer.html#geometry) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DataLayer.html#geometryType) */ geometryType: "point" | "polyline" | "polygon" | "envelope" | "multipoint"; /** * The name of the data layer in the map service that is being referenced. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DataLayer.html#name) */ name: string; /** * The spatial relationship to be applied on the input geometry while performing the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DataLayer.html#spatialRelationship) */ spatialRelationship: | "intersects" | "contains" | "crosses" | "envelope-intersects" | "index-intersects" | "overlaps" | "touches" | "within" | "relation"; type: "layer"; /** * A where clause for the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DataLayer.html#where) */ where: string; /** * Input for properties of ClosestFacilityParameters, RouteParameters or ServiceAreaParameters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DataLayer.html) */ constructor(properties?: DataLayerProperties); static fromJSON(json: any): DataLayer; } interface DataLayerProperties { /** * If true, restricted network elements should be considered when finding network locations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DataLayer.html#doNotLocateOnRestrictedElements) */ doNotLocateOnRestrictedElements?: boolean; /** * The geometry to apply to the spatial filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DataLayer.html#geometry) */ geometry?: GeometryProperties; /** * The type of geometry specified by the [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DataLayer.html#geometry) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DataLayer.html#geometryType) */ geometryType?: "point" | "polyline" | "polygon" | "envelope" | "multipoint"; /** * The name of the data layer in the map service that is being referenced. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DataLayer.html#name) */ name?: string; /** * The spatial relationship to be applied on the input geometry while performing the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DataLayer.html#spatialRelationship) */ spatialRelationship?: | "intersects" | "contains" | "crosses" | "envelope-intersects" | "index-intersects" | "overlaps" | "touches" | "within" | "relation"; type?: "layer"; /** * A where clause for the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DataLayer.html#where) */ where?: string; } export class DensifyParameters extends Accessor { /** * If `true`, Geographic Coordinate System spatial references are used or densify geodesic will be performed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DensifyParameters.html#geodesic) */ geodesic: boolean; /** * The array of geometries to be densified. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DensifyParameters.html#geometries) */ geometries: Geometry[]; /** * The length unit of `maxSegmentLength`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DensifyParameters.html#lengthUnit) */ lengthUnit: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards"; /** * All segments longer than `maxSegmentLength` are replaced with sequences of lines no longer than `maxSegmentLength.` * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DensifyParameters.html#maxSegmentLength) */ maxSegmentLength: number; /** * Input parameters for the densify() method on the GeometryService. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DensifyParameters.html) */ constructor(properties?: DensifyParametersProperties); /** * Converts an instance of this class to its ArcGIS portal JSON representation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DensifyParameters.html#toJSON) */ toJSON(): any; } interface DensifyParametersProperties { /** * If `true`, Geographic Coordinate System spatial references are used or densify geodesic will be performed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DensifyParameters.html#geodesic) */ geodesic?: boolean; /** * The array of geometries to be densified. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DensifyParameters.html#geometries) */ geometries?: GeometryProperties[]; /** * The length unit of `maxSegmentLength`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DensifyParameters.html#lengthUnit) */ lengthUnit?: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards"; /** * All segments longer than `maxSegmentLength` are replaced with sequences of lines no longer than `maxSegmentLength.` * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DensifyParameters.html#maxSegmentLength) */ maxSegmentLength?: number; } export interface DirectionLine extends Accessor, JSONSupport { } export class DirectionLine { /** * The type of line which is defined by esriDirectionLineType. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionLine.html#directionLineType) */ directionLineType: | "unknown" | "segment" | "maneuver-segment" | "restriction-violation" | "scaled-cost-barrier" | "heavy-traffic" | "slow-traffic" | "moderate-traffic"; /** * Length of the line measured in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionLine.html#distance) */ distance: number; /** * Time of the line measured in minutes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionLine.html#duration) */ duration: number; /** * Polyline representing the direction's location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionLine.html#geometry) */ geometry: Polyline; readonly type: "direction-line"; /** * The DirectionLine represents polylines associated with individual direction items. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionLine.html) */ constructor(properties?: DirectionLineProperties); /** * Creates a [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) from the [DirectionLine](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionLine.html) instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionLine.html#toGraphic) */ toGraphic(): Graphic; /** * Creates a [DirectionLine](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionLine.html) from the parsed [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionLine.html#fromGraphic) */ static fromGraphic(graphic?: Graphic): DirectionLine; static fromJSON(json: any): DirectionLine; } interface DirectionLineProperties { /** * The type of line which is defined by esriDirectionLineType. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionLine.html#directionLineType) */ directionLineType?: | "unknown" | "segment" | "maneuver-segment" | "restriction-violation" | "scaled-cost-barrier" | "heavy-traffic" | "slow-traffic" | "moderate-traffic"; /** * Length of the line measured in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionLine.html#distance) */ distance?: number; /** * Time of the line measured in minutes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionLine.html#duration) */ duration?: number; /** * Polyline representing the direction's location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionLine.html#geometry) */ geometry?: PolylineProperties; } export interface DirectionPoint extends Accessor, JSONSupport { } export class DirectionPoint { /** * Time when the action happens. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionPoint.html#arrivalTime) */ arrivalTime: Date; /** * The type of directions event or maneuver described by the point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionPoint.html#directionPointType) */ directionPointType: | "header" | "arrive" | "depart" | "straight" | "on-ferry" | "off-ferry" | "central-fork" | "roundabout" | "u-turn" | "door" | "stairs" | "elevator" | "escalator" | "pedestrian-ramp" | "left-fork" | "left-ramp" | "clockwise-roundabout" | "left-handed-u-turn" | "bear-left" | "left-turn" | "sharp-left" | "left-turn-and-immediate-left-turn" | "left-turn-and-immediate-right-turn" | "right-fork" | "right-ramp" | "counter-clockwise-roundabout" | "right-handed-u-turn" | "bear-right" | "right-turn" | "sharp-right" | "right-turn-and-immediate-left-turn" | "right-turn-and-immediate-right-turn" | "up-elevator" | "up-escalator" | "up-stairs" | "down-elevator" | "down-escalator" | "down-stairs" | "general-event" | "landmark" | "time-zone-change" | "traffic-event" | "scaled-cost-barrier-event" | "boundary-crossing" | "restriction-violation"; /** * The direction item text to dispay on the screen. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionPoint.html#displayText) */ displayText: string; /** * The local time offset (in minutes) for the arrival time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionPoint.html#endTimeOffset) */ endTimeOffset: number; /** * Point representing the direction's location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionPoint.html#geometry) */ geometry: Point; /** * Sequence of the Direction items, starting with 1. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionPoint.html#sequence) */ sequence: number; readonly type: "direction-point"; /** * The DirectionPoint represents direction items as points with various display information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionPoint.html) */ constructor(properties?: DirectionPointProperties); /** * Creates a [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) from the [DirectionPoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionPoint.html) instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionPoint.html#toGraphic) */ toGraphic(): Graphic; /** * Creates a [DirectionPoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionPoint.html) from the parsed [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionPoint.html#fromGraphic) */ static fromGraphic(graphic?: Graphic): DirectionPoint; static fromJSON(json: any): DirectionPoint; } interface DirectionPointProperties { /** * Time when the action happens. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionPoint.html#arrivalTime) */ arrivalTime?: DateProperties; /** * The type of directions event or maneuver described by the point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionPoint.html#directionPointType) */ directionPointType?: | "header" | "arrive" | "depart" | "straight" | "on-ferry" | "off-ferry" | "central-fork" | "roundabout" | "u-turn" | "door" | "stairs" | "elevator" | "escalator" | "pedestrian-ramp" | "left-fork" | "left-ramp" | "clockwise-roundabout" | "left-handed-u-turn" | "bear-left" | "left-turn" | "sharp-left" | "left-turn-and-immediate-left-turn" | "left-turn-and-immediate-right-turn" | "right-fork" | "right-ramp" | "counter-clockwise-roundabout" | "right-handed-u-turn" | "bear-right" | "right-turn" | "sharp-right" | "right-turn-and-immediate-left-turn" | "right-turn-and-immediate-right-turn" | "up-elevator" | "up-escalator" | "up-stairs" | "down-elevator" | "down-escalator" | "down-stairs" | "general-event" | "landmark" | "time-zone-change" | "traffic-event" | "scaled-cost-barrier-event" | "boundary-crossing" | "restriction-violation"; /** * The direction item text to dispay on the screen. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionPoint.html#displayText) */ displayText?: string; /** * The local time offset (in minutes) for the arrival time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionPoint.html#endTimeOffset) */ endTimeOffset?: number; /** * Point representing the direction's location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionPoint.html#geometry) */ geometry?: PointProperties; /** * Sequence of the Direction items, starting with 1. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionPoint.html#sequence) */ sequence?: number; } export interface DirectionsEvent extends Accessor, JSONSupport { } export class DirectionsEvent { /** * The date and time value indicating the arrival time at the Directions Event. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsEvent.html#arriveTime) */ arriveTime: Date; /** * The local time offset (in minutes) for the arrival time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsEvent.html#arriveTimeOffset) */ arriveTimeOffset: number; /** * The point location of the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsEvent.html#geometry) */ geometry: Point; /** * An array of [direction strings](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#DirectionsString). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsEvent.html#strings) */ strings: DirectionsString[]; /** * DirectionsEvent represent [events](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeature.html#events) for features in a [DirectionsFeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsEvent.html) */ constructor(properties?: DirectionsEventProperties); static fromJSON(json: any): DirectionsEvent; } interface DirectionsEventProperties { /** * The date and time value indicating the arrival time at the Directions Event. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsEvent.html#arriveTime) */ arriveTime?: DateProperties; /** * The local time offset (in minutes) for the arrival time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsEvent.html#arriveTimeOffset) */ arriveTimeOffset?: number; /** * The point location of the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsEvent.html#geometry) */ geometry?: PointProperties; /** * An array of [direction strings](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#DirectionsString). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsEvent.html#strings) */ strings?: DirectionsString[]; } export class DirectionsFeature { /** * Name-value pairs of fields and field values associated with the Directions Feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeature.html#attributes) */ attributes: any; /** * An array of Direction Events. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeature.html#events) */ events: DirectionsEvent[]; /** * The geometry of the Directions Feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeature.html#geometry) */ geometry: Polyline; /** * An array of [direction strings](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#DirectionsString). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeature.html#strings) */ strings: DirectionsString[]; constructor(properties?: any); } export interface DirectionsFeatureSet extends FeatureSet, Accessor { } export class DirectionsFeatureSet { /** * The extent of the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#extent) */ extent: Extent; /** * The geometry type of the Directions FeatureSet. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#geometryType) */ geometryType: "polyline"; /** * A single polyline representing the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#mergedGeometry) */ mergedGeometry: Polyline; /** * The ID of the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#routeId) */ routeId: number; /** * The name of the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#routeName) */ routeName: string; /** * A flattened array of all [direction strings](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#DirectionsString). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#strings) */ strings: DirectionsString[]; /** * The total drive time for the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#totalDriveTime) */ totalDriveTime: number; /** * The total length of the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#totalLength) */ totalLength: number; /** * The total time for the route including wait and service time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#totalTime) */ totalTime: number; /** * DirectionsFeatureSet is a subclass of [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html) that contains street directions for a [solved route](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-route.html#solve). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html) */ constructor(properties?: DirectionsFeatureSetProperties); static fromJSON(json: any): DirectionsFeatureSet; } interface DirectionsFeatureSetProperties extends FeatureSetProperties { /** * The extent of the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#extent) */ extent?: ExtentProperties; /** * The geometry type of the Directions FeatureSet. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#geometryType) */ geometryType?: "polyline"; /** * A single polyline representing the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#mergedGeometry) */ mergedGeometry?: PolylineProperties; /** * The ID of the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#routeId) */ routeId?: number; /** * The name of the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#routeName) */ routeName?: string; /** * A flattened array of all [direction strings](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#DirectionsString). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#strings) */ strings?: DirectionsString[]; /** * The total drive time for the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#totalDriveTime) */ totalDriveTime?: number; /** * The total length of the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#totalLength) */ totalLength?: number; /** * The total time for the route including wait and service time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#totalTime) */ totalTime?: number; } /** * An event string object with name and type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#DirectionsString) */ export interface DirectionsString { /** * The direction text. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsFeatureSet.html#DirectionsString) */ text: string; /** * The type of event. * * [Read more...](global.html#type) */ type: | "alt-name" | "arrive" | "branch" | "cross-street" | "cumulative-length" | "depart" | "estimated-arrival-time" | "exit" | "general" | "length" | "service-time" | "street-name" | "summary" | "time" | "time-window" | "toward" | "violation-time" | "wait-time"; } export class DistanceParameters extends Accessor { /** * Specifies the units for measuring distance between [geometry1](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DistanceParameters.html#geometry1) and [geometry2](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DistanceParameters.html#geometry2). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DistanceParameters.html#distanceUnit) */ distanceUnit: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards"; /** * When `true`, the geodesic distance between [geometry1](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DistanceParameters.html#geometry1) and [geometry2](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DistanceParameters.html#geometry2) is measured. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DistanceParameters.html#geodesic) */ geodesic: boolean; /** * The geometry from which the distance is to be measured. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DistanceParameters.html#geometry1) */ geometry1: Geometry; /** * The geometry to which the distance is to be measured. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DistanceParameters.html#geometry2) */ geometry2: Geometry; /** * Defines the input parameters when calling [geometryService.distance()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#distance). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DistanceParameters.html) */ constructor(properties?: DistanceParametersProperties); /** * Converts an instance of this class to its ArcGIS portal JSON representation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DistanceParameters.html#toJSON) */ toJSON(): any; } interface DistanceParametersProperties { /** * Specifies the units for measuring distance between [geometry1](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DistanceParameters.html#geometry1) and [geometry2](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DistanceParameters.html#geometry2). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DistanceParameters.html#distanceUnit) */ distanceUnit?: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards"; /** * When `true`, the geodesic distance between [geometry1](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DistanceParameters.html#geometry1) and [geometry2](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DistanceParameters.html#geometry2) is measured. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DistanceParameters.html#geodesic) */ geodesic?: boolean; /** * The geometry from which the distance is to be measured. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DistanceParameters.html#geometry1) */ geometry1?: GeometryProperties; /** * The geometry to which the distance is to be measured. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DistanceParameters.html#geometry2) */ geometry2?: GeometryProperties; } export interface FeatureSet extends Accessor, JSONSupport { } export class FeatureSet { /** * The name of the layer's primary display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html#displayFieldName) */ displayFieldName: string; /** * Typically, a layer has a limit on the number of features (i.e., records) returned by the query operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html#exceededTransferLimit) */ exceededTransferLimit: boolean; /** * The array of graphics returned from a task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html#features) */ features: Graphic[]; /** * Information about each field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html#fields) */ fields: Field[]; /** * The geometry type of features in the FeatureSet. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html#geometryType) */ geometryType: "point" | "multipoint" | "polyline" | "polygon" | "extent" | "mesh"; /** * The [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#geometry) used to query the features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html#queryGeometry) */ queryGeometry: Geometry; /** * When a FeatureSet is used as input to Geoprocessor, the spatial reference is set to the map's spatial reference by default. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html#spatialReference) */ spatialReference: SpatialReference; /** * A collection of features returned from ArcGIS Server or used as input to methods. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html) */ constructor(properties?: FeatureSetProperties); static fromJSON(json: any): FeatureSet; } interface FeatureSetProperties { /** * The name of the layer's primary display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html#displayFieldName) */ displayFieldName?: string; /** * Typically, a layer has a limit on the number of features (i.e., records) returned by the query operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html#exceededTransferLimit) */ exceededTransferLimit?: boolean; /** * The array of graphics returned from a task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html#features) */ features?: GraphicProperties[]; /** * Information about each field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html#fields) */ fields?: FieldProperties[]; /** * The geometry type of features in the FeatureSet. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html#geometryType) */ geometryType?: "point" | "multipoint" | "polyline" | "polygon" | "extent" | "mesh"; /** * The [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#geometry) used to query the features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html#queryGeometry) */ queryGeometry?: GeometryProperties; /** * When a FeatureSet is used as input to Geoprocessor, the spatial reference is set to the map's spatial reference by default. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; } export class FetchPlaceParameters extends PlacesParameters { /** * The Id of the place that you want to fetch additional details. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FetchPlaceParameters.html#placeId) */ placeId: string; /** * The array of fields that define the attributes to return for a place. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FetchPlaceParameters.html#requestedFields) */ requestedFields: string[]; /** * The following properties define the parameters for the [fetchPlace()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-places.html#fetchPlace) method pointing to a [url](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FetchPlaceParameters.html#url) that represents a places service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FetchPlaceParameters.html) */ constructor(properties?: FetchPlaceParametersProperties); } interface FetchPlaceParametersProperties extends PlacesParametersProperties { /** * The Id of the place that you want to fetch additional details. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FetchPlaceParameters.html#placeId) */ placeId?: string; /** * The array of fields that define the attributes to return for a place. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FetchPlaceParameters.html#requestedFields) */ requestedFields?: string[]; } export class FindImagesParameters extends JSONSupport { /** * A [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometry with `z` value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindImagesParameters.html#fromGeometry) */ fromGeometry: Point; /** * The maximum image count. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindImagesParameters.html#maxCount) */ maxCount: number; /** * An array of ObjectIDs to filter images. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindImagesParameters.html#objectIds) */ objectIds: number[]; /** * A [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometry with `z` value that defines the target geometry's location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindImagesParameters.html#toGeometry) */ toGeometry: Point; /** * A where clause for the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindImagesParameters.html#where) */ where: string; /** * Input parameter for the [ImageryLayer.findImages()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#findImages) or [imageService.findImages()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#findImages) methods. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindImagesParameters.html) */ constructor(properties?: FindImagesParametersProperties); static fromJSON(json: any): FindImagesParameters; } interface FindImagesParametersProperties { /** * A [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometry with `z` value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindImagesParameters.html#fromGeometry) */ fromGeometry?: PointProperties; /** * The maximum image count. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindImagesParameters.html#maxCount) */ maxCount?: number; /** * An array of ObjectIDs to filter images. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindImagesParameters.html#objectIds) */ objectIds?: number[]; /** * A [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometry with `z` value that defines the target geometry's location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindImagesParameters.html#toGeometry) */ toGeometry?: PointProperties; /** * A where clause for the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindImagesParameters.html#where) */ where?: string; } export class FindImagesResult extends JSONSupport { /** * An array of image inspection information found between [fromGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindImagesParameters.html#fromGeometry) and [toGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindImagesParameters.html#toGeometry). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindImagesResult.html#images) */ images: ImageInspectionInfo[]; /** * Results for the [ImageryLayer.findImages()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#findImages) or [imageService.findImages()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#findImages) methods containing images that meet the search requirements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindImagesResult.html) */ constructor(properties?: FindImagesResultProperties); static fromJSON(json: any): FindImagesResult; } interface FindImagesResultProperties { /** * An array of image inspection information found between [fromGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindImagesParameters.html#fromGeometry) and [toGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindImagesParameters.html#toGeometry). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindImagesResult.html#images) */ images?: ImageInspectionInfoProperties[]; } export interface FindParameters extends Accessor, JSONSupport { } export class FindParameters { /** * Determines whether to look for an exact match of the search text or not. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html#contains) */ contains: boolean; /** * Specify the geodatabase version to search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html#gdbVersion) */ gdbVersion: string; /** * Specify the number of decimal places for the geometries returned by the task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html#geometryPrecision) */ geometryPrecision: number; /** * The layers to perform the find operation on. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html#layerIds) */ layerIds: number[]; /** * The maximum allowable offset used for generalizing geometries returned by the find operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html#maxAllowableOffset) */ maxAllowableOffset: number; /** * The spatial reference of the output geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * If `true`, the output will include the geometry associated with each result. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html#returnGeometry) */ returnGeometry: boolean; /** * The names of the fields of a layer to search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html#searchFields) */ searchFields: string[]; /** * The text that is searched across the layers and the fields as specified in the `layers` and [searchFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html#searchFields) properties. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html#searchText) */ searchText: string; /** * Input parameters for [find](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-find.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html) */ constructor(properties?: FindParametersProperties); static fromJSON(json: any): FindParameters; } interface FindParametersProperties { /** * Determines whether to look for an exact match of the search text or not. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html#contains) */ contains?: boolean; /** * Specify the geodatabase version to search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html#gdbVersion) */ gdbVersion?: string; /** * Specify the number of decimal places for the geometries returned by the task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html#geometryPrecision) */ geometryPrecision?: number; /** * The layers to perform the find operation on. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html#layerIds) */ layerIds?: number[]; /** * The maximum allowable offset used for generalizing geometries returned by the find operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html#maxAllowableOffset) */ maxAllowableOffset?: number; /** * The spatial reference of the output geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; /** * If `true`, the output will include the geometry associated with each result. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html#returnGeometry) */ returnGeometry?: boolean; /** * The names of the fields of a layer to search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html#searchFields) */ searchFields?: string[]; /** * The text that is searched across the layers and the fields as specified in the `layers` and [searchFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html#searchFields) properties. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html#searchText) */ searchText?: string; } export interface FindResult extends Accessor, JSONSupport { } export class FindResult { /** * The name of the layer's primary display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindResult.html#displayFieldName) */ displayFieldName: string; /** * The found feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindResult.html#feature) */ feature: Graphic; /** * The name of the field that contains the search text. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindResult.html#foundFieldName) */ foundFieldName: string; /** * Unique ID of the layer that contains the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindResult.html#layerId) */ layerId: number; /** * The layer name that contains the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindResult.html#layerName) */ layerName: string; /** * The value of the `foundFieldName` in the feature's attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindResult.html#value) */ value: string; /** * The result from [find](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-find.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindResult.html) */ constructor(properties?: FindResultProperties); static fromJSON(json: any): FindResult; } interface FindResultProperties { /** * The name of the layer's primary display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindResult.html#displayFieldName) */ displayFieldName?: string; /** * The found feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindResult.html#feature) */ feature?: GraphicProperties; /** * The name of the field that contains the search text. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindResult.html#foundFieldName) */ foundFieldName?: string; /** * Unique ID of the layer that contains the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindResult.html#layerId) */ layerId?: number; /** * The layer name that contains the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindResult.html#layerName) */ layerName?: string; /** * The value of the `foundFieldName` in the feature's attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindResult.html#value) */ value?: string; } export interface GeneralizeParameters extends Accessor, JSONSupport { } export class GeneralizeParameters { /** * The maximum deviation unit. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-GeneralizeParameters.html#deviationUnit) */ deviationUnit: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards"; /** * The array of input geometries to generalize. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-GeneralizeParameters.html#geometries) */ geometries: Geometry[]; /** * The maximum deviation for constructing a generalized geometry based on the input geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-GeneralizeParameters.html#maxDeviation) */ maxDeviation: number; /** * Sets the geometries, maximum deviation and units for the [generalize](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#generalize) operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-GeneralizeParameters.html) */ constructor(properties?: GeneralizeParametersProperties); static fromJSON(json: any): GeneralizeParameters; } interface GeneralizeParametersProperties { /** * The maximum deviation unit. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-GeneralizeParameters.html#deviationUnit) */ deviationUnit?: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards"; /** * The array of input geometries to generalize. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-GeneralizeParameters.html#geometries) */ geometries?: GeometryProperties[]; /** * The maximum deviation for constructing a generalized geometry based on the input geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-GeneralizeParameters.html#maxDeviation) */ maxDeviation?: number; } export interface GPMessage extends Accessor, JSONSupport { } export class GPMessage { /** * The geoprocessing message. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-GPMessage.html#description) */ description: string; /** * The geoprocessing message type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-GPMessage.html#type) */ type: | "informative" | "process-definition" | "process-start" | "process-stop" | "warning" | "error" | "empty" | "abort"; /** * Represents a message generated during the execution of a module:esri/rest/Geoprocessor method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-GPMessage.html) */ constructor(properties?: GPMessageProperties); static fromJSON(json: any): GPMessage; } interface GPMessageProperties { /** * The geoprocessing message. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-GPMessage.html#description) */ description?: string; /** * The geoprocessing message type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-GPMessage.html#type) */ type?: | "informative" | "process-definition" | "process-start" | "process-stop" | "warning" | "error" | "empty" | "abort"; } export interface IdentifyParameters extends Accessor, JSONSupport { } export class IdentifyParameters { /** * Resolution of the current map view in dots per inch. * * @default 96 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#dpi) */ dpi: number; /** * Specify the geodatabase version to search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#gdbVersion) */ gdbVersion: string; /** * The geometry used to select features during the Identify operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#geometry) */ geometry: Geometry; /** * Specify the number of decimal places for the geometries returned by the task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#geometryPrecision) */ geometryPrecision: number; /** * Height of the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) in pixels. * * @default 400 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#height) */ height: number; /** * The historic moment to identify. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#historicMoment) */ historicMoment: Date; /** * The layers on which to perform the identify operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#layerIds) */ layerIds: number[]; /** * Specifies which layers to use when using Identify. * * @default top * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#layerOption) */ layerOption: "top" | "visible" | "all" | "popup"; /** * The Extent or bounding box of the current map view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#mapExtent) */ mapExtent: Extent; /** * The maximum allowable offset used for generalizing geometries returned by the identify operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#maxAllowableOffset) */ maxAllowableOffset: number; /** * If `true`, field names will be returned instead of field aliases. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#returnFieldName) */ returnFieldName: boolean; /** * If `true`, the result set includes the geometry associated with each result. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#returnGeometry) */ returnGeometry: boolean; /** * When `true`, indicates that M values will be returned. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#returnM) */ returnM: boolean; /** * If `true`, the values in the result will not be formatted i.e. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#returnUnformattedValues) */ returnUnformattedValues: boolean; /** * When `true`, indicates that z-values will be returned. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#returnZ) */ returnZ: boolean; /** * The spatial reference of the input and output geometries as well as of the [mapExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#mapExtent). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#spatialReference) */ spatialReference: SpatialReference; /** * An [Collection](esri-core-Collection.html) of [Sublayer](esri-layers-support-Sublayer.html) objects used to change the layer ordering and/or rendering, or redefine the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#sublayers) */ sublayers: Sublayer[]; /** * Specify the time extent used by identify. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#timeExtent) */ timeExtent: TimeExtent; /** * The distance in screen pixels from the specified geometry within which the identify should be performed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#tolerance) */ tolerance: number; /** * Width of the current map view in pixels. * * @default 400 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#width) */ width: number; /** * Input parameters for the [identify](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-identify.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html) */ constructor(properties?: IdentifyParametersProperties); static fromJSON(json: any): IdentifyParameters; } interface IdentifyParametersProperties { /** * Resolution of the current map view in dots per inch. * * @default 96 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#dpi) */ dpi?: number; /** * Specify the geodatabase version to search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#gdbVersion) */ gdbVersion?: string; /** * The geometry used to select features during the Identify operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#geometry) */ geometry?: GeometryProperties; /** * Specify the number of decimal places for the geometries returned by the task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#geometryPrecision) */ geometryPrecision?: number; /** * Height of the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) in pixels. * * @default 400 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#height) */ height?: number; /** * The historic moment to identify. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#historicMoment) */ historicMoment?: DateProperties; /** * The layers on which to perform the identify operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#layerIds) */ layerIds?: number[]; /** * Specifies which layers to use when using Identify. * * @default top * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#layerOption) */ layerOption?: "top" | "visible" | "all" | "popup"; /** * The Extent or bounding box of the current map view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#mapExtent) */ mapExtent?: ExtentProperties; /** * The maximum allowable offset used for generalizing geometries returned by the identify operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#maxAllowableOffset) */ maxAllowableOffset?: number; /** * If `true`, field names will be returned instead of field aliases. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#returnFieldName) */ returnFieldName?: boolean; /** * If `true`, the result set includes the geometry associated with each result. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#returnGeometry) */ returnGeometry?: boolean; /** * When `true`, indicates that M values will be returned. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#returnM) */ returnM?: boolean; /** * If `true`, the values in the result will not be formatted i.e. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#returnUnformattedValues) */ returnUnformattedValues?: boolean; /** * When `true`, indicates that z-values will be returned. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#returnZ) */ returnZ?: boolean; /** * The spatial reference of the input and output geometries as well as of the [mapExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#mapExtent). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * An [Collection](esri-core-Collection.html) of [Sublayer](esri-layers-support-Sublayer.html) objects used to change the layer ordering and/or rendering, or redefine the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#sublayers) */ sublayers?: SublayerProperties[]; /** * Specify the time extent used by identify. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#timeExtent) */ timeExtent?: TimeExtentProperties; /** * The distance in screen pixels from the specified geometry within which the identify should be performed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#tolerance) */ tolerance?: number; /** * Width of the current map view in pixels. * * @default 400 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html#width) */ width?: number; } export interface IdentifyResult extends Accessor, JSONSupport { } export class IdentifyResult { /** * The name of the layer's primary display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyResult.html#displayFieldName) */ displayFieldName: string; /** * An identified feature from the map service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyResult.html#feature) */ feature: Graphic; /** * Unique ID of the layer that contains the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyResult.html#layerId) */ layerId: number; /** * The layer name that contains the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyResult.html#layerName) */ layerName: string; /** * The result from [identify](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-identify.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyResult.html) */ constructor(properties?: IdentifyResultProperties); static fromJSON(json: any): IdentifyResult; } interface IdentifyResultProperties { /** * The name of the layer's primary display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyResult.html#displayFieldName) */ displayFieldName?: string; /** * An identified feature from the map service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyResult.html#feature) */ feature?: GraphicProperties; /** * Unique ID of the layer that contains the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyResult.html#layerId) */ layerId?: number; /** * The layer name that contains the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyResult.html#layerName) */ layerName?: string; } export interface ImageAngleParameters extends Accessor, JSONSupport { } export class ImageAngleParameters { /** * Angle names to be computed. * * @default ["north","up"] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAngleParameters.html#angleNames) */ angleNames: string[]; /** * A [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometry that defines the reference point of rotation to compute the angle direction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAngleParameters.html#point) */ point: Point; /** * The rasterId of a raster catalog in the image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAngleParameters.html#rasterId) */ rasterId: number; /** * The spatial reference used to compute the angles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAngleParameters.html#spatialReference) */ spatialReference: SpatialReference; /** * Input parameters for [ImageryLayer.computeAngles()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#computeAngles) or [imageService.computeAngles()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#computeAngles) methods. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAngleParameters.html) */ constructor(properties?: ImageAngleParametersProperties); static fromJSON(json: any): ImageAngleParameters; } interface ImageAngleParametersProperties { /** * Angle names to be computed. * * @default ["north","up"] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAngleParameters.html#angleNames) */ angleNames?: string[]; /** * A [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometry that defines the reference point of rotation to compute the angle direction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAngleParameters.html#point) */ point?: PointProperties; /** * The rasterId of a raster catalog in the image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAngleParameters.html#rasterId) */ rasterId?: number; /** * The spatial reference used to compute the angles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAngleParameters.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; } export interface ImageAngleResult extends Accessor, JSONSupport { } export class ImageAngleResult { /** * The computed north angle after rotating the map so the top of the image is oriented toward north. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAngleResult.html#north) */ north: number; /** * The spatial reference used to compute the angles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAngleResult.html#spatialReference) */ spatialReference: SpatialReference; /** * The computed up angle after rotating the map so the top of the image is always oriented to the direction of the sensor when it acquired the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAngleResult.html#up) */ up: number; /** * The results from [imageService.computeAngles()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#computeAngles) or [ImageryLayer.computeAngles()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#computeAngles) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAngleResult.html) */ constructor(properties?: ImageAngleResultProperties); static fromJSON(json: any): ImageAngleResult; } interface ImageAngleResultProperties { /** * The computed north angle after rotating the map so the top of the image is oriented toward north. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAngleResult.html#north) */ north?: number; /** * The spatial reference used to compute the angles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAngleResult.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * The computed up angle after rotating the map so the top of the image is always oriented to the direction of the sensor when it acquired the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAngleResult.html#up) */ up?: number; } export interface ImageAreaParameters extends Accessor, JSONSupport, BaseImageMeasureParameters { } export class ImageAreaParameters { /** * The area unit used for an area calculation. * * @default "square-meters" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAreaParameters.html#areaUnit) */ areaUnit: | "square-millimeters" | "square-centimeters" | "square-decimeters" | "square-meters" | "square-kilometers" | "square-inches" | "square-feet" | "square-yards" | "square-miles" | "square-us-feet" | "acres" | "ares" | "hectares"; /** * The extent or polygon geometry used to perform the area and perimeter measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAreaParameters.html#geometry) */ geometry: Extent | Polygon; /** * When `true`, this method calculates the 3D measurements for the area and perimeter of a given geometry on an image service. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAreaParameters.html#is3D) */ is3D: boolean; /** * Linear unit used for a perimeter calculation. * * @default "meters" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAreaParameters.html#linearUnit) */ linearUnit: | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"; /** * The string value representing the type of imagery mensuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAreaParameters.html#type) */ readonly type: void; /** * Input parameters used by the [ImageryLayer.measureAreaAndPerimeter()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#measureAreaAndPerimeter) and [imageService.measureAreaAndPerimeter()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#measureAreaAndPerimeter) methods to perform imagery area and perimeter mensuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAreaParameters.html) */ constructor(properties?: ImageAreaParametersProperties); static fromJSON(json: any): ImageAreaParameters; } interface ImageAreaParametersProperties extends BaseImageMeasureParametersProperties { /** * The area unit used for an area calculation. * * @default "square-meters" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAreaParameters.html#areaUnit) */ areaUnit?: | "square-millimeters" | "square-centimeters" | "square-decimeters" | "square-meters" | "square-kilometers" | "square-inches" | "square-feet" | "square-yards" | "square-miles" | "square-us-feet" | "acres" | "ares" | "hectares"; /** * The extent or polygon geometry used to perform the area and perimeter measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAreaParameters.html#geometry) */ geometry?: (ExtentProperties & { type: "extent" }) | (PolygonProperties & { type: "polygon" }); /** * When `true`, this method calculates the 3D measurements for the area and perimeter of a given geometry on an image service. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAreaParameters.html#is3D) */ is3D?: boolean; /** * Linear unit used for a perimeter calculation. * * @default "meters" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAreaParameters.html#linearUnit) */ linearUnit?: | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"; } export interface ImageAreaResult extends Accessor, JSONSupport, BaseImageMeasureResult { } export class ImageAreaResult { /** * An object containing results of the area measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAreaResult.html#area) */ area: MeasurementValue; /** * An object containing results of the perimeter measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAreaResult.html#perimeter) */ perimeter: MeasurementValue; /** * Image service area and perimeter measurement result returned when the [ImageryLayer.measureAreaAndPerimeter()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#measureAreaAndPerimeter) or [imageService.measureAreaAndPerimeter()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#measureAreaAndPerimeter) methods resolve successfully. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAreaResult.html) */ constructor(properties?: ImageAreaResultProperties); static fromJSON(json: any): ImageAreaResult; } interface ImageAreaResultProperties extends BaseImageMeasureResultProperties { /** * An object containing results of the area measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAreaResult.html#area) */ area?: MeasurementValue; /** * An object containing results of the perimeter measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageAreaResult.html#perimeter) */ perimeter?: MeasurementValue; } export interface ImageBoundaryParameters extends Accessor, JSONSupport { } export class ImageBoundaryParameters { /** * The spatial reference for the output boundary geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageBoundaryParameters.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * Image boundary query parameters for [ImageryLayer.queryBoundary()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#queryBoundary) or [imageService.queryBoundary()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#queryBoundary) methods. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageBoundaryParameters.html) */ constructor(properties?: ImageBoundaryParametersProperties); static fromJSON(json: any): ImageBoundaryParameters; } interface ImageBoundaryParametersProperties { /** * The spatial reference for the output boundary geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageBoundaryParameters.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; } export interface ImageBoundaryResult extends Accessor, JSONSupport { } export class ImageBoundaryResult { /** * The area of the boundary geometry in square meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageBoundaryResult.html#area) */ area: number; /** * The geometry that defines the boundary of the image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageBoundaryResult.html#geometry) */ geometry: Polygon | Extent; /** * Image boundary query result for [ImageryLayer.queryBoundary()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#queryBoundary) or [imageService.queryBoundary()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#queryBoundary) methods containing boundary geometry of an image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageBoundaryResult.html) */ constructor(properties?: ImageBoundaryResultProperties); static fromJSON(json: any): ImageBoundaryResult; } interface ImageBoundaryResultProperties { /** * The area of the boundary geometry in square meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageBoundaryResult.html#area) */ area?: number; /** * The geometry that defines the boundary of the image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageBoundaryResult.html#geometry) */ geometry?: (PolygonProperties & { type: "polygon" }) | (ExtentProperties & { type: "extent" }); } export interface ImageDistanceParameters extends Accessor, JSONSupport, BaseImageMeasureParameters { } export class ImageDistanceParameters { /** * The angular unit used for angle calculation. * * @default "degrees" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageDistanceParameters.html#angularUnit) */ angularUnit: "degrees" | "radians"; /** * A point that defines the from location of the distance and angle measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageDistanceParameters.html#fromGeometry) */ fromGeometry: Point; /** * When `true`, this method calculates the 3D measurements for the distance and angle between two points on an image service. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageDistanceParameters.html#is3D) */ is3D: boolean; /** * The linear unit used for distance calculation. * * @default "meters" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageDistanceParameters.html#linearUnit) */ linearUnit: | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"; /** * A point that defines the to location of the distance and angle measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageDistanceParameters.html#toGeometry) */ toGeometry: Point; /** * The string value representing the type of imagery mensuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageDistanceParameters.html#type) */ readonly type: "distance-angle"; /** * Input parameters used by the [ImageryLayer.measureDistanceAndAngle()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#measureDistanceAndAngle) or [imageService.measureDistanceAndAngle()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#measureDistanceAndAngle) methods to perform imagery distance and angle mensuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageDistanceParameters.html) */ constructor(properties?: ImageDistanceParametersProperties); static fromJSON(json: any): ImageDistanceParameters; } interface ImageDistanceParametersProperties extends BaseImageMeasureParametersProperties { /** * The angular unit used for angle calculation. * * @default "degrees" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageDistanceParameters.html#angularUnit) */ angularUnit?: "degrees" | "radians"; /** * A point that defines the from location of the distance and angle measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageDistanceParameters.html#fromGeometry) */ fromGeometry?: PointProperties; /** * When `true`, this method calculates the 3D measurements for the distance and angle between two points on an image service. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageDistanceParameters.html#is3D) */ is3D?: boolean; /** * The linear unit used for distance calculation. * * @default "meters" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageDistanceParameters.html#linearUnit) */ linearUnit?: | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"; /** * A point that defines the to location of the distance and angle measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageDistanceParameters.html#toGeometry) */ toGeometry?: PointProperties; } export interface ImageDistanceResult extends Accessor, JSONSupport, BaseImageMeasureResult { } export class ImageDistanceResult { /** * An object containing the azimuth angle measurement values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageDistanceResult.html#azimuthAngle) */ azimuthAngle: MeasurementValue; /** * An object containing results of the distance measurement between two points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageDistanceResult.html#distance) */ distance: MeasurementValue; /** * An object containing elevation angle measurement values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageDistanceResult.html#elevationAngle) */ elevationAngle: MeasurementValue; /** * Image service distance and angle measurement result returned when the [ImageryLayer.measureDistanceAndAngle()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#measureDistanceAndAngle) or [imageService.measureDistanceAndAngle()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#measureDistanceAndAngle) methods resolve successfully. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageDistanceResult.html) */ constructor(properties?: ImageDistanceResultProperties); static fromJSON(json: any): ImageDistanceResult; } interface ImageDistanceResultProperties extends BaseImageMeasureResultProperties { /** * An object containing the azimuth angle measurement values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageDistanceResult.html#azimuthAngle) */ azimuthAngle?: MeasurementValue; /** * An object containing results of the distance measurement between two points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageDistanceResult.html#distance) */ distance?: MeasurementValue; /** * An object containing elevation angle measurement values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageDistanceResult.html#elevationAngle) */ elevationAngle?: MeasurementValue; } export class ImageGPSInfo extends JSONSupport { /** * Image acquisition date represented using Linux Epoch time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfo.html#acquisitionDate) */ acquisitionDate: Date; /** * Image's camera id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfo.html#cameraID) */ cameraID: string; /** * Image's center. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfo.html#center) */ center: Point; /** * Image's GPS location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfo.html#gps) */ gps: any; /** * Image id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfo.html#id) */ id: number; /** * Image name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfo.html#name) */ name: string; /** * Image's orientation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfo.html#orientation) */ orientation: any; /** * Image GPS information for images returned as a result of the [ImageryLayer.queryGPSInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#queryGPSInfo) or [imageService.queryGPSInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#queryGPSInfo) methods. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfo.html) */ constructor(properties?: ImageGPSInfoProperties); static fromJSON(json: any): ImageGPSInfo; } interface ImageGPSInfoProperties { /** * Image acquisition date represented using Linux Epoch time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfo.html#acquisitionDate) */ acquisitionDate?: DateProperties; /** * Image's camera id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfo.html#cameraID) */ cameraID?: string; /** * Image's center. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfo.html#center) */ center?: PointProperties; /** * Image's GPS location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfo.html#gps) */ gps?: any; /** * Image id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfo.html#id) */ id?: number; /** * Image name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfo.html#name) */ name?: string; /** * Image's orientation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfo.html#orientation) */ orientation?: any; } export class ImageGPSInfoParameters extends JSONSupport { /** * The geometry to query images. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfoParameters.html#geometry) */ geometry: Extent | Multipoint | Point | Polygon | Polyline; /** * An array of ObjectIDs to be used to query images. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfoParameters.html#objectIds) */ objectIds: number[]; /** * For spatial queries, this parameter defines the spatial relationship to query image footprints in the layer against the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfoParameters.html#geometry). * * @default intersects * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfoParameters.html#spatialRelationship) */ spatialRelationship: | "intersects" | "contains" | "crosses" | "disjoint" | "envelope-intersects" | "index-intersects" | "overlaps" | "touches" | "within" | "relation"; /** * A time extent for a temporal query to query images. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfoParameters.html#timeExtent) */ timeExtent: TimeExtent; /** * A where clause for the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfoParameters.html#where) */ where: string; /** * Image GPS info parameters for [ImageryLayer.queryGPSInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#queryGPSInfo) or [imageService.queryGPSInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#queryGPSInfo) methods. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfoParameters.html) */ constructor(properties?: ImageGPSInfoParametersProperties); static fromJSON(json: any): ImageGPSInfoParameters; } interface ImageGPSInfoParametersProperties { /** * The geometry to query images. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfoParameters.html#geometry) */ geometry?: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }); /** * An array of ObjectIDs to be used to query images. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfoParameters.html#objectIds) */ objectIds?: number[]; /** * For spatial queries, this parameter defines the spatial relationship to query image footprints in the layer against the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfoParameters.html#geometry). * * @default intersects * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfoParameters.html#spatialRelationship) */ spatialRelationship?: | "intersects" | "contains" | "crosses" | "disjoint" | "envelope-intersects" | "index-intersects" | "overlaps" | "touches" | "within" | "relation"; /** * A time extent for a temporal query to query images. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfoParameters.html#timeExtent) */ timeExtent?: TimeExtentProperties; /** * A where clause for the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfoParameters.html#where) */ where?: string; } export class ImageGPSInfoResult extends JSONSupport { /** * An array of camera information for the queried images. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfoResult.html#cameras) */ cameras: CameraInfo[]; /** * An array of GPS information for the queried images. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfoResult.html#images) */ images: ImageGPSInfo[]; /** * Result for [ImageryLayer.queryGPSInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#queryGPSInfo) or [imageService.queryGPSInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#queryGPSInfo) methods containing camera and image GPS information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfoResult.html) */ constructor(properties?: ImageGPSInfoResultProperties); static fromJSON(json: any): ImageGPSInfoResult; } interface ImageGPSInfoResultProperties { /** * An array of camera information for the queried images. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfoResult.html#cameras) */ cameras?: CameraInfoProperties[]; /** * An array of GPS information for the queried images. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageGPSInfoResult.html#images) */ images?: ImageGPSInfoProperties[]; } export interface ImageHeightParameters extends Accessor, JSONSupport, BaseImageMeasureParameters { } export class ImageHeightParameters { /** * A point that defines the from location of the height measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHeightParameters.html#fromGeometry) */ fromGeometry: Point; /** * Linear unit used for height calculation. * * @default "meters" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHeightParameters.html#linearUnit) */ linearUnit: | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"; /** * Determines how the height will be measured when the sensor info is available. * * @default "base-and-top" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHeightParameters.html#operationType) */ operationType: "base-and-top" | "base-and-top-shadow" | "top-and-top-shadow"; /** * A point that defines the to location of the height measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHeightParameters.html#toGeometry) */ toGeometry: Point; /** * The string value representing the type of imagery mensuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHeightParameters.html#type) */ readonly type: "height"; /** * Input parameters used by the [ImageryLayer.measureHeight()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#measureHeight) or [imageService.measureHeight()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#measureHeight) methods to perform imagery height mensuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHeightParameters.html) */ constructor(properties?: ImageHeightParametersProperties); static fromJSON(json: any): ImageHeightParameters; } interface ImageHeightParametersProperties extends BaseImageMeasureParametersProperties { /** * A point that defines the from location of the height measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHeightParameters.html#fromGeometry) */ fromGeometry?: PointProperties; /** * Linear unit used for height calculation. * * @default "meters" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHeightParameters.html#linearUnit) */ linearUnit?: | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"; /** * Determines how the height will be measured when the sensor info is available. * * @default "base-and-top" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHeightParameters.html#operationType) */ operationType?: "base-and-top" | "base-and-top-shadow" | "top-and-top-shadow"; /** * A point that defines the to location of the height measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHeightParameters.html#toGeometry) */ toGeometry?: PointProperties; } export interface ImageHeightResult extends Accessor, JSONSupport, BaseImageMeasureResult { } export class ImageHeightResult { /** * An object containing results of the height measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHeightResult.html#height) */ height: MeasurementValue; /** * Image service height mensuration result returned when the [ImageryLayer.measureHeight()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#measureHeight) or [imageService.measureHeight()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#measureHeight) methods resolve successfully. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHeightResult.html) */ constructor(properties?: ImageHeightResultProperties); static fromJSON(json: any): ImageHeightResult; } interface ImageHeightResultProperties extends BaseImageMeasureResultProperties { /** * An object containing results of the height measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHeightResult.html#height) */ height?: MeasurementValue; } export interface ImageHistogramParameters extends Accessor, JSONSupport { } export class ImageHistogramParameters { /** * Input geometry that defines the area of interest for which the histograms and statistics will be computed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html#geometry) */ geometry: Extent | Polygon; /** * Specifies the [mosaic rule](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html) on how individual images should be mosaicked when the histogram is computed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html#mosaicRule) */ mosaicRule: MosaicRule; /** * Specifies the pixel size (or the resolution). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html#pixelSize) */ pixelSize: PixelSize; /** * Specifies the [raster function](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html) from which to compute the statistics and histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html#rasterFunction) */ rasterFunction: RasterFunction; /** * A raster parameter for dynamic raster rendering input. * * @deprecated since version 4.27. Use {@link module:esri/rest/support/ImageHistogramParameters#rasterFunction rasterFunction} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html#renderingRule) */ renderingRule: RasterFunction; /** * The [time extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeExtent.html) for which to compute the statistics and histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html#timeExtent) */ timeExtent: TimeExtent; /** * Input parameters for the [computeHistograms](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#computeHistograms) or [computeStatisticsHistograms](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#computeStatisticsHistograms) method on [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html), or the [computeStatisticsHistograms](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#computeStatisticsHistograms) method on [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html) */ constructor(properties?: ImageHistogramParametersProperties); static fromJSON(json: any): ImageHistogramParameters; } interface ImageHistogramParametersProperties { /** * Input geometry that defines the area of interest for which the histograms and statistics will be computed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html#geometry) */ geometry?: (ExtentProperties & { type: "extent" }) | (PolygonProperties & { type: "polygon" }); /** * Specifies the [mosaic rule](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html) on how individual images should be mosaicked when the histogram is computed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html#mosaicRule) */ mosaicRule?: MosaicRuleProperties; /** * Specifies the pixel size (or the resolution). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html#pixelSize) */ pixelSize?: PixelSize; /** * Specifies the [raster function](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html) from which to compute the statistics and histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html#rasterFunction) */ rasterFunction?: RasterFunctionProperties; /** * A raster parameter for dynamic raster rendering input. * * @deprecated since version 4.27. Use {@link module:esri/rest/support/ImageHistogramParameters#rasterFunction rasterFunction} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html#renderingRule) */ renderingRule?: RasterFunctionProperties; /** * The [time extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeExtent.html) for which to compute the statistics and histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html#timeExtent) */ timeExtent?: TimeExtentProperties; } export interface ImageIdentifyParameters extends Accessor, JSONSupport { } export class ImageIdentifyParameters { /** * Input geometry that defines the location to be identified. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#geometry) */ geometry: Point | Polygon | Extent; /** * Controls the maximum number of returned catalog items, set to 1 to return the top most raster only. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#maxItemCount) */ maxItemCount: number; /** * Specifies the mosaic rules defining the image sorting order. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#mosaicRule) */ mosaicRule: MosaicRule; /** * Specifies the pixel level being identified on the x and y axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#pixelSize) */ pixelSize: PixelSize; /** * When `true`, the request is processed for all variables and dimensions. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#processAsMultidimensional) */ processAsMultidimensional: boolean; /** * Specifies the raster function for how the requested image should be processed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#rasterFunction) */ rasterFunction: RasterFunction; /** * An array the [raster functions](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#rasterFunction) to retrieve multiple processed pixel values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#rasterFunctions) */ rasterFunctions: RasterFunction; /** * Specifies the rendering rule for how the requested image should be rendered. * * @deprecated since version 4.27. Use {@link module:esri/rest/support/ImageIdentifyParameters#rasterFunctions rasterFunctions} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#renderingRule) */ renderingRule: void; /** * An array the [rendering rules](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#renderingRule) to retrieve multiple processed pixel values. * * @deprecated since version 4.27. Use {@link module:esri/rest/support/ImageIdentifyParameters#rasterFunctions rasterFunctions} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#renderingRules) */ renderingRules: RasterFunction; /** * If `true`, returns both geometry and attributes of the catalog items. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#returnCatalogItems) */ returnCatalogItems: boolean; /** * When `true`, each feature in the catalog items includes the geometry. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#returnGeometry) */ returnGeometry: boolean; /** * If `true`, the pixel values of all raster catalog items under the requested geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#returnPixelValues) */ returnPixelValues: boolean; /** * A time extent for a temporal data against [time-aware imagery layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#timeInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#timeExtent) */ timeExtent: TimeExtent; /** * Input parameters for [imageService](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html) */ constructor(properties?: ImageIdentifyParametersProperties); static fromJSON(json: any): ImageIdentifyParameters; } interface ImageIdentifyParametersProperties { /** * Input geometry that defines the location to be identified. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#geometry) */ geometry?: | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (ExtentProperties & { type: "extent" }); /** * Controls the maximum number of returned catalog items, set to 1 to return the top most raster only. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#maxItemCount) */ maxItemCount?: number; /** * Specifies the mosaic rules defining the image sorting order. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#mosaicRule) */ mosaicRule?: MosaicRuleProperties; /** * Specifies the pixel level being identified on the x and y axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#pixelSize) */ pixelSize?: PixelSize; /** * When `true`, the request is processed for all variables and dimensions. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#processAsMultidimensional) */ processAsMultidimensional?: boolean; /** * Specifies the raster function for how the requested image should be processed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#rasterFunction) */ rasterFunction?: RasterFunctionProperties; /** * An array the [raster functions](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#rasterFunction) to retrieve multiple processed pixel values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#rasterFunctions) */ rasterFunctions?: RasterFunctionProperties; /** * Specifies the rendering rule for how the requested image should be rendered. * * @deprecated since version 4.27. Use {@link module:esri/rest/support/ImageIdentifyParameters#rasterFunctions rasterFunctions} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#renderingRule) */ renderingRule?: void; /** * An array the [rendering rules](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#renderingRule) to retrieve multiple processed pixel values. * * @deprecated since version 4.27. Use {@link module:esri/rest/support/ImageIdentifyParameters#rasterFunctions rasterFunctions} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#renderingRules) */ renderingRules?: RasterFunctionProperties; /** * If `true`, returns both geometry and attributes of the catalog items. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#returnCatalogItems) */ returnCatalogItems?: boolean; /** * When `true`, each feature in the catalog items includes the geometry. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#returnGeometry) */ returnGeometry?: boolean; /** * If `true`, the pixel values of all raster catalog items under the requested geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#returnPixelValues) */ returnPixelValues?: boolean; /** * A time extent for a temporal data against [time-aware imagery layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#timeInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#timeExtent) */ timeExtent?: TimeExtentProperties; } /** * Specifies the pixel size (or the resolution). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#PixelSize) */ export interface PixelSize { /** * Represents the size of one pixel in map units along the x axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#PixelSize) */ x: number; /** * Represents the size of one pixel in map units along the y axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#PixelSize) */ y: number; /** * Spatial reference to be used for the request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#PixelSize) */ spatialReference?: PixelSizeSpatialReference; } export interface PixelSizeSpatialReference { /** * The wkid of the spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#PixelSize) */ wkid?: number; /** * The Well known text or wkt of the spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyParameters.html#PixelSize) */ wkt?: number; } export interface ImageIdentifyResult extends Accessor, JSONSupport { } export class ImageIdentifyResult { /** * The set of catalog items that overlap the input geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyResult.html#catalogItems) */ catalogItems: FeatureSet; /** * The set of visible areas for the identified catalog items. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyResult.html#catalogItemVisibilities) */ catalogItemVisibilities: number[]; /** * The identified location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyResult.html#location) */ location: Point; /** * The identify property name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyResult.html#name) */ name: string; /** * The identify property id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyResult.html#objectId) */ objectId: number; /** * The attributes of the identified object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyResult.html#properties) */ properties: any; /** * The identify image service pixel value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyResult.html#value) */ value: string; /** * The results from [imageService](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyResult.html) */ constructor(properties?: ImageIdentifyResultProperties); static fromJSON(json: any): ImageIdentifyResult; } interface ImageIdentifyResultProperties { /** * The set of catalog items that overlap the input geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyResult.html#catalogItems) */ catalogItems?: FeatureSetProperties; /** * The set of visible areas for the identified catalog items. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyResult.html#catalogItemVisibilities) */ catalogItemVisibilities?: number[]; /** * The identified location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyResult.html#location) */ location?: PointProperties; /** * The identify property name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyResult.html#name) */ name?: string; /** * The identify property id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyResult.html#objectId) */ objectId?: number; /** * The attributes of the identified object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyResult.html#properties) */ properties?: any; /** * The identify image service pixel value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageIdentifyResult.html#value) */ value?: string; } export class ImageInspectionInfo extends JSONSupport { /** * Image acquisition date represented in Linux Epoch time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageInspectionInfo.html#acquisitionDate) */ acquisitionDate: Date; /** * Image's camera id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageInspectionInfo.html#cameraID) */ cameraID: string; /** * Image's center. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageInspectionInfo.html#center) */ center: Point; /** * Image id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageInspectionInfo.html#id) */ id: number; /** * Image's orientation along x, y, z axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageInspectionInfo.html#orientation) */ orientation: ImageInspectionInfoOrientation; /** * Perspective center. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageInspectionInfo.html#perspectiveCenter) */ perspectiveCenter: Point; /** * The relative reference to the image's uri. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageInspectionInfo.html#referenceUri) */ referenceUri: string; /** * Image information for images returned as a result of running [ImageryLayer.findImages()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#findImages) or [imageService.findImages()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#findImages) methods. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageInspectionInfo.html) */ constructor(properties?: ImageInspectionInfoProperties); static fromJSON(json: any): ImageInspectionInfo; } interface ImageInspectionInfoProperties { /** * Image acquisition date represented in Linux Epoch time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageInspectionInfo.html#acquisitionDate) */ acquisitionDate?: DateProperties; /** * Image's camera id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageInspectionInfo.html#cameraID) */ cameraID?: string; /** * Image's center. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageInspectionInfo.html#center) */ center?: PointProperties; /** * Image id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageInspectionInfo.html#id) */ id?: number; /** * Image's orientation along x, y, z axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageInspectionInfo.html#orientation) */ orientation?: ImageInspectionInfoOrientation; /** * Perspective center. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageInspectionInfo.html#perspectiveCenter) */ perspectiveCenter?: PointProperties; /** * The relative reference to the image's uri. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageInspectionInfo.html#referenceUri) */ referenceUri?: string; } export interface ImageInspectionInfoOrientation { /** * Image rotation along the x axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageInspectionInfo.html#orientation) */ omega: number; /** * Image rotation along the y axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageInspectionInfo.html#orientation) */ phi: number; /** * Image rotation along the z axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageInspectionInfo.html#orientation) */ kappa: number; /** * Indicates if the rotation is clockwise. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageInspectionInfo.html#orientation) */ clockwise: boolean; } export class ImageParameters extends Accessor { /** * Dots per inch setting for [JobInfo.fetchResultMapImageLayer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#fetchResultMapImageLayer). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html#dpi) */ dpi: number; /** * Extent of map to be exported. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html#extent) */ extent: Extent; /** * Map image format. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html#format) */ format: "png" | "png8" | "png24" | "png32" | "jpg" | "pdf" | "bmp" | "gif" | "svg"; /** * Requested image height in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html#height) */ height: number; /** * Spatial reference of exported image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html#imageSpatialReference) */ imageSpatialReference: SpatialReference; /** * Array of layer definition expressions that allows you to filter the features of individual layers in the exported map image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html#layerDefinitions) */ layerDefinitions: string[]; /** * A list of layer IDs, that represent which layers to include in the exported map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html#layerIds) */ layerIds: number[]; /** * This property determines how the layers specified by [layerIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html#layerIds) are treated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html#layerOption) */ layerOption: "show" | "hide" | "include" | "exclude"; /** * Indicates whether or not the background of the dynamic image is transparent. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html#transparent) */ transparent: boolean; /** * Requested image width in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html#width) */ width: number; /** * Represents the image parameter options used when calling [JobInfo.fetchResultImage()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#fetchResultImage) and [JobInfo.fetchResultMapImageLayer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#fetchResultMapImageLayer). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html) */ constructor(properties?: ImageParametersProperties); /** * Converts an instance of this class to its ArcGIS portal JSON representation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html#toJSON) */ toJSON(): any; } interface ImageParametersProperties { /** * Dots per inch setting for [JobInfo.fetchResultMapImageLayer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#fetchResultMapImageLayer). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html#dpi) */ dpi?: number; /** * Extent of map to be exported. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html#extent) */ extent?: ExtentProperties; /** * Map image format. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html#format) */ format?: "png" | "png8" | "png24" | "png32" | "jpg" | "pdf" | "bmp" | "gif" | "svg"; /** * Requested image height in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html#height) */ height?: number; /** * Spatial reference of exported image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html#imageSpatialReference) */ imageSpatialReference?: SpatialReferenceProperties; /** * Array of layer definition expressions that allows you to filter the features of individual layers in the exported map image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html#layerDefinitions) */ layerDefinitions?: string[]; /** * A list of layer IDs, that represent which layers to include in the exported map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html#layerIds) */ layerIds?: number[]; /** * This property determines how the layers specified by [layerIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html#layerIds) are treated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html#layerOption) */ layerOption?: "show" | "hide" | "include" | "exclude"; /** * Indicates whether or not the background of the dynamic image is transparent. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html#transparent) */ transparent?: boolean; /** * Requested image width in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageParameters.html#width) */ width?: number; } export interface ImagePixelLocationParameters extends Accessor, JSONSupport { } export class ImagePixelLocationParameters { /** * An array of [points](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) that defines pixel locations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImagePixelLocationParameters.html#point) */ point: Point[]; /** * The rasterId of a raster catalog in the image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImagePixelLocationParameters.html#rasterId) */ rasterId: number; /** * Input parameters for the [ImageryLayer.computePixelSpaceLocations()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#computePixelSpaceLocations) or [imageService.computePixelSpaceLocations()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#computePixelSpaceLocations) methods. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImagePixelLocationParameters.html) */ constructor(properties?: ImagePixelLocationParametersProperties); static fromJSON(json: any): ImagePixelLocationParameters; } interface ImagePixelLocationParametersProperties { /** * An array of [points](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) that defines pixel locations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImagePixelLocationParameters.html#point) */ point?: PointProperties[]; /** * The rasterId of a raster catalog in the image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImagePixelLocationParameters.html#rasterId) */ rasterId?: number; } export interface ImagePixelLocationResult extends Accessor, JSONSupport { } export class ImagePixelLocationResult { /** * An array of objects containing pixel space x,y coordinates and the pixel's z values of the pixel location geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImagePixelLocationResult.html#geometries) */ geometries: any[]; /** * The results from [imageService.computePixelSpaceLocations()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#computePixelSpaceLocations) or [ImageryLayer.computePixelSpaceLocations()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#computePixelSpaceLocations) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImagePixelLocationResult.html) */ constructor(properties?: ImagePixelLocationResultProperties); static fromJSON(json: any): ImagePixelLocationResult; } interface ImagePixelLocationResultProperties { /** * An array of objects containing pixel space x,y coordinates and the pixel's z values of the pixel location geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImagePixelLocationResult.html#geometries) */ geometries?: any[]; } export interface ImagePointParameters extends Accessor, JSONSupport, BaseImageMeasureParameters { } export class ImagePointParameters { /** * Input geometry to determine a a point location or a centroid of a given area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImagePointParameters.html#geometry) */ geometry: Point | Extent | Polygon; /** * When `true`, this method calculates the z-value for the returned point geometry. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImagePointParameters.html#is3D) */ is3D: boolean; /** * The string value representing the type of imagery mensuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImagePointParameters.html#type) */ readonly type: "point"; /** * Input parameters used by the [ImageryLayer.measurePointOrCentroid()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#measurePointOrCentroid) or [imageService.measurePointOrCentroid()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#measurePointOrCentroid) methods to perform imagery point or centroid mensuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImagePointParameters.html) */ constructor(properties?: ImagePointParametersProperties); static fromJSON(json: any): ImagePointParameters; } interface ImagePointParametersProperties extends BaseImageMeasureParametersProperties { /** * Input geometry to determine a a point location or a centroid of a given area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImagePointParameters.html#geometry) */ geometry?: | (PointProperties & { type: "point" }) | (ExtentProperties & { type: "extent" }) | (PolygonProperties & { type: "polygon" }); /** * When `true`, this method calculates the z-value for the returned point geometry. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImagePointParameters.html#is3D) */ is3D?: boolean; } export interface ImagePointResult extends Accessor, JSONSupport, BaseImageMeasureResult { } export class ImagePointResult { /** * The measured point on an image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImagePointResult.html#point) */ point: Point; /** * Image service point or centroid measurement result returned when the [ImageryLayer.measurePointOrCentroid()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#measurePointOrCentroid) or [imageService.measurePointOrCentroid()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#measurePointOrCentroid) methods resolve successfully. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImagePointResult.html) */ constructor(properties?: ImagePointResultProperties); static fromJSON(json: any): ImagePointResult; } interface ImagePointResultProperties extends BaseImageMeasureResultProperties { /** * The measured point on an image service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImagePointResult.html#point) */ point?: PointProperties; } export interface ImageSample extends Accessor, JSONSupport { } export class ImageSample { /** * Name-value pairs of fields and field values associated with the [sample location](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSample.html#location). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSample.html#attributes) */ attributes: any; /** * The sample location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSample.html#location) */ location: Point; /** * The location id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSample.html#locationId) */ locationId: number; /** * The pixel value associated with the sampled location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSample.html#pixelValue) */ pixelValue: number[]; /** * The raster id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSample.html#rasterId) */ rasterId: number; /** * The resolution representing the average of source raster's resolutions in x and y axes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSample.html#resolution) */ resolution: number; /** * The [getSamples](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#getSamples) method on [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html) returns [ImageSampleResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleResult.html) containing array of this class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSample.html) */ constructor(properties?: ImageSampleProperties); static fromJSON(json: any): ImageSample; } interface ImageSampleProperties { /** * Name-value pairs of fields and field values associated with the [sample location](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSample.html#location). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSample.html#attributes) */ attributes?: any; /** * The sample location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSample.html#location) */ location?: PointProperties; /** * The location id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSample.html#locationId) */ locationId?: number; /** * The pixel value associated with the sampled location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSample.html#pixelValue) */ pixelValue?: number[]; /** * The raster id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSample.html#rasterId) */ rasterId?: number; /** * The resolution representing the average of source raster's resolutions in x and y axes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSample.html#resolution) */ resolution?: number; } export interface ImageSampleParameters extends Accessor, JSONSupport { } export class ImageSampleParameters { /** * Input geometry that defines the locations to be sampled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#geometry) */ geometry: Point | Multipoint | Polyline | Extent | Polygon; /** * Defines how to interpolate pixel values. * * @default nearest * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#interpolation) */ interpolation: "nearest" | "bilinear" | "cubic" | "majority"; /** * When sampling multiple locations, you can use an array of [points](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instead of providing a [multipoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html) for the [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#geometry) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#locations) */ locations: Point[]; /** * Specifies the [mosaic rule](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html) defining the image sort order and selection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#mosaicRule) */ mosaicRule: MosaicRule; /** * The list of fields associated with the rasters to be included in the response. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#outFields) */ outFields: string[]; /** * Specifies the pixel size (or the resolution) that will be used for the sampling. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#pixelSize) */ pixelSize: PixelSize; /** * When `true`, returns the first valid pixel value that meets specified conditions at each sampling point location. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#returnFirstValueOnly) */ returnFirstValueOnly: boolean; /** * Specifies the approximate number of locations to sample from the provided geometry when the input geometry is [polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html), [polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) or [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#sampleCount) */ sampleCount: number; /** * Specifies the distance interval to sample points from the provided [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#geometry) when input geometry is [polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#sampleDistance) */ sampleDistance: number; /** * Specifies the slice id of a multidimensional raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#sliceId) */ sliceId: number; /** * The [time extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeExtent.html) for which to perform sampling. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#timeExtent) */ timeExtent: TimeExtent; /** * Input parameters for the [getSamples()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#getSamples) method on [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html) */ constructor(properties?: ImageSampleParametersProperties); static fromJSON(json: any): ImageSampleParameters; } interface ImageSampleParametersProperties { /** * Input geometry that defines the locations to be sampled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#geometry) */ geometry?: | (PointProperties & { type: "point" }) | (MultipointProperties & { type: "multipoint" }) | (PolylineProperties & { type: "polyline" }) | (ExtentProperties & { type: "extent" }) | (PolygonProperties & { type: "polygon" }); /** * Defines how to interpolate pixel values. * * @default nearest * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#interpolation) */ interpolation?: "nearest" | "bilinear" | "cubic" | "majority"; /** * When sampling multiple locations, you can use an array of [points](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instead of providing a [multipoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html) for the [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#geometry) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#locations) */ locations?: PointProperties[]; /** * Specifies the [mosaic rule](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html) defining the image sort order and selection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#mosaicRule) */ mosaicRule?: MosaicRuleProperties; /** * The list of fields associated with the rasters to be included in the response. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#outFields) */ outFields?: string[]; /** * Specifies the pixel size (or the resolution) that will be used for the sampling. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#pixelSize) */ pixelSize?: PixelSize; /** * When `true`, returns the first valid pixel value that meets specified conditions at each sampling point location. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#returnFirstValueOnly) */ returnFirstValueOnly?: boolean; /** * Specifies the approximate number of locations to sample from the provided geometry when the input geometry is [polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html), [polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) or [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#sampleCount) */ sampleCount?: number; /** * Specifies the distance interval to sample points from the provided [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#geometry) when input geometry is [polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#sampleDistance) */ sampleDistance?: number; /** * Specifies the slice id of a multidimensional raster. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#sliceId) */ sliceId?: number; /** * The [time extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeExtent.html) for which to perform sampling. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleParameters.html#timeExtent) */ timeExtent?: TimeExtentProperties; } export interface ImageSampleResult extends Accessor, JSONSupport { } export class ImageSampleResult { /** * An array of image sample results returned in response to [ImageryLayer.getSamples()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#getSamples) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleResult.html#samples) */ samples: ImageSample[]; /** * The result from the [getSamples](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#getSamples) method on [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html) containing array of [ImageSample](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSample.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleResult.html) */ constructor(properties?: ImageSampleResultProperties); static fromJSON(json: any): ImageSampleResult; } interface ImageSampleResultProperties { /** * An array of image sample results returned in response to [ImageryLayer.getSamples()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#getSamples) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageSampleResult.html#samples) */ samples?: ImageSampleProperties[]; } export class ImageToMapMultirayParameters extends JSONSupport { /** * An array of geometries in image space coordinates representing the same map location on different images. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapMultirayParameters.html#geometries) */ geometries: Geometry[]; /** * The spatial reference for the output geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapMultirayParameters.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * The rasterIds of the raster items that correspond to the input [geometries](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapMultirayParameters.html#geometries). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapMultirayParameters.html#rasterIds) */ rasterIds: number[]; /** * Input parameters for the [ImageryLayer.imageToMapMultiray()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#imageToMapMultiray) or [imageService.imageToMapMultiray()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#imageToMapMultiray) methods. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapMultirayParameters.html) */ constructor(properties?: ImageToMapMultirayParametersProperties); static fromJSON(json: any): ImageToMapMultirayParameters; } interface ImageToMapMultirayParametersProperties { /** * An array of geometries in image space coordinates representing the same map location on different images. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapMultirayParameters.html#geometries) */ geometries?: GeometryProperties[]; /** * The spatial reference for the output geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapMultirayParameters.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; /** * The rasterIds of the raster items that correspond to the input [geometries](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapMultirayParameters.html#geometries). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapMultirayParameters.html#rasterIds) */ rasterIds?: number[]; } export class ImageToMapParameters extends JSONSupport { /** * When `true`, it will adjust the background vertices to be in the foreground. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapParameters.html#adjust) */ adjust: boolean; /** * The depth offset. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapParameters.html#depthOffset) */ depthOffset: number; /** * The geometry in an image space. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapParameters.html#geometry) */ geometry: Multipoint | Point | Polygon | Polyline; /** * The spatial reference for the output geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapParameters.html#inSpatialReference) */ inSpatialReference: SpatialReference; /** * The corresponding raster id for the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapParameters.html#geometry). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapParameters.html#rasterId) */ rasterId: number; /** * Input parameters for the [ImageryLayer.imageToMap()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#imageToMap) or [imageService.imageToMap()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#imageToMap) methods. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapParameters.html) */ constructor(properties?: ImageToMapParametersProperties); static fromJSON(json: any): ImageToMapParameters; } interface ImageToMapParametersProperties { /** * When `true`, it will adjust the background vertices to be in the foreground. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapParameters.html#adjust) */ adjust?: boolean; /** * The depth offset. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapParameters.html#depthOffset) */ depthOffset?: number; /** * The geometry in an image space. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapParameters.html#geometry) */ geometry?: | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }); /** * The spatial reference for the output geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapParameters.html#inSpatialReference) */ inSpatialReference?: SpatialReferenceProperties; /** * The corresponding raster id for the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapParameters.html#geometry). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageToMapParameters.html#rasterId) */ rasterId?: number; } export interface JobInfo extends Accessor, JSONSupport { } export class JobInfo { /** * The unique job ID assigned by ArcGIS Server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#jobId) */ jobId: string; /** * The job status. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#jobStatus) */ jobStatus: | "job-cancelled" | "job-cancelling" | "job-deleted" | "job-deleting" | "job-timed-out" | "job-executing" | "job-failed" | "job-new" | "job-submitted" | "job-succeeded" | "job-waiting"; /** * An array of messages that include the message type and a description. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#messages) */ messages: GPMessage[]; /** * Displays the progress of the geoprocessing job. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#progress) */ readonly progress: JobInfoProgress; /** * The [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for data requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#requestOptions) */ requestOptions: any; /** * ArcGIS Server Rest API endpoint to the resource that receives the geoprocessing request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#sourceUrl) */ sourceUrl: string; /** * Represents information pertaining to the execution of an asynchronous [geoprocessor](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geoprocessor.html) request on the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html) */ constructor(properties?: JobInfoProperties); /** * Cancels an asynchronous geoprocessing job. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#cancelJob) */ cancelJob(jobId: string, requestOptions?: any): Promise; /** * Sends a request for the current state of this job. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#checkJobStatus) */ checkJobStatus(requestOptions?: any): Promise; /** * Stop monitoring this job for status updates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#destroy) */ destroy(): void; /** * Sends a request to the GP Task to get the task result identified by `resultName`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#fetchResultData) */ fetchResultData(resultName: string, gpOptions?: GPOptions, requestOptions?: any): Promise; /** * Sends a request to the GP Task to get the task result identified by `jobId` and `resultName` as an image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#fetchResultImage) */ fetchResultImage(jobId: string, resultName: string, imageParams: ImageParameters, requestOptions?: any): Promise; /** * Get the task result identified by `jobId` as an [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#fetchResultMapImageLayer) */ fetchResultMapImageLayer(jobId: string): Promise; /** * Resolves when an asynchronous job has completed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#waitForJobCompletion) */ waitForJobCompletion(options?: JobInfoWaitForJobCompletionOptions): Promise; static fromJSON(json: any): JobInfo; } interface JobInfoProperties { /** * The unique job ID assigned by ArcGIS Server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#jobId) */ jobId?: string; /** * The job status. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#jobStatus) */ jobStatus?: | "job-cancelled" | "job-cancelling" | "job-deleted" | "job-deleting" | "job-timed-out" | "job-executing" | "job-failed" | "job-new" | "job-submitted" | "job-succeeded" | "job-waiting"; /** * An array of messages that include the message type and a description. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#messages) */ messages?: GPMessageProperties[]; /** * The [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for data requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#requestOptions) */ requestOptions?: any; /** * ArcGIS Server Rest API endpoint to the resource that receives the geoprocessing request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#sourceUrl) */ sourceUrl?: string; } export interface JobInfoProgress { /** * Progress message. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#progress) */ message: string; /** * Progress percentage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#progress) */ percent: number; } export interface JobInfoWaitForJobCompletionOptions { /** * The time in millisecond between remote job status requests. * * @default 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#waitForJobCompletion) */ interval?: any; /** * [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) allows for cancelable asynchronous job. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#waitForJobCompletion) */ signal?: any; /** * Callback function that is called at the specified interval. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#waitForJobCompletion) */ statusCallback?: any; } export class LegendLayer extends Accessor { /** * The id of the operational layer to include in the printout's legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LegendLayer.html#layerId) */ layerId: string; /** * The ids of the sublayers to include in the printout's legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LegendLayer.html#subLayerIds) */ subLayerIds: string[]; /** * The title of the feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LegendLayer.html#title) */ title: string; /** * Define layer properties for the legend layers associated with a [PrintTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LegendLayer.html) */ constructor(properties?: LegendLayerProperties); } interface LegendLayerProperties { /** * The id of the operational layer to include in the printout's legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LegendLayer.html#layerId) */ layerId?: string; /** * The ids of the sublayers to include in the printout's legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LegendLayer.html#subLayerIds) */ subLayerIds?: string[]; /** * The title of the feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LegendLayer.html#title) */ title?: string; } export interface LengthsParameters extends Accessor, JSONSupport { } export class LengthsParameters { /** * Defines the type of calculation for the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LengthsParameters.html#calculationType) */ calculationType: "planar" | "geodesic" | "preserve-shape"; /** * If polylines are in a geographic coordinate system, then geodesic needs to be set to `true` in order to calculate the ellipsoidal shortest path distance between each pair of the vertices in the polylines. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LengthsParameters.html#geodesic) */ geodesic: boolean; /** * The length unit in which perimeters of polygons will be calculated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LengthsParameters.html#lengthUnit) */ lengthUnit: number | string; /** * The array of polylines whose lengths are to be computed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LengthsParameters.html#polylines) */ polylines: Polyline[]; /** * Sets the length units and other parameters for the [geometryService.lengths()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#lengths) operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LengthsParameters.html) */ constructor(properties?: LengthsParametersProperties); static fromJSON(json: any): LengthsParameters; } interface LengthsParametersProperties { /** * Defines the type of calculation for the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LengthsParameters.html#calculationType) */ calculationType?: "planar" | "geodesic" | "preserve-shape"; /** * If polylines are in a geographic coordinate system, then geodesic needs to be set to `true` in order to calculate the ellipsoidal shortest path distance between each pair of the vertices in the polylines. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LengthsParameters.html#geodesic) */ geodesic?: boolean; /** * The length unit in which perimeters of polygons will be calculated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LengthsParameters.html#lengthUnit) */ lengthUnit?: number | string; /** * The array of polylines whose lengths are to be computed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LengthsParameters.html#polylines) */ polylines?: PolylineProperties[]; } export interface LinearUnit extends Accessor, JSONSupport { } export class LinearUnit { /** * Specifies the value of the linear distance. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LinearUnit.html#distance) */ distance: number; /** * Specifies the unit type of the linear distance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LinearUnit.html#units) */ units: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards"; /** * A data object containing a linear distance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LinearUnit.html) */ constructor(properties?: LinearUnitProperties); static fromJSON(json: any): LinearUnit; } interface LinearUnitProperties { /** * Specifies the value of the linear distance. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LinearUnit.html#distance) */ distance?: number; /** * Specifies the unit type of the linear distance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LinearUnit.html#units) */ units?: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards"; } export class MapToImageParameters extends JSONSupport { /** * The geometry in a map space (coordinates). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MapToImageParameters.html#geometry) */ geometry: Extent | Multipoint | Point | Polygon | Polyline; /** * The raster id of the raster item corresponding to the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MapToImageParameters.html#geometry). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MapToImageParameters.html#rasterId) */ rasterId: number; /** * When `true`, the operation will return an empty geometry if the input geometry is not visible. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MapToImageParameters.html#visibleOnly) */ visibleOnly: boolean; /** * Input parameters for the [ImageryLayer.mapToImage()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#mapToImage) or [imageService.mapToImage()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#mapToImage) methods. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MapToImageParameters.html) */ constructor(properties?: MapToImageParametersProperties); static fromJSON(json: any): MapToImageParameters; } interface MapToImageParametersProperties { /** * The geometry in a map space (coordinates). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MapToImageParameters.html#geometry) */ geometry?: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }); /** * The raster id of the raster item corresponding to the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MapToImageParameters.html#geometry). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MapToImageParameters.html#rasterId) */ rasterId?: number; /** * When `true`, the operation will return an empty geometry if the input geometry is not visible. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MapToImageParameters.html#visibleOnly) */ visibleOnly?: boolean; } export interface MeasureAreaFromImageResult extends Accessor, JSONSupport { } export class MeasureAreaFromImageResult { /** * The area of a polygon in square meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MeasureAreaFromImageResult.html#area) */ area: number; /** * The polygon's center in a map space. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MeasureAreaFromImageResult.html#center) */ center: Point; /** * The polygon geometry in a map space. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MeasureAreaFromImageResult.html#geometry) */ geometry: Polygon; /** * The perimeter of a polygon in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MeasureAreaFromImageResult.html#length) */ length: number; /** * The area and length result from a selected image's measurement in an image space when the [ImageryLayer.measureAreaFromImage()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#measureAreaFromImage) or [imageService.measureAreaFromImage()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#measureAreaFromImage) methods resolve successfully. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MeasureAreaFromImageResult.html) */ constructor(properties?: MeasureAreaFromImageResultProperties); static fromJSON(json: any): MeasureAreaFromImageResult; } interface MeasureAreaFromImageResultProperties { /** * The area of a polygon in square meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MeasureAreaFromImageResult.html#area) */ area?: number; /** * The polygon's center in a map space. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MeasureAreaFromImageResult.html#center) */ center?: PointProperties; /** * The polygon geometry in a map space. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MeasureAreaFromImageResult.html#geometry) */ geometry?: PolygonProperties; /** * The perimeter of a polygon in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MeasureAreaFromImageResult.html#length) */ length?: number; } export interface MeasureFromImageParameters extends Accessor, JSONSupport { } export class MeasureFromImageParameters { /** * The polyline or polygon geometry used to perform length or area measurements in an image space. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MeasureFromImageParameters.html#geometry) */ geometry: Polyline | Polygon; /** * The id of the raster to be measured. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MeasureFromImageParameters.html#rasterId) */ rasterId: number; /** * Input parameters used by the [ImageryLayer.measureLengthFromImage()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#measureLengthFromImage), [ImageryLayer.measureAreaFromImage()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#measureAreaFromImage), [imageService.measureLengthFromImage()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#measureLengthFromImage) and [imageService.measureAreaFromImage()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#measureAreaFromImage) methods to perform imagery area, perimeter and length mensuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MeasureFromImageParameters.html) */ constructor(properties?: MeasureFromImageParametersProperties); static fromJSON(json: any): MeasureFromImageParameters; } interface MeasureFromImageParametersProperties { /** * The polyline or polygon geometry used to perform length or area measurements in an image space. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MeasureFromImageParameters.html#geometry) */ geometry?: (PolylineProperties & { type: "polyline" }) | (PolygonProperties & { type: "polygon" }); /** * The id of the raster to be measured. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MeasureFromImageParameters.html#rasterId) */ rasterId?: number; } export interface MeasureLengthFromImageResult extends Accessor, JSONSupport { } export class MeasureLengthFromImageResult { /** * Polyline geometry in a map space. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MeasureLengthFromImageResult.html#geometry) */ geometry: Polyline; /** * The length of a polyline in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MeasureLengthFromImageResult.html#length) */ length: number; /** * The length result from a selected image's measurement in an image space when the [ImageryLayer.measureLengthFromImage()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#measureLengthFromImage) or [imageService.measureLengthFromImage()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-imageService.html#measureLengthFromImage) methods resolve successfully. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MeasureLengthFromImageResult.html) */ constructor(properties?: MeasureLengthFromImageResultProperties); static fromJSON(json: any): MeasureLengthFromImageResult; } interface MeasureLengthFromImageResultProperties { /** * Polyline geometry in a map space. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MeasureLengthFromImageResult.html#geometry) */ geometry?: PolylineProperties; /** * The length of a polyline in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MeasureLengthFromImageResult.html#length) */ length?: number; } export class MultipartColorRamp extends ColorRamp { /** * Define an array of algorithmic color ramps used to generate the multi part ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MultipartColorRamp.html#colorRamps) */ colorRamps: AlgorithmicColorRamp[]; /** * A string value representing the color ramp type. * * @default multipart * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MultipartColorRamp.html#type) */ readonly type: "multipart"; /** * Creates a multipart color ramp to combine multiple continuous color ramps for use in raster renderers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MultipartColorRamp.html) */ constructor(properties?: MultipartColorRampProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MultipartColorRamp.html#clone) */ clone(): MultipartColorRamp; static fromJSON(json: any): MultipartColorRamp; } interface MultipartColorRampProperties extends ColorRampProperties { /** * Define an array of algorithmic color ramps used to generate the multi part ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-MultipartColorRamp.html#colorRamps) */ colorRamps?: AlgorithmicColorRampProperties[]; } export interface NAMessage extends Accessor, JSONSupport { } export class NAMessage { /** * A description of the network analyst message. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-NAMessage.html#description) */ description: string; /** * The network analyst message type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-NAMessage.html#type) */ type: | "informative" | "process-definition" | "process-start" | "process-stop" | "warning" | "error" | "empty" | "abort"; /** * Represents a message generated during the execution of a network analyst task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-NAMessage.html) */ constructor(properties?: NAMessageProperties); static fromJSON(json: any): NAMessage; } interface NAMessageProperties { /** * A description of the network analyst message. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-NAMessage.html#description) */ description?: string; /** * The network analyst message type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-NAMessage.html#type) */ type?: | "informative" | "process-definition" | "process-start" | "process-stop" | "warning" | "error" | "empty" | "abort"; } export interface NetworkFeatureSet extends FeatureSet, Accessor { } export class NetworkFeatureSet { /** * If true, restricted network elements should be considered when finding network locations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-NetworkFeatureSet.html#doNotLocateOnRestrictedElements) */ doNotLocateOnRestrictedElements: boolean; /** * A subclass of FeaureSet that can be used as an input in the Route, Closest Facility, and Service Area solvers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-NetworkFeatureSet.html) */ constructor(properties?: NetworkFeatureSetProperties); static fromJSON(json: any): NetworkFeatureSet; } interface NetworkFeatureSetProperties extends FeatureSetProperties { /** * If true, restricted network elements should be considered when finding network locations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-NetworkFeatureSet.html#doNotLocateOnRestrictedElements) */ doNotLocateOnRestrictedElements?: boolean; } export interface NetworkUrl extends Accessor, JSONSupport { } export class NetworkUrl { /** * If true, restricted network elements should be considered when finding network locations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-NetworkUrl.html#doNotLocateOnRestrictedElements) */ doNotLocateOnRestrictedElements: boolean; /** * A url to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-NetworkUrl.html#url) */ url: string; /** * An input type for Route, Closest Facility, and Service Area solvers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-NetworkUrl.html) */ constructor(properties?: NetworkUrlProperties); static fromJSON(json: any): NetworkUrl; } interface NetworkUrlProperties { /** * If true, restricted network elements should be considered when finding network locations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-NetworkUrl.html#doNotLocateOnRestrictedElements) */ doNotLocateOnRestrictedElements?: boolean; /** * A url to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-NetworkUrl.html#url) */ url?: string; } export interface OffsetParameters extends Accessor, JSONSupport { } export class OffsetParameters { /** * The `bevelRatio` is multiplied by the offset distance and the result determines how far a mitered offset intersection can be located before it is beveled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-OffsetParameters.html#bevelRatio) */ bevelRatio: number; /** * The array of geometries to be offset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-OffsetParameters.html#geometries) */ geometries: Geometry[]; /** * Specifies the planar distance for constructing an offset based on the input geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-OffsetParameters.html#offsetDistance) */ offsetDistance: number; /** * Options that determine how the ends intersect. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-OffsetParameters.html#offsetHow) */ offsetHow: "bevelled" | "mitered" | "rounded"; /** * The offset distance unit. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-OffsetParameters.html#offsetUnit) */ offsetUnit: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards"; /** * Sets the offset distance, type and other parameters for the [geometryService.offset](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#offset) operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-OffsetParameters.html) */ constructor(properties?: OffsetParametersProperties); static fromJSON(json: any): OffsetParameters; } interface OffsetParametersProperties { /** * The `bevelRatio` is multiplied by the offset distance and the result determines how far a mitered offset intersection can be located before it is beveled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-OffsetParameters.html#bevelRatio) */ bevelRatio?: number; /** * The array of geometries to be offset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-OffsetParameters.html#geometries) */ geometries?: GeometryProperties[]; /** * Specifies the planar distance for constructing an offset based on the input geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-OffsetParameters.html#offsetDistance) */ offsetDistance?: number; /** * Options that determine how the ends intersect. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-OffsetParameters.html#offsetHow) */ offsetHow?: "bevelled" | "mitered" | "rounded"; /** * The offset distance unit. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-OffsetParameters.html#offsetUnit) */ offsetUnit?: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards"; } export interface ParameterValue extends Accessor, JSONSupport { } export class ParameterValue { /** * Specifies the parameter's data type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ParameterValue.html#dataType) */ dataType: | "boolean" | "data-file" | "date" | "double" | "feature-record-set-layer" | "field" | "linear-unit" | "long" | "raster-data" | "raster-data-layer" | "record-set" | "string" | "value-table" | "multi-value-boolean" | "multi-value-data-file" | "multi-value-date" | "multi-value-double" | "multi-value-feature-record-set-layer" | "multi-value-field" | "multi-value-linear-unit" | "multi-value-long" | "multi-value-raster-data" | "multi-value-raster-data-layer" | "multi-value-record-set" | "multi-value-string"; /** * The name of the parameter the value is for. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ParameterValue.html#paramName) */ paramName: string; /** * The value of the parameter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ParameterValue.html#value) */ value: | boolean | DataFile | Date | number | FeatureSet | Field | LinearUnit | RasterData | string | (boolean | DataFile | Date | number | FeatureSet | Field | LinearUnit | RasterData | string)[]; /** * Represents the output parameters of a [geoprocessor](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geoprocessor.html) method and their properties and values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ParameterValue.html) */ constructor(properties?: ParameterValueProperties); static fromJSON(json: any): ParameterValue; } interface ParameterValueProperties { /** * Specifies the parameter's data type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ParameterValue.html#dataType) */ dataType?: | "boolean" | "data-file" | "date" | "double" | "feature-record-set-layer" | "field" | "linear-unit" | "long" | "raster-data" | "raster-data-layer" | "record-set" | "string" | "value-table" | "multi-value-boolean" | "multi-value-data-file" | "multi-value-date" | "multi-value-double" | "multi-value-feature-record-set-layer" | "multi-value-field" | "multi-value-linear-unit" | "multi-value-long" | "multi-value-raster-data" | "multi-value-raster-data-layer" | "multi-value-record-set" | "multi-value-string"; /** * The name of the parameter the value is for. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ParameterValue.html#paramName) */ paramName?: string; /** * The value of the parameter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ParameterValue.html#value) */ value?: | boolean | DataFileProperties | DateProperties | number | FeatureSetProperties | FieldProperties | LinearUnitProperties | RasterDataProperties | string | ( | boolean | DataFileProperties | DateProperties | number | FeatureSetProperties | FieldProperties | LinearUnitProperties | RasterDataProperties | string )[]; } export class PlaceResult extends Accessor { /** * An arrary of category objects for a place. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlaceResult.html#categories) */ categories: Category[]; /** * The distance, in meters, from the place to the search point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlaceResult.html#distance) */ distance: number; /** * A location defined by X and Y coordinates in WGS84. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlaceResult.html#location) */ location: Point; /** * The name of the place, or point of interest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlaceResult.html#name) */ name: string; /** * The unique Id of this place. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlaceResult.html#placeId) */ placeId: string; /** * The `PlaceResult` object includes a single place that satisfies the search and either: the distance from the [search point](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryParameters.html#point) in meters, or falls within the [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryParameters.html#extent) of the search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlaceResult.html) */ constructor(properties?: PlaceResultProperties); } interface PlaceResultProperties { /** * An arrary of category objects for a place. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlaceResult.html#categories) */ categories?: Category[]; /** * The distance, in meters, from the place to the search point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlaceResult.html#distance) */ distance?: number; /** * A location defined by X and Y coordinates in WGS84. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlaceResult.html#location) */ location?: PointProperties; /** * The name of the place, or point of interest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlaceResult.html#name) */ name?: string; /** * The unique Id of this place. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlaceResult.html#placeId) */ placeId?: string; } /** * Each category object has a categoryId and a label. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlaceResult.html#Category) */ export interface Category { /** * The Id of the category of the place. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlaceResult.html#Category) */ categoryId: number; /** * The name of the the category. * * [Read more...](global.html) */ label: string; } export class PlacesParameters extends Accessor { /** * An authorization string used to access a resource or service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesParameters.html#apiKey) */ apiKey: string; /** * URL to the places service. * * @default "https://places-api.arcgis.com/arcgis/rest/services/places-service/v1" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesParameters.html#url) */ url: string; /** * The following properties define common properties for use with [places](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-places.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesParameters.html) */ constructor(properties?: PlacesParametersProperties); } interface PlacesParametersProperties { /** * An authorization string used to access a resource or service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesParameters.html#apiKey) */ apiKey?: string; /** * URL to the places service. * * @default "https://places-api.arcgis.com/arcgis/rest/services/places-service/v1" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesParameters.html#url) */ url?: string; } export class PlacesQueryParameters extends PlacesParameters { /** * Filters places to those that match the category Ids. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryParameters.html#categoryIds) */ categoryIds: string[]; /** * The extent of the bounding box to be searched inside. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryParameters.html#extent) */ extent: Extent; /** * Request results starting from the given offset. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryParameters.html#offset) */ offset: number; /** * The number of places that should be sent in the response for a single request. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryParameters.html#pageSize) */ pageSize: number; /** * A location defined by X and Y coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryParameters.html#point) */ point: Point; /** * The radius in meters to search for places, measured from the supplied [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryParameters.html#point). * * @default 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryParameters.html#radius) */ radius: number; /** * Free search text for places against names, categories, etc. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryParameters.html#searchText) */ searchText: string; /** * The following properties define the parameters for the [queryPlacesNearPoint()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-places.html#queryPlacesNearPoint) and [queryPlacesWithinExtent()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-places.html#queryPlacesWithinExtent) methods pointing to a [url](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryParameters.html#url) that represents a places service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryParameters.html) */ constructor(properties?: PlacesQueryParametersProperties); /** * Creates a deep clone of the instance of PlacesQueryParameters that this method is called on. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryParameters.html#clone) */ clone(): PlacesQueryParameters; } interface PlacesQueryParametersProperties extends PlacesParametersProperties { /** * Filters places to those that match the category Ids. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryParameters.html#categoryIds) */ categoryIds?: string[]; /** * The extent of the bounding box to be searched inside. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryParameters.html#extent) */ extent?: ExtentProperties; /** * Request results starting from the given offset. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryParameters.html#offset) */ offset?: number; /** * The number of places that should be sent in the response for a single request. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryParameters.html#pageSize) */ pageSize?: number; /** * A location defined by X and Y coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryParameters.html#point) */ point?: PointProperties; /** * The radius in meters to search for places, measured from the supplied [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryParameters.html#point). * * @default 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryParameters.html#radius) */ radius?: number; /** * Free search text for places against names, categories, etc. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryParameters.html#searchText) */ searchText?: string; } export class PlacesQueryResult extends Accessor { /** * The query parameters for the next set of results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryResult.html#nextQueryParams) */ nextQueryParams: PlacesQueryParameters; /** * The query parameters for the previous set of results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryResult.html#previousQueryParams) */ previousQueryParams: PlacesQueryParameters; /** * An array of results from searching for places using the [queryPlacesNearPoint()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-places.html#queryPlacesNearPoint) and [queryPlacesWithinExtent()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-places.html#queryPlacesWithinExtent) methods. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryResult.html#results) */ results: PlaceResult[]; /** * The `PlacesQueryResult` object includes the results from the [queryPlacesNearPoint()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-places.html#queryPlacesNearPoint) and [queryPlacesWithinExtent()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-places.html#queryPlacesWithinExtent) methods. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryResult.html) */ constructor(properties?: PlacesQueryResultProperties); } interface PlacesQueryResultProperties { /** * The query parameters for the next set of results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryResult.html#nextQueryParams) */ nextQueryParams?: PlacesQueryParametersProperties; /** * The query parameters for the previous set of results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryResult.html#previousQueryParams) */ previousQueryParams?: PlacesQueryParametersProperties; /** * An array of results from searching for places using the [queryPlacesNearPoint()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-places.html#queryPlacesNearPoint) and [queryPlacesWithinExtent()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-places.html#queryPlacesWithinExtent) methods. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryResult.html#results) */ results?: PlaceResultProperties[]; } export interface PointBarrier extends Accessor, JSONSupport { } export class PointBarrier { /** * Specify if the point barrier restricts travel completely or adds time or distance when it is crossed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PointBarrier.html#barrierType) */ barrierType: "restriction" | "added-cost"; /** * The direction of traffic that is affected by the barrier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PointBarrier.html#curbApproach) */ readonly curbApproach: "either-side-of-vehicle" | "right-side-of-vehicle" | "left-side-of-vehicle"; /** * Point barriers are applied to the edge elements during the analysis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PointBarrier.html#fullEdge) */ fullEdge: "permit" | "restrict"; /** * The point location of the barrier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PointBarrier.html#geometry) */ geometry: Point; /** * The name of the barrier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PointBarrier.html#name) */ name: string; readonly type: "barrier-point"; /** * A point barrier to restrict travel along a street network when using a [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PointBarrier.html) */ constructor(properties?: PointBarrierProperties); /** * Creates a [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) from the [PointBarrier](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PointBarrier.html) instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PointBarrier.html#toGraphic) */ toGraphic(): Graphic; /** * Creates a [PointBarrier](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PointBarrier.html) from the parsed [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PointBarrier.html#fromGraphic) */ static fromGraphic(graphic?: Graphic): PointBarrier; static fromJSON(json: any): PointBarrier; } interface PointBarrierProperties { /** * Specify if the point barrier restricts travel completely or adds time or distance when it is crossed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PointBarrier.html#barrierType) */ barrierType?: "restriction" | "added-cost"; /** * Point barriers are applied to the edge elements during the analysis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PointBarrier.html#fullEdge) */ fullEdge?: "permit" | "restrict"; /** * The point location of the barrier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PointBarrier.html#geometry) */ geometry?: PointProperties; /** * The name of the barrier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PointBarrier.html#name) */ name?: string; } export interface PolygonBarrier extends Accessor, JSONSupport { } export class PolygonBarrier { /** * Use this parameter to specify polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolygonBarrier.html#barrierType) */ barrierType: "restriction" | "scaled-cost"; /** * The point location of the barrier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolygonBarrier.html#geometry) */ geometry: Polygon; /** * The name of the barrier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolygonBarrier.html#name) */ name: string; readonly type: "barrier-area"; /** * A polygon barrier to restrict travel along a street network when using a [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolygonBarrier.html) */ constructor(properties?: PolygonBarrierProperties); /** * Creates a [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) from the [PolygonBarrier](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolygonBarrier.html) instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolygonBarrier.html#toGraphic) */ toGraphic(): Graphic; /** * Creates a [PolygonBarrier](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolygonBarrier.html) from the parsed [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolygonBarrier.html#fromGraphic) */ static fromGraphic(graphic?: Graphic): PolygonBarrier; static fromJSON(json: any): PolygonBarrier; } interface PolygonBarrierProperties { /** * Use this parameter to specify polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolygonBarrier.html#barrierType) */ barrierType?: "restriction" | "scaled-cost"; /** * The point location of the barrier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolygonBarrier.html#geometry) */ geometry?: PolygonProperties; /** * The name of the barrier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolygonBarrier.html#name) */ name?: string; } export interface PolylineBarrier extends Accessor, JSONSupport { } export class PolylineBarrier { /** * Specify whether the barrier restricts travel completely or scales time or distance when it is crossed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolylineBarrier.html#barrierType) */ barrierType: "restriction" | "scaled-cost"; /** * The point location of the barrier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolylineBarrier.html#geometry) */ geometry: Point; /** * The name of the barrier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolylineBarrier.html#name) */ name: string; readonly type: "barrier-line"; /** * A polyline barrier to restrict travel along a street network when using a [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolylineBarrier.html) */ constructor(properties?: PolylineBarrierProperties); /** * Creates a [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) from the [PolylineBarrier](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolylineBarrier.html) instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolylineBarrier.html#toGraphic) */ toGraphic(): Graphic; /** * Creates a [PolylineBarrier](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolylineBarrier.html) from the parsed [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolylineBarrier.html#fromGraphic) */ static fromGraphic(graphic?: Graphic): PolylineBarrier; static fromJSON(json: any): PolylineBarrier; } interface PolylineBarrierProperties { /** * Specify whether the barrier restricts travel completely or scales time or distance when it is crossed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolylineBarrier.html#barrierType) */ barrierType?: "restriction" | "scaled-cost"; /** * The point location of the barrier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolylineBarrier.html#geometry) */ geometry?: PointProperties; /** * The name of the barrier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PolylineBarrier.html#name) */ name?: string; } export class PrintParameters extends Accessor { /** * Additional parameters for the print service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintParameters.html#extraParameters) */ extraParameters: any; /** * Specify the output spatial reference for the printout. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintParameters.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * Defines the layout template used for the printed map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintParameters.html#template) */ template: PrintTemplate; /** * The view to print. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintParameters.html#view) */ view: MapView; /** * Input parameters for [print](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintParameters.html) */ constructor(properties?: PrintParametersProperties); } interface PrintParametersProperties { /** * Additional parameters for the print service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintParameters.html#extraParameters) */ extraParameters?: any; /** * Specify the output spatial reference for the printout. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintParameters.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; /** * Defines the layout template used for the printed map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintParameters.html#template) */ template?: PrintTemplateProperties; /** * The view to print. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintParameters.html#view) */ view?: MapViewProperties; } export class PrintTemplate extends Accessor { /** * When `false`, the attribution is not displayed on the printout. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#attributionVisible) */ attributionVisible: boolean; /** * Define the map width, height and dpi. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#exportOptions) */ exportOptions: PrintTemplateExportOptions; /** * When true, the feature's attributes are included in feature collection layers even when they are not needed for rendering. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#forceFeatureAttributes) */ forceFeatureAttributes: boolean; /** * The output format for the printed map. * * @default png32 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#format) */ format: "pdf" | "png32" | "png8" | "jpg" | "gif" | "eps" | "svg" | "svgz"; /** * When `true`, charts will be included in the printout request. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#includeCharts) */ includeCharts: boolean; /** * When `true`, tables will be included in the printout request. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#includeTables) */ includeTables: boolean; /** * The layout used for the print output. * * @default map-only * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#layout) */ layout: | "map-only" | "a3-landscape" | "a3-portrait" | "a4-landscape" | "a4-portrait" | "letter-ansi-a-landscape" | "letter-ansi-a-portrait" | "tabloid-ansi-b-landscape" | "tabloid-ansi-b-portrait"; /** * A custom layout hosted as a [portal item](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#layoutItem) */ layoutItem: PortalItem; /** * Defines the layout elements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#layoutOptions) */ layoutOptions: PrintTemplateLayoutOptions; /** * The optional map scale of the printed map. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#outScale) */ outScale: number; /** * The name of the report template. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#report) */ report: | "attribute-list-letter-ansi-a-landscape" | "attribute-list-letter-ansi-a-portrait" | "attribute-list-with-group-letter-ansi-a-landscape" | "attribute-list-with-group-letter-ansi-a-portrait" | "page-per-feature-letter-ansi-a-landscape" | "page-per-feature-letter-ansi-a-portrait"; /** * A custom report template hosted as a [portal item](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html) for report printing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#reportItem) */ reportItem: PortalItem; /** * This object links the various report elements to their data source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#reportOptions) */ reportOptions: any; /** * Define whether the printed map should preserve map scale or map extent. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#scalePreserved) */ scalePreserved: boolean; /** * When `true`, labels will be shown on the layout. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#showLabels) */ showLabels: boolean; /** * Defines the layout template options used by [print](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html) and the [PrintViewModel.print()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#print) method to generate the print page. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html) */ constructor(properties?: PrintTemplateProperties); } interface PrintTemplateProperties { /** * When `false`, the attribution is not displayed on the printout. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#attributionVisible) */ attributionVisible?: boolean; /** * Define the map width, height and dpi. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#exportOptions) */ exportOptions?: PrintTemplateExportOptions; /** * When true, the feature's attributes are included in feature collection layers even when they are not needed for rendering. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#forceFeatureAttributes) */ forceFeatureAttributes?: boolean; /** * The output format for the printed map. * * @default png32 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#format) */ format?: "pdf" | "png32" | "png8" | "jpg" | "gif" | "eps" | "svg" | "svgz"; /** * When `true`, charts will be included in the printout request. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#includeCharts) */ includeCharts?: boolean; /** * When `true`, tables will be included in the printout request. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#includeTables) */ includeTables?: boolean; /** * The layout used for the print output. * * @default map-only * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#layout) */ layout?: | "map-only" | "a3-landscape" | "a3-portrait" | "a4-landscape" | "a4-portrait" | "letter-ansi-a-landscape" | "letter-ansi-a-portrait" | "tabloid-ansi-b-landscape" | "tabloid-ansi-b-portrait"; /** * A custom layout hosted as a [portal item](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#layoutItem) */ layoutItem?: PortalItemProperties; /** * Defines the layout elements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#layoutOptions) */ layoutOptions?: PrintTemplateLayoutOptions; /** * The optional map scale of the printed map. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#outScale) */ outScale?: number; /** * The name of the report template. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#report) */ report?: | "attribute-list-letter-ansi-a-landscape" | "attribute-list-letter-ansi-a-portrait" | "attribute-list-with-group-letter-ansi-a-landscape" | "attribute-list-with-group-letter-ansi-a-portrait" | "page-per-feature-letter-ansi-a-landscape" | "page-per-feature-letter-ansi-a-portrait"; /** * A custom report template hosted as a [portal item](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html) for report printing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#reportItem) */ reportItem?: PortalItemProperties; /** * This object links the various report elements to their data source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#reportOptions) */ reportOptions?: any; /** * Define whether the printed map should preserve map scale or map extent. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#scalePreserved) */ scalePreserved?: boolean; /** * When `true`, labels will be shown on the layout. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#showLabels) */ showLabels?: boolean; } export interface PrintTemplateExportOptions { /** * Map width. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#exportOptions) */ width?: number; /** * Map height. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#exportOptions) */ height?: number; /** * Resolution in dots per inch. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#exportOptions) */ dpi?: number; } export interface PrintTemplateLayoutOptions { /** * The text used for the map title if the specified layout contains a title text element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#layoutOptions) */ titleText?: string; /** * The text used for the author if the specified layout contains an author text element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#layoutOptions) */ authorText?: string; /** * The text used for the copyright if the specified layout contains a copyright text element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#layoutOptions) */ copyrightText?: string; /** * The unit used for the scalebar. * * @default Miles * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#layoutOptions) */ scalebarUnit?: "Miles" | "Kilometers" | "Meters" | "Feet"; /** * An array of [LegendLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LegendLayer.html) containing the ids of the layers that will be included in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#layoutOptions) */ legendLayers?: LegendLayer[]; /** * An array of name-value pair objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#layoutOptions) */ customTextElements?: any[]; /** * An object containing optional elements from the print service that can be updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#layoutOptions) */ elementOverrides?: any; } export class ProjectParameters extends Accessor { /** * The input geometries to project. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ProjectParameters.html#geometries) */ geometries: Geometry[]; /** * The spatial reference to which you are projecting the geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ProjectParameters.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * The well-known id {wkid:number} or well-known text {wkt:string} of the datum transformation to be applied to the projected geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ProjectParameters.html#transformation) */ transformation: ProjectParametersTransformation; /** * Indicates whether to transform forward or not. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ProjectParameters.html#transformForward) */ transformForward: boolean; /** * Defines the projection parameters used when calling the [geometryService.project()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#project). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ProjectParameters.html) */ constructor(properties?: ProjectParametersProperties); /** * Converts an instance of this class to its ArcGIS portal JSON representation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ProjectParameters.html#toJSON) */ toJSON(): any; } interface ProjectParametersProperties { /** * The input geometries to project. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ProjectParameters.html#geometries) */ geometries?: GeometryProperties[]; /** * The spatial reference to which you are projecting the geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ProjectParameters.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; /** * The well-known id {wkid:number} or well-known text {wkt:string} of the datum transformation to be applied to the projected geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ProjectParameters.html#transformation) */ transformation?: ProjectParametersTransformation; /** * Indicates whether to transform forward or not. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ProjectParameters.html#transformForward) */ transformForward?: boolean; } export interface ProjectParametersTransformation { /** * The well-known ID of the datum transformation to apply to the projection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ProjectParameters.html#transformation) */ wkid?: number; /** * The well-known text that defines a spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ProjectParameters.html#transformation) */ wkt?: string; } export interface Query extends Accessor, JSONSupport { } export class Query { /** * An array of Object IDs representing [aggregate](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#isAggregate) (i.e. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#aggregateIds) */ aggregateIds: number[]; /** * Indicates if the service should cache the query results. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#cacheHint) */ cacheHint: boolean; /** * Datum transformation used for projecting geometries in the query results when [outSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#outSpatialReference) is different than the layer's spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#datumTransformation) */ datumTransformation: number; /** * Specifies a search distance from a given [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#geometry) in a spatial query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#distance) */ distance: number; /** * Specifies the geodatabase version to display for feature service queries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#gdbVersion) */ gdbVersion: string; /** * The geometry to apply to the spatial filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#geometry) */ geometry: Geometry; /** * Specifies the number of decimal places for geometries returned by the [JSON query operation](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html#executeQueryJSON). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#geometryPrecision) */ geometryPrecision: number; /** * Used only in [statistical queries](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#statistic). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#groupByFieldsForStatistics) */ groupByFieldsForStatistics: string[]; /** * A condition used with [outStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#outStatistics) and [groupByFieldsForStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#groupByFieldsForStatistics) to limit query results to groups that satisfy the aggregation function(s). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#having) */ having: string; /** * The historic moment to query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#historicMoment) */ historicMoment: Date; /** * The maximum distance in units of [outSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#outSpatialReference) used for generalizing geometries returned by the query operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#maxAllowableOffset) */ maxAllowableOffset: number; /** * When set, the maximum number of features returned by the query will equal the `maxRecordCount` of the service multiplied by this factor. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#maxRecordCountFactor) */ maxRecordCountFactor: number; /** * Parameter dictates how the geometry of a multipatch feature will be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#multipatchOption) */ multipatchOption: string; /** * The number of features to retrieve. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#num) */ num: number; /** * An array of ObjectIDs to be used to query for features in a layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#objectIds) */ objectIds: number[]; /** * One or more field names used to order the query results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#orderByFields) */ orderByFields: string[]; /** * Attribute fields to include in the [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#outFields) */ outFields: string[]; /** * The spatial reference for the returned geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * The definitions for one or more field-based statistics to be calculated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#outStatistics) */ outStatistics: StatisticDefinition[]; /** * Filters features from the layer based on pre-authored parameterized filters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#parameterValues) */ parameterValues: QueryParameterValues[]; /** * Specifies the pixel level to be identified on the X and Y axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#pixelSize) */ pixelSize: Point; /** * Used to project the geometry onto a virtual grid, likely representing pixels on the screen. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#quantizationParameters) */ quantizationParameters: QueryQuantizationParameters; /** * Filters features from the layer that are within the specified range values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#rangeValues) */ rangeValues: QueryRangeValues[]; /** * The Dimensionally Extended 9 Intersection Model (DE-9IM) matrix relation (encoded as a string) to query the spatial relationship of the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#geometry) to the layer's features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#relationParameter) */ relationParameter: string; /** * If `true`, each feature in the returned [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html) will be returned with a centroid. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnCentroid) */ returnCentroid: boolean; /** * If `true` then the query returns distinct values based on the field(s) specified in [outFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#outFields). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnDistinctValues) */ returnDistinctValues: boolean; /** * If `true`, then all features are returned for each tile request, even if they exceed the maximum record limit per query indicated on the service by `maxRecordCount`. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnExceededLimitFeatures) */ returnExceededLimitFeatures: boolean; /** * If `true`, each feature in the returned [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html) includes the geometry. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnGeometry) */ returnGeometry: boolean; /** * If `true`, and [returnGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnGeometry) is `true`, then m-values are included in the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnM) */ returnM: boolean; /** * If `true`, the [query geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html#queryGeometry) will be returned with the query results. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnQueryGeometry) */ returnQueryGeometry: boolean; /** * If `true`, and [returnGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnGeometry) is `true`, then z-values are included in the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnZ) */ returnZ: boolean; /** * For spatial queries, this parameter defines the spatial relationship to query features in the layer or layer view against the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#geometry). * * @default intersects * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#spatialRelationship) */ spatialRelationship: | "intersects" | "contains" | "crosses" | "disjoint" | "envelope-intersects" | "index-intersects" | "overlaps" | "touches" | "within" | "relation"; /** * This parameter can be either standard SQL92 `standard` or it can use the native SQL of the underlying datastore `native`. * * @default none * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#sqlFormat) */ sqlFormat: "none" | "standard" | "native"; /** * The zero-based index indicating where to begin retrieving features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#start) */ start: number; /** * Shorthand for a where clause using "like". * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#text) */ text: string; /** * A time extent for a temporal query against [time-aware layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#timeInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#timeExtent) */ timeExtent: TimeExtent; /** * The unit for calculating the buffer distance when [distance](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#distance) is specified in spatial queries. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#units) */ units: "feet" | "miles" | "nautical-miles" | "us-nautical-miles" | "meters" | "kilometers"; /** * A where clause for the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#where) */ where: string; /** * This class defines parameters for executing queries for features from a layer or layer view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) */ constructor(properties?: QueryProperties); /** * Creates a deep clone of Query object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#clone) */ clone(): Query; static fromJSON(json: any): Query; } interface QueryProperties { /** * An array of Object IDs representing [aggregate](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#isAggregate) (i.e. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#aggregateIds) */ aggregateIds?: number[]; /** * Indicates if the service should cache the query results. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#cacheHint) */ cacheHint?: boolean; /** * Datum transformation used for projecting geometries in the query results when [outSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#outSpatialReference) is different than the layer's spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#datumTransformation) */ datumTransformation?: number; /** * Specifies a search distance from a given [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#geometry) in a spatial query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#distance) */ distance?: number; /** * Specifies the geodatabase version to display for feature service queries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#gdbVersion) */ gdbVersion?: string; /** * The geometry to apply to the spatial filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#geometry) */ geometry?: GeometryProperties; /** * Specifies the number of decimal places for geometries returned by the [JSON query operation](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html#executeQueryJSON). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#geometryPrecision) */ geometryPrecision?: number; /** * Used only in [statistical queries](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#statistic). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#groupByFieldsForStatistics) */ groupByFieldsForStatistics?: string[]; /** * A condition used with [outStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#outStatistics) and [groupByFieldsForStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#groupByFieldsForStatistics) to limit query results to groups that satisfy the aggregation function(s). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#having) */ having?: string; /** * The historic moment to query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#historicMoment) */ historicMoment?: DateProperties; /** * The maximum distance in units of [outSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#outSpatialReference) used for generalizing geometries returned by the query operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#maxAllowableOffset) */ maxAllowableOffset?: number; /** * When set, the maximum number of features returned by the query will equal the `maxRecordCount` of the service multiplied by this factor. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#maxRecordCountFactor) */ maxRecordCountFactor?: number; /** * Parameter dictates how the geometry of a multipatch feature will be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#multipatchOption) */ multipatchOption?: string; /** * The number of features to retrieve. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#num) */ num?: number; /** * An array of ObjectIDs to be used to query for features in a layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#objectIds) */ objectIds?: number[]; /** * One or more field names used to order the query results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#orderByFields) */ orderByFields?: string[]; /** * Attribute fields to include in the [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#outFields) */ outFields?: string[]; /** * The spatial reference for the returned geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; /** * The definitions for one or more field-based statistics to be calculated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#outStatistics) */ outStatistics?: StatisticDefinitionProperties[]; /** * Filters features from the layer based on pre-authored parameterized filters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#parameterValues) */ parameterValues?: QueryParameterValues[]; /** * Specifies the pixel level to be identified on the X and Y axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#pixelSize) */ pixelSize?: PointProperties; /** * Used to project the geometry onto a virtual grid, likely representing pixels on the screen. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#quantizationParameters) */ quantizationParameters?: QueryQuantizationParameters; /** * Filters features from the layer that are within the specified range values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#rangeValues) */ rangeValues?: QueryRangeValues[]; /** * The Dimensionally Extended 9 Intersection Model (DE-9IM) matrix relation (encoded as a string) to query the spatial relationship of the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#geometry) to the layer's features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#relationParameter) */ relationParameter?: string; /** * If `true`, each feature in the returned [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html) will be returned with a centroid. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnCentroid) */ returnCentroid?: boolean; /** * If `true` then the query returns distinct values based on the field(s) specified in [outFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#outFields). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnDistinctValues) */ returnDistinctValues?: boolean; /** * If `true`, then all features are returned for each tile request, even if they exceed the maximum record limit per query indicated on the service by `maxRecordCount`. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnExceededLimitFeatures) */ returnExceededLimitFeatures?: boolean; /** * If `true`, each feature in the returned [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html) includes the geometry. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnGeometry) */ returnGeometry?: boolean; /** * If `true`, and [returnGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnGeometry) is `true`, then m-values are included in the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnM) */ returnM?: boolean; /** * If `true`, the [query geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html#queryGeometry) will be returned with the query results. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnQueryGeometry) */ returnQueryGeometry?: boolean; /** * If `true`, and [returnGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnGeometry) is `true`, then z-values are included in the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnZ) */ returnZ?: boolean; /** * For spatial queries, this parameter defines the spatial relationship to query features in the layer or layer view against the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#geometry). * * @default intersects * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#spatialRelationship) */ spatialRelationship?: | "intersects" | "contains" | "crosses" | "disjoint" | "envelope-intersects" | "index-intersects" | "overlaps" | "touches" | "within" | "relation"; /** * This parameter can be either standard SQL92 `standard` or it can use the native SQL of the underlying datastore `native`. * * @default none * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#sqlFormat) */ sqlFormat?: "none" | "standard" | "native"; /** * The zero-based index indicating where to begin retrieving features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#start) */ start?: number; /** * Shorthand for a where clause using "like". * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#text) */ text?: string; /** * A time extent for a temporal query against [time-aware layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#timeInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#timeExtent) */ timeExtent?: TimeExtentProperties; /** * The unit for calculating the buffer distance when [distance](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#distance) is specified in spatial queries. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#units) */ units?: "feet" | "miles" | "nautical-miles" | "us-nautical-miles" | "meters" | "kilometers"; /** * A where clause for the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#where) */ where?: string; } export interface QueryParameterValues { /** * The parameter name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#parameterValues) */ name: string; /** * Single value or array of values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#parameterValues) */ value: string | string[] | number | number[] | Date | Date[]; } export interface QueryQuantizationParameters { /** * An extent defining the quantization grid bounds. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#quantizationParameters) */ extent?: Extent; /** * Geometry coordinates are optimized for viewing and displaying of data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#quantizationParameters) */ mode?: "view" | "edit"; /** * The integer's coordinates will be returned relative to the origin position defined by this property value. * * @default upper-left * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#quantizationParameters) */ originPosition?: "upper-left" | "lower-left"; /** * The size of one pixel in the units of the [outSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#outSpatialReference). * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#quantizationParameters) */ tolerance?: number; } export interface QueryRangeValues { /** * The range id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#rangeValues) */ name: string; /** * Single value or value range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#rangeValues) */ values: number | number[]; } export interface RasterData extends Accessor, JSONSupport { } export class RasterData { /** * Specifies the format of the raster data, such as "jpg", "tif", etc. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RasterData.html#format) */ format: string; /** * The ID of the uploaded file returned as a result of the upload operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RasterData.html#itemId) */ itemId: string; /** * URL to the location of the raster data file. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RasterData.html#url) */ url: string; /** * A geoprocessing data object containing a raster data source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RasterData.html) */ constructor(properties?: RasterDataProperties); static fromJSON(json: any): RasterData; } interface RasterDataProperties { /** * Specifies the format of the raster data, such as "jpg", "tif", etc. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RasterData.html#format) */ format?: string; /** * The ID of the uploaded file returned as a result of the upload operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RasterData.html#itemId) */ itemId?: string; /** * URL to the location of the raster data file. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RasterData.html#url) */ url?: string; } export interface RelationParameters extends Accessor, JSONSupport { } export class RelationParameters { /** * The first array of geometries to compute the relation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationParameters.html#geometries1) */ geometries1: Geometry[]; /** * The second array of geometries to compute the relation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationParameters.html#geometries2) */ geometries2: Geometry[]; /** * The spatial relationship to be tested between the two input geometry arrays. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationParameters.html#relation) */ relation: | "cross" | "disjoint" | "in" | "interior-intersection" | "intersection" | "line-coincidence" | "line-touch" | "overlap" | "point-touch" | "relation" | "touch" | "within"; /** * The string describes the spatial relationship to be tested when `RelationParameters.relation = 'relation'`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationParameters.html#relationParameter) */ relationParameter: string; /** * Sets the relation and other parameters for the [geometryService.relation()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#relation) operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationParameters.html) */ constructor(properties?: RelationParametersProperties); static fromJSON(json: any): RelationParameters; } interface RelationParametersProperties { /** * The first array of geometries to compute the relation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationParameters.html#geometries1) */ geometries1?: GeometryProperties[]; /** * The second array of geometries to compute the relation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationParameters.html#geometries2) */ geometries2?: GeometryProperties[]; /** * The spatial relationship to be tested between the two input geometry arrays. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationParameters.html#relation) */ relation?: | "cross" | "disjoint" | "in" | "interior-intersection" | "intersection" | "line-coincidence" | "line-touch" | "overlap" | "point-touch" | "relation" | "touch" | "within"; /** * The string describes the spatial relationship to be tested when `RelationParameters.relation = 'relation'`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationParameters.html#relationParameter) */ relationParameter?: string; } export interface RelationshipQuery extends Accessor, JSONSupport { } export class RelationshipQuery { /** * Indicates if the service should cache the relationship query results. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#cacheHint) */ cacheHint: boolean; /** * Specify the geodatabase version to query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#gdbVersion) */ gdbVersion: string; /** * Specify the number of decimal places for the geometries returned by the query operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#geometryPrecision) */ geometryPrecision: number; /** * The historic moment to query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#historicMoment) */ historicMoment: Date; /** * The maximum allowable offset used for generalizing geometries returned by the query operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#maxAllowableOffset) */ maxAllowableOffset: number; /** * The number of features to retrieve. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#num) */ num: number; /** * An array of objectIds for the features in the layer/table being queried. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#objectIds) */ objectIds: number[]; /** * One or more field names used to order the query results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#orderByFields) */ orderByFields: string[]; /** * Attribute fields to include in the FeatureSet. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#outFields) */ outFields: string[]; /** * The spatial reference for the returned geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * The ID of the relationship to be queried. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#relationshipId) */ relationshipId: number; /** * If `true`, each feature in the [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html) includes the geometry. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#returnGeometry) */ returnGeometry: boolean; /** * If `true`, and [returnGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#returnGeometry) is `true`, then m-values are included in the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#returnM) */ returnM: boolean; /** * If `true`, and [returnGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#returnGeometry) is `true`, then z-values are included in the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#returnZ) */ returnZ: boolean; /** * The zero-based index indicating where to begin retrieving features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#start) */ start: number; /** * The definition expression to be applied to the related table or layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#where) */ where: string; /** * This class defines parameters for executing queries for related records from a layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html) */ constructor(properties?: RelationshipQueryProperties); /** * Creates a deep clone of RelationshipQuery object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#clone) */ clone(): RelationshipQuery; static fromJSON(json: any): RelationshipQuery; } interface RelationshipQueryProperties { /** * Indicates if the service should cache the relationship query results. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#cacheHint) */ cacheHint?: boolean; /** * Specify the geodatabase version to query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#gdbVersion) */ gdbVersion?: string; /** * Specify the number of decimal places for the geometries returned by the query operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#geometryPrecision) */ geometryPrecision?: number; /** * The historic moment to query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#historicMoment) */ historicMoment?: DateProperties; /** * The maximum allowable offset used for generalizing geometries returned by the query operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#maxAllowableOffset) */ maxAllowableOffset?: number; /** * The number of features to retrieve. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#num) */ num?: number; /** * An array of objectIds for the features in the layer/table being queried. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#objectIds) */ objectIds?: number[]; /** * One or more field names used to order the query results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#orderByFields) */ orderByFields?: string[]; /** * Attribute fields to include in the FeatureSet. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#outFields) */ outFields?: string[]; /** * The spatial reference for the returned geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; /** * The ID of the relationship to be queried. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#relationshipId) */ relationshipId?: number; /** * If `true`, each feature in the [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html) includes the geometry. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#returnGeometry) */ returnGeometry?: boolean; /** * If `true`, and [returnGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#returnGeometry) is `true`, then m-values are included in the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#returnM) */ returnM?: boolean; /** * If `true`, and [returnGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#returnGeometry) is `true`, then z-values are included in the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#returnZ) */ returnZ?: boolean; /** * The zero-based index indicating where to begin retrieving features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#start) */ start?: number; /** * The definition expression to be applied to the related table or layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#where) */ where?: string; } export interface RouteInfo extends Accessor, JSONSupport { } export class RouteInfo { /** * The end time of the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteInfo.html#endTime) */ endTime: Date; /** * The local time offset (in minutes) for the end time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteInfo.html#endTimeOffset) */ endTimeOffset: number; /** * Polyline representing the route's geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteInfo.html#geometry) */ geometry: Polyline; /** * User specified route name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteInfo.html#name) */ name: string; /** * The start time of the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteInfo.html#startTime) */ startTime: Date; /** * The local time offset (in minutes) for the start time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteInfo.html#startTimeOffset) */ startTimeOffset: number; /** * Total distance traveled in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteInfo.html#totalDistance) */ totalDistance: number; /** * Total time in minutes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteInfo.html#totalDuration) */ totalDuration: number; readonly type: "route-info"; /** * A RouteInfo contains information about a solved route including the routes geometry and overall distance and time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteInfo.html) */ constructor(properties?: RouteInfoProperties); /** * Creates a [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) from the [RouteInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteInfo.html) instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteInfo.html#toGraphic) */ toGraphic(): Graphic; /** * Creates a [RouteInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteInfo.html) from the parsed [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteInfo.html#fromGraphic) */ static fromGraphic(graphic?: Graphic): RouteInfo; static fromJSON(json: any): RouteInfo; } interface RouteInfoProperties { /** * The end time of the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteInfo.html#endTime) */ endTime?: DateProperties; /** * The local time offset (in minutes) for the end time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteInfo.html#endTimeOffset) */ endTimeOffset?: number; /** * Polyline representing the route's geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteInfo.html#geometry) */ geometry?: PolylineProperties; /** * User specified route name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteInfo.html#name) */ name?: string; /** * The start time of the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteInfo.html#startTime) */ startTime?: DateProperties; /** * The local time offset (in minutes) for the start time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteInfo.html#startTimeOffset) */ startTimeOffset?: number; /** * Total distance traveled in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteInfo.html#totalDistance) */ totalDistance?: number; /** * Total time in minutes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteInfo.html#totalDuration) */ totalDuration?: number; } export interface RouteParameters extends Accessor, JSONSupport, Clonable { } export class RouteParameters { /** * Use this property to specify whether the operation should accumulate values other than the value specified for [impedanceAttribute](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#impedanceAttribute). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#accumulateAttributes) */ accumulateAttributes: ( | "kilometers" | "miles" | "minutes" | "travel-time" | "truck-minutes" | "truck-travel-time" | "walk-time" | string )[]; /** * An authorization string used to access a resource or service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#apiKey) */ apiKey: string; /** * Use this property to specify additional values required by an attribute or restriction, such as to specify whether the restriction prohibits, avoids, or prefers travel on restricted roads. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#attributeParameterValues) */ attributeParameterValues: RouteParametersAttributeParameterValue[]; /** * The language that will be used when generating travel directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#directionsLanguage) */ directionsLanguage: string; /** * Specify the units for displaying travel distance in the driving directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#directionsLengthUnits) */ directionsLengthUnits: | "centimeters" | "decimal-degrees" | "decimeters" | "feet" | "inches" | "kilometers" | "meters" | "miles" | "millimeters" | "nautical-miles" | "points" | "yards"; /** * Define the content and verbosity of the driving directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#directionsOutputType) */ directionsOutputType: | "complete" | "complete-no-events" | "featuresets" | "instructions-only" | "standard" | "summary-only"; /** * Specify the name of the formatting style for the directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#directionsStyleName) */ directionsStyleName: "desktop" | "navigation" | "campus"; /** * Set the time-based impedance attribute to display the duration of a maneuver, such as "Go northwest on Alvorado St. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#directionsTimeAttribute) */ directionsTimeAttribute: "travel-time" | "truck-travel-time" | "walk-time" | "minutes" | "truck-time" | string; /** * Use this property to specify whether the operation should reorder stops to find the optimized route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#findBestSequence) */ findBestSequence: boolean; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#geometryPrecision) */ geometryPrecision: number; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#geometryPrecisionM) */ geometryPrecisionM: number; /** * Use this property to specify the number of decimal places in the response geometries returned by a solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#geometryPrecisionZ) */ geometryPrecisionZ: number; /** * Specify whether invalid input locations should be ignored when finding the best solution. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#ignoreInvalidLocations) */ ignoreInvalidLocations: boolean; /** * Specifies the impedance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#impedanceAttribute) */ impedanceAttribute: | "kilometers" | "miles" | "minutes" | "travel-time" | "truck-minutes" | "truck-travel-time" | "walk-time" | string; /** * Use this property to specify by how much you want to simplify the route geometry returned by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#outputGeometryPrecision) */ outputGeometryPrecision: number; /** * Use this property to specify the units for the value specified for the [outputGeometryPrecision](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#outputGeometryPrecision) parameter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#outputGeometryPrecisionUnits) */ outputGeometryPrecisionUnits: | "centimeters" | "decimal-degrees" | "decimeters" | "feet" | "inches" | "kilometers" | "meters" | "miles" | "millimeters" | "nautical-miles" | "points" | "yards"; /** * Use this property to specify the type of route features that are output by the operation. * * @default "true-shape" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#outputLines) */ outputLines: "none" | "straight" | "true-shape" | "true-shape-with-measure"; /** * Use this property to specify the spatial reference of the geometries, such as line or point features, returned by a solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * Specify additional settings that can influence the behavior of the solver when finding solutions for the network analysis problems. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#overrides) */ overrides: any; /** * Use this property to specify one or more points that will act as temporary restrictions or represent additional time or distance that may be required to travel on the underlying streets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#pointBarriers) */ pointBarriers: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl; /** * Use this property to specify polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#polygonBarriers) */ polygonBarriers: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl; /** * Use this property to specify one or more lines that prohibit travel anywhere the lines intersect the streets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#polylineBarriers) */ polylineBarriers: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl; /** * Use this property to indicate whether the operation should keep the first stop fixed when reordering the [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#stops). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#preserveFirstStop) */ preserveFirstStop: boolean; /** * Use this property to indicate whether the operation should keep the last stop fixed when reordering the [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#stops). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#preserveLastStop) */ preserveLastStop: boolean; /** * Use this property to specify if the Object IDs specified for input locations such as stops or barriers should be preserved when the input locations are returned as output. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#preserveObjectID) */ preserveObjectID: boolean; /** * Use this property to specify which restrictions should be honored by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#restrictionAttributes) */ restrictionAttributes: ( | "any-hazmat-prohibited" | "avoid-carpool-roads" | "avoid-express-lanes" | "avoid-ferries" | "avoid-gates" | "avoid-limited-access-roads" | "avoid-private-roads" | "avoid-roads-unsuitable-for-pedestrians" | "avoid-stairways" | "avoid-toll-roads" | "avoid-toll-roads-for-trucks" | "avoid-truck-restricted-roads" | "avoid-unpaved-roads" | "axle-count-restriction" | "driving-a-bus" | "driving-a-taxi" | "driving-a-truck" | "driving-an-automobile" | "driving-an-emergency-vehicle" | "height-restriction" | "kingpin-to-rear-axle-length-restriction" | "length-restriction" | "preferred-for-pedestrians" | "riding-a-motorcycle" | "roads-under-construction-prohibited" | "semi-or-tractor-with-one-or-more-trailers-prohibited" | "single-axle-vehicles-prohibited" | "tandem-axle-vehicles-prohibited" | "through-traffic-prohibited" | "truck-with-trailers-restriction" | "use-preferred-hazmat-routes" | "use-preferred-truck-routes" | "walking" | "weight-restriction" | string )[]; /** * Use this property to restrict or permit the route from making U-turns at junctions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#restrictUTurns) */ restrictUTurns: "allow-backtrack" | "at-dead-ends-only" | "no-backtrack" | "at-dead-ends-and-intersections"; /** * Specify whether [point barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#pointBarriers) will be returned by the routing operation. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#returnBarriers) */ returnBarriers: boolean; /** * Specify whether the operation should generate driving directions for each route. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#returnDirections) */ returnDirections: boolean; /** * Specify whether [polygon barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#polygonBarriers) will be returned by the routing operation. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#returnPolygonBarriers) */ returnPolygonBarriers: boolean; /** * Specify whether [polyline barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#polylineBarriers) will be returned by the routing operation. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#returnPolylineBarriers) */ returnPolylineBarriers: boolean; /** * Use this property to specify if the operation should return routes. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#returnRoutes) */ returnRoutes: boolean; /** * Use this property to specify whether [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#stops) will be returned by the routing operation. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#returnStops) */ returnStops: boolean; /** * Specify whether traversed edges will be returned by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#returnTraversedEdges) */ returnTraversedEdges: boolean; /** * Specify whether traversed junctions will be returned by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#returnTraversedJunctions) */ returnTraversedJunctions: boolean; /** * Specify whether traversed turns will be returned by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#returnTraversedTurns) */ returnTraversedTurns: boolean; /** * Include z values for the returned geometries if supported by the underlying network. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#returnZ) */ returnZ: boolean; /** * Indicates the time that travel should begin. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#startTime) */ startTime: Date | "now"; /** * Specify the time zone or zones of the [startTime](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#startTime) property. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#startTimeIsUTC) */ startTimeIsUTC: boolean; /** * Specifies the locations the output route or routes will visit. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#stops) */ stops: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl; /** * Specify whether the timeWindowStart and timeWindowEnd property values on [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#stops) are specified in UTC or geographically local time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#timeWindowsAreUTC) */ timeWindowsAreUTC: boolean; /** * A travel mode represents a means of transportation, such as driving or walking. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#travelMode) */ travelMode: TravelMode; /** * Specify whether hierarchy should be used when finding the shortest paths. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#useHierarchy) */ useHierarchy: boolean; /** * Use this property to indicate whether the operation should consider time windows specified on the [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#stops) when finding the best route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#useTimeWindows) */ useTimeWindows: boolean; /** * Input parameters for [route](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-route.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html) */ constructor(properties?: RouteParametersProperties); static fromJSON(json: any): RouteParameters; } interface RouteParametersProperties { /** * Use this property to specify whether the operation should accumulate values other than the value specified for [impedanceAttribute](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#impedanceAttribute). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#accumulateAttributes) */ accumulateAttributes?: ( | "kilometers" | "miles" | "minutes" | "travel-time" | "truck-minutes" | "truck-travel-time" | "walk-time" | string )[]; /** * An authorization string used to access a resource or service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#apiKey) */ apiKey?: string; /** * Use this property to specify additional values required by an attribute or restriction, such as to specify whether the restriction prohibits, avoids, or prefers travel on restricted roads. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#attributeParameterValues) */ attributeParameterValues?: RouteParametersAttributeParameterValue[]; /** * The language that will be used when generating travel directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#directionsLanguage) */ directionsLanguage?: string; /** * Specify the units for displaying travel distance in the driving directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#directionsLengthUnits) */ directionsLengthUnits?: | "centimeters" | "decimal-degrees" | "decimeters" | "feet" | "inches" | "kilometers" | "meters" | "miles" | "millimeters" | "nautical-miles" | "points" | "yards"; /** * Define the content and verbosity of the driving directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#directionsOutputType) */ directionsOutputType?: | "complete" | "complete-no-events" | "featuresets" | "instructions-only" | "standard" | "summary-only"; /** * Specify the name of the formatting style for the directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#directionsStyleName) */ directionsStyleName?: "desktop" | "navigation" | "campus"; /** * Set the time-based impedance attribute to display the duration of a maneuver, such as "Go northwest on Alvorado St. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#directionsTimeAttribute) */ directionsTimeAttribute?: "travel-time" | "truck-travel-time" | "walk-time" | "minutes" | "truck-time" | string; /** * Use this property to specify whether the operation should reorder stops to find the optimized route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#findBestSequence) */ findBestSequence?: boolean; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#geometryPrecision) */ geometryPrecision?: number; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#geometryPrecisionM) */ geometryPrecisionM?: number; /** * Use this property to specify the number of decimal places in the response geometries returned by a solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#geometryPrecisionZ) */ geometryPrecisionZ?: number; /** * Specify whether invalid input locations should be ignored when finding the best solution. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#ignoreInvalidLocations) */ ignoreInvalidLocations?: boolean; /** * Specifies the impedance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#impedanceAttribute) */ impedanceAttribute?: | "kilometers" | "miles" | "minutes" | "travel-time" | "truck-minutes" | "truck-travel-time" | "walk-time" | string; /** * Use this property to specify by how much you want to simplify the route geometry returned by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#outputGeometryPrecision) */ outputGeometryPrecision?: number; /** * Use this property to specify the units for the value specified for the [outputGeometryPrecision](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#outputGeometryPrecision) parameter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#outputGeometryPrecisionUnits) */ outputGeometryPrecisionUnits?: | "centimeters" | "decimal-degrees" | "decimeters" | "feet" | "inches" | "kilometers" | "meters" | "miles" | "millimeters" | "nautical-miles" | "points" | "yards"; /** * Use this property to specify the type of route features that are output by the operation. * * @default "true-shape" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#outputLines) */ outputLines?: "none" | "straight" | "true-shape" | "true-shape-with-measure"; /** * Use this property to specify the spatial reference of the geometries, such as line or point features, returned by a solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; /** * Specify additional settings that can influence the behavior of the solver when finding solutions for the network analysis problems. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#overrides) */ overrides?: any; /** * Use this property to specify one or more points that will act as temporary restrictions or represent additional time or distance that may be required to travel on the underlying streets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#pointBarriers) */ pointBarriers?: | CollectionProperties | (DataLayerProperties & { type: "layer" }) | FeatureSetProperties | NetworkFeatureSetProperties | NetworkUrlProperties; /** * Use this property to specify polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#polygonBarriers) */ polygonBarriers?: | CollectionProperties | (DataLayerProperties & { type: "layer" }) | FeatureSetProperties | NetworkFeatureSetProperties | NetworkUrlProperties; /** * Use this property to specify one or more lines that prohibit travel anywhere the lines intersect the streets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#polylineBarriers) */ polylineBarriers?: | CollectionProperties | (DataLayerProperties & { type: "layer" }) | FeatureSetProperties | NetworkFeatureSetProperties | NetworkUrlProperties; /** * Use this property to indicate whether the operation should keep the first stop fixed when reordering the [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#stops). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#preserveFirstStop) */ preserveFirstStop?: boolean; /** * Use this property to indicate whether the operation should keep the last stop fixed when reordering the [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#stops). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#preserveLastStop) */ preserveLastStop?: boolean; /** * Use this property to specify if the Object IDs specified for input locations such as stops or barriers should be preserved when the input locations are returned as output. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#preserveObjectID) */ preserveObjectID?: boolean; /** * Use this property to specify which restrictions should be honored by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#restrictionAttributes) */ restrictionAttributes?: ( | "any-hazmat-prohibited" | "avoid-carpool-roads" | "avoid-express-lanes" | "avoid-ferries" | "avoid-gates" | "avoid-limited-access-roads" | "avoid-private-roads" | "avoid-roads-unsuitable-for-pedestrians" | "avoid-stairways" | "avoid-toll-roads" | "avoid-toll-roads-for-trucks" | "avoid-truck-restricted-roads" | "avoid-unpaved-roads" | "axle-count-restriction" | "driving-a-bus" | "driving-a-taxi" | "driving-a-truck" | "driving-an-automobile" | "driving-an-emergency-vehicle" | "height-restriction" | "kingpin-to-rear-axle-length-restriction" | "length-restriction" | "preferred-for-pedestrians" | "riding-a-motorcycle" | "roads-under-construction-prohibited" | "semi-or-tractor-with-one-or-more-trailers-prohibited" | "single-axle-vehicles-prohibited" | "tandem-axle-vehicles-prohibited" | "through-traffic-prohibited" | "truck-with-trailers-restriction" | "use-preferred-hazmat-routes" | "use-preferred-truck-routes" | "walking" | "weight-restriction" | string )[]; /** * Use this property to restrict or permit the route from making U-turns at junctions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#restrictUTurns) */ restrictUTurns?: "allow-backtrack" | "at-dead-ends-only" | "no-backtrack" | "at-dead-ends-and-intersections"; /** * Specify whether [point barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#pointBarriers) will be returned by the routing operation. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#returnBarriers) */ returnBarriers?: boolean; /** * Specify whether the operation should generate driving directions for each route. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#returnDirections) */ returnDirections?: boolean; /** * Specify whether [polygon barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#polygonBarriers) will be returned by the routing operation. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#returnPolygonBarriers) */ returnPolygonBarriers?: boolean; /** * Specify whether [polyline barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#polylineBarriers) will be returned by the routing operation. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#returnPolylineBarriers) */ returnPolylineBarriers?: boolean; /** * Use this property to specify if the operation should return routes. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#returnRoutes) */ returnRoutes?: boolean; /** * Use this property to specify whether [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#stops) will be returned by the routing operation. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#returnStops) */ returnStops?: boolean; /** * Specify whether traversed edges will be returned by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#returnTraversedEdges) */ returnTraversedEdges?: boolean; /** * Specify whether traversed junctions will be returned by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#returnTraversedJunctions) */ returnTraversedJunctions?: boolean; /** * Specify whether traversed turns will be returned by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#returnTraversedTurns) */ returnTraversedTurns?: boolean; /** * Include z values for the returned geometries if supported by the underlying network. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#returnZ) */ returnZ?: boolean; /** * Indicates the time that travel should begin. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#startTime) */ startTime?: DateProperties | "now"; /** * Specify the time zone or zones of the [startTime](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#startTime) property. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#startTimeIsUTC) */ startTimeIsUTC?: boolean; /** * Specifies the locations the output route or routes will visit. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#stops) */ stops?: | CollectionProperties | (DataLayerProperties & { type: "layer" }) | FeatureSetProperties | NetworkFeatureSetProperties | NetworkUrlProperties; /** * Specify whether the timeWindowStart and timeWindowEnd property values on [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#stops) are specified in UTC or geographically local time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#timeWindowsAreUTC) */ timeWindowsAreUTC?: boolean; /** * A travel mode represents a means of transportation, such as driving or walking. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#travelMode) */ travelMode?: TravelModeProperties; /** * Specify whether hierarchy should be used when finding the shortest paths. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#useHierarchy) */ useHierarchy?: boolean; /** * Use this property to indicate whether the operation should consider time windows specified on the [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#stops) when finding the best route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#useTimeWindows) */ useTimeWindows?: boolean; } /** * An object describing the parameter values for the [attributeParameterValues](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#attributeParameterValues) property of [RouteParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#AttributeParameterValue) */ export interface RouteParametersAttributeParameterValue { /** * The name of the restriction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#AttributeParameterValue) */ attributeName: string; /** * The name of the parameter associated with the restriction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#AttributeParameterValue) */ parameterName: string; /** * The value for `parameterName`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#AttributeParameterValue) */ value: string | number; } export interface RouteResult extends Accessor, JSONSupport { } export class RouteResult { /** * Direction lines contains a set of line features for each segment of the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteResult.html#directionLines) */ directionLines: FeatureSet; /** * Direction points contains a set of point features representing the direction maneuvers such as arriving to or departing from a stop, turning left or right, and other events along your route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteResult.html#directionPoints) */ directionPoints: FeatureSet; /** * Direction are returned if [RouteParameters.returnDirections](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#returnDirections) is set to `true` and [RouteParameters.directionsOutputType](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#directionsOutputType) is set to `complete`, `complete-no-events`, `instructions-only', `standard` or `summary-only` in a [route.solve()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-route.html#solve) request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteResult.html#directions) */ directions: DirectionsFeatureSet; /** * This property returns a Graphic that represent the overall path with attributes containing the total cost. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteResult.html#route) */ route: Graphic; /** * The name of the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteResult.html#routeName) */ routeName: string; /** * Array of stops. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteResult.html#stops) */ stops: Graphic[]; /** * This provides access to the edges that are traversed while solving a network analysis layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteResult.html#traversedEdges) */ traversedEdges: FeatureSet; /** * This provides access to the junctions that are traversed while solving a network analysis layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteResult.html#traversedJunctions) */ traversedJunctions: FeatureSet; /** * This provides access to the turns that are traversed while solving a network analysis layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteResult.html#traversedTurns) */ traversedTurns: FeatureSet; /** * The route result from [route.solve()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-route.html#solve) as part of a [RouteSolveResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteSolveResult.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteResult.html) */ constructor(properties?: RouteResultProperties); static fromJSON(json: any): RouteResult; } interface RouteResultProperties { /** * Direction lines contains a set of line features for each segment of the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteResult.html#directionLines) */ directionLines?: FeatureSetProperties; /** * Direction points contains a set of point features representing the direction maneuvers such as arriving to or departing from a stop, turning left or right, and other events along your route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteResult.html#directionPoints) */ directionPoints?: FeatureSetProperties; /** * Direction are returned if [RouteParameters.returnDirections](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#returnDirections) is set to `true` and [RouteParameters.directionsOutputType](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#directionsOutputType) is set to `complete`, `complete-no-events`, `instructions-only', `standard` or `summary-only` in a [route.solve()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-route.html#solve) request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteResult.html#directions) */ directions?: DirectionsFeatureSetProperties; /** * This property returns a Graphic that represent the overall path with attributes containing the total cost. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteResult.html#route) */ route?: GraphicProperties; /** * The name of the route. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteResult.html#routeName) */ routeName?: string; /** * Array of stops. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteResult.html#stops) */ stops?: GraphicProperties[]; /** * This provides access to the edges that are traversed while solving a network analysis layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteResult.html#traversedEdges) */ traversedEdges?: FeatureSetProperties; /** * This provides access to the junctions that are traversed while solving a network analysis layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteResult.html#traversedJunctions) */ traversedJunctions?: FeatureSetProperties; /** * This provides access to the turns that are traversed while solving a network analysis layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteResult.html#traversedTurns) */ traversedTurns?: FeatureSetProperties; } export interface RouteSolveResult extends Accessor, JSONSupport { } export class RouteSolveResult { /** * An array of processing [messages](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-NAMessage.html) generated by the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteSolveResult.html#messages) */ messages: NAMessage[]; /** * An array of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) representing point barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteSolveResult.html#pointBarriers) */ pointBarriers: Graphic[]; /** * An array of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) representing polygon barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteSolveResult.html#polygonBarriers) */ polygonBarriers: Graphic[]; /** * An array of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) representing polyline barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteSolveResult.html#polylineBarriers) */ polylineBarriers: Graphic[]; /** * An array of [route results](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteResult.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteSolveResult.html#routeResults) */ routeResults: RouteResult[]; /** * The results from [route.solve()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-route.html#solve) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteSolveResult.html) */ constructor(properties?: RouteSolveResultProperties); static fromJSON(json: any): RouteSolveResult; } interface RouteSolveResultProperties { /** * An array of processing [messages](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-NAMessage.html) generated by the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteSolveResult.html#messages) */ messages?: NAMessageProperties[]; /** * An array of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) representing point barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteSolveResult.html#pointBarriers) */ pointBarriers?: GraphicProperties[]; /** * An array of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) representing polygon barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteSolveResult.html#polygonBarriers) */ polygonBarriers?: GraphicProperties[]; /** * An array of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) representing polyline barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteSolveResult.html#polylineBarriers) */ polylineBarriers?: GraphicProperties[]; /** * An array of [route results](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteResult.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteSolveResult.html#routeResults) */ routeResults?: RouteResultProperties[]; } export interface ServiceAreaParameters extends Accessor, JSONSupport, Clonable { } export class ServiceAreaParameters { /** * Use this property to specify whether the operation should accumulate values other than the value specified for [impedanceAttribute](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#impedanceAttribute). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#accumulateAttributes) */ accumulateAttributes: ( | "kilometers" | "miles" | "minutes" | "travel-time" | "truck-minutes" | "truck-travel-time" | "walk-time" | string )[]; /** * An authorization string used to access a resource or service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#apiKey) */ apiKey: string; /** * Use this property to specify additional values required by an attribute or restriction, such as to specify whether the restriction prohibits, avoids, or prefers travel on restricted roads. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#attributeParameterValues) */ attributeParameterValues: ServiceAreaParametersAttributeParameterValue[]; /** * Use this parameter to specify the size and number of service areas to generate for each facility. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#defaultBreaks) */ defaultBreaks: number[]; /** * An array of network source names to not use when generating polygons. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#excludeSourcesFromPolygons) */ excludeSourcesFromPolygons: string[]; /** * The input locations around which service areas are generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#facilities) */ facilities: DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#geometryPrecision) */ geometryPrecision: number; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#geometryPrecisionM) */ geometryPrecisionM: number; /** * Use this property to specify the number of decimal places in the response geometries returned by a solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#geometryPrecisionZ) */ geometryPrecisionZ: number; /** * Specify whether invalid input locations should be ignored when finding the best solution. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#ignoreInvalidLocations) */ ignoreInvalidLocations: boolean; /** * Specifies the impedance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#impedanceAttribute) */ impedanceAttribute: | "kilometers" | "miles" | "minutes" | "travel-time" | "truck-minutes" | "truck-travel-time" | "walk-time" | string; /** * Use this parameter to specify whether the service areas from different facilities that have the same break value should be joined together or split at break values. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#mergeSimilarPolygonRanges) */ mergeSimilarPolygonRanges: boolean; /** * Use this property to specify by how much you want to simplify the route geometry returned by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#outputGeometryPrecision) */ outputGeometryPrecision: number; /** * Use this property to specify the units for the value specified for the [outputGeometryPrecision](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#outputGeometryPrecision) parameter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#outputGeometryPrecisionUnits) */ outputGeometryPrecisionUnits: | "centimeters" | "decimal-degrees" | "decimeters" | "feet" | "inches" | "kilometers" | "meters" | "miles" | "millimeters" | "nautical-miles" | "points" | "yards"; /** * Use this property to specify the type of route features that are output by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#outputLines) */ outputLines: "none" | "straight" | "true-shape" | "true-shape-with-measure"; /** * This parameter sets whether service area polygons should be returned and to what detail. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#outputPolygons) */ outputPolygons: "none" | "simplified" | "detailed"; /** * Use this property to specify the spatial reference of the geometries, such as line or point features, returned by a solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * Specifies whether the service area lines from different facilities can overlap each other. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#overlapLines) */ overlapLines: boolean; /** * Specifies whether the service areas from different facilities can overlap each other. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#overlapPolygons) */ overlapPolygons: boolean; /** * Specify additional settings that can influence the behavior of the solver when finding solutions for the network analysis problems. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#overrides) */ overrides: any; /** * Use this property to specify one or more points that will act as temporary restrictions or represent additional time or distance that may be required to travel on the underlying streets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#pointBarriers) */ pointBarriers: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl; /** * Use this property to specify polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#polygonBarriers) */ polygonBarriers: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl; /** * Use this property to specify one or more lines that prohibit travel anywhere the lines intersect the streets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#polylineBarriers) */ polylineBarriers: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl; /** * Use this property to specify if the Object IDs specified for input locations such as stops or barriers should be preserved when the input locations are returned as output. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#preserveObjectID) */ preserveObjectID: boolean; /** * Use this property to specify which restrictions should be honored by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#restrictionAttributes) */ restrictionAttributes: ( | "any-hazmat-prohibited" | "avoid-carpool-roads" | "avoid-express-lanes" | "avoid-ferries" | "avoid-gates" | "avoid-limited-access-roads" | "avoid-private-roads" | "avoid-roads-unsuitable-for-pedestrians" | "avoid-stairways" | "avoid-toll-roads" | "avoid-toll-roads-for-trucks" | "avoid-truck-restricted-roads" | "avoid-unpaved-roads" | "axle-count-restriction" | "driving-a-bus" | "driving-a-taxi" | "driving-a-truck" | "driving-an-automobile" | "driving-an-emergency-vehicle" | "height-restriction" | "kingpin-to-rear-axle-length-restriction" | "length-restriction" | "preferred-for-pedestrians" | "riding-a-motorcycle" | "roads-under-construction-prohibited" | "semi-or-tractor-with-one-or-more-trailers-prohibited" | "single-axle-vehicles-prohibited" | "tandem-axle-vehicles-prohibited" | "through-traffic-prohibited" | "truck-with-trailers-restriction" | "use-preferred-hazmat-routes" | "use-preferred-truck-routes" | "walking" | "weight-restriction" | string )[]; /** * Specifies how U-Turns should be handled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#restrictUTurns) */ restrictUTurns: "allow-backtrack" | "at-dead-ends-only" | "no-backtrack" | "at-dead-ends-and-intersections"; /** * Determines if facilities will be returned by the service. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#returnFacilities) */ returnFacilities: boolean; /** * Specify whether [point barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#pointBarriers) will be returned by the routing operation. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#returnPointBarriers) */ returnPointBarriers: boolean; /** * Specify whether [polygon barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#polygonBarriers) will be returned by the routing operation. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#returnPolygonBarriers) */ returnPolygonBarriers: boolean; /** * Specify whether [polyline barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#polylineBarriers) will be returned by the routing operation. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#returnPolylineBarriers) */ returnPolylineBarriers: boolean; /** * Specifies whether the service area lines should be split at break values. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#splitLinesAtBreaks) */ splitLinesAtBreaks: boolean; /** * Specifies whether multiple service areas around a facility are created as disks or rings. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#splitPolygonsAtBreaks) */ splitPolygonsAtBreaks: boolean; /** * Specify the time and date to depart from or arrive at incidents or facilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#timeOfDay) */ timeOfDay: Date | "now"; /** * Specify the time zone or zones of the [timeOfDay](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#timeOfDay) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#timeOfDayIsUTC) */ timeOfDayIsUTC: boolean; /** * Specifies whether the direction of travel used to generate the service area polygons is toward or away from the facilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#travelDirection) */ travelDirection: "from-facility" | "to-facility"; /** * A travel mode represents a means of transportation, such as driving or walking. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#travelMode) */ travelMode: TravelMode; /** * Specifies whether the service areas are trimmed. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#trimOuterPolygon) */ trimOuterPolygon: boolean; /** * The property defines the distance that can be reached from the network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#trimPolygonDistance) */ trimPolygonDistance: number; /** * Specifies the units of the value specified [trimPolygonDistance](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#trimPolygonDistance). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#trimPolygonDistanceUnits) */ trimPolygonDistanceUnits: | "centimeters" | "decimal-degrees" | "decimeters" | "feet" | "inches" | "kilometers" | "meters" | "miles" | "millimeters" | "nautical-miles" | "points" | "yards"; /** * Specify whether hierarchy should be used when finding the shortest paths. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#useHierarchy) */ useHierarchy: boolean; /** * ServiceAreaParameters provides the input parameters for a [serviceArea](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-serviceArea.html) request. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html) */ constructor(properties?: ServiceAreaParametersProperties); static fromJSON(json: any): ServiceAreaParameters; } interface ServiceAreaParametersProperties { /** * Use this property to specify whether the operation should accumulate values other than the value specified for [impedanceAttribute](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#impedanceAttribute). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#accumulateAttributes) */ accumulateAttributes?: ( | "kilometers" | "miles" | "minutes" | "travel-time" | "truck-minutes" | "truck-travel-time" | "walk-time" | string )[]; /** * An authorization string used to access a resource or service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#apiKey) */ apiKey?: string; /** * Use this property to specify additional values required by an attribute or restriction, such as to specify whether the restriction prohibits, avoids, or prefers travel on restricted roads. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#attributeParameterValues) */ attributeParameterValues?: ServiceAreaParametersAttributeParameterValue[]; /** * Use this parameter to specify the size and number of service areas to generate for each facility. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#defaultBreaks) */ defaultBreaks?: number[]; /** * An array of network source names to not use when generating polygons. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#excludeSourcesFromPolygons) */ excludeSourcesFromPolygons?: string[]; /** * The input locations around which service areas are generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#facilities) */ facilities?: | (DataLayerProperties & { type: "layer" }) | FeatureSetProperties | NetworkFeatureSetProperties | NetworkUrlProperties; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#geometryPrecision) */ geometryPrecision?: number; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#geometryPrecisionM) */ geometryPrecisionM?: number; /** * Use this property to specify the number of decimal places in the response geometries returned by a solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#geometryPrecisionZ) */ geometryPrecisionZ?: number; /** * Specify whether invalid input locations should be ignored when finding the best solution. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#ignoreInvalidLocations) */ ignoreInvalidLocations?: boolean; /** * Specifies the impedance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#impedanceAttribute) */ impedanceAttribute?: | "kilometers" | "miles" | "minutes" | "travel-time" | "truck-minutes" | "truck-travel-time" | "walk-time" | string; /** * Use this parameter to specify whether the service areas from different facilities that have the same break value should be joined together or split at break values. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#mergeSimilarPolygonRanges) */ mergeSimilarPolygonRanges?: boolean; /** * Use this property to specify by how much you want to simplify the route geometry returned by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#outputGeometryPrecision) */ outputGeometryPrecision?: number; /** * Use this property to specify the units for the value specified for the [outputGeometryPrecision](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#outputGeometryPrecision) parameter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#outputGeometryPrecisionUnits) */ outputGeometryPrecisionUnits?: | "centimeters" | "decimal-degrees" | "decimeters" | "feet" | "inches" | "kilometers" | "meters" | "miles" | "millimeters" | "nautical-miles" | "points" | "yards"; /** * Use this property to specify the type of route features that are output by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#outputLines) */ outputLines?: "none" | "straight" | "true-shape" | "true-shape-with-measure"; /** * This parameter sets whether service area polygons should be returned and to what detail. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#outputPolygons) */ outputPolygons?: "none" | "simplified" | "detailed"; /** * Use this property to specify the spatial reference of the geometries, such as line or point features, returned by a solve operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; /** * Specifies whether the service area lines from different facilities can overlap each other. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#overlapLines) */ overlapLines?: boolean; /** * Specifies whether the service areas from different facilities can overlap each other. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#overlapPolygons) */ overlapPolygons?: boolean; /** * Specify additional settings that can influence the behavior of the solver when finding solutions for the network analysis problems. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#overrides) */ overrides?: any; /** * Use this property to specify one or more points that will act as temporary restrictions or represent additional time or distance that may be required to travel on the underlying streets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#pointBarriers) */ pointBarriers?: | CollectionProperties | (DataLayerProperties & { type: "layer" }) | FeatureSetProperties | NetworkFeatureSetProperties | NetworkUrlProperties; /** * Use this property to specify polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#polygonBarriers) */ polygonBarriers?: | CollectionProperties | (DataLayerProperties & { type: "layer" }) | FeatureSetProperties | NetworkFeatureSetProperties | NetworkUrlProperties; /** * Use this property to specify one or more lines that prohibit travel anywhere the lines intersect the streets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#polylineBarriers) */ polylineBarriers?: | CollectionProperties | (DataLayerProperties & { type: "layer" }) | FeatureSetProperties | NetworkFeatureSetProperties | NetworkUrlProperties; /** * Use this property to specify if the Object IDs specified for input locations such as stops or barriers should be preserved when the input locations are returned as output. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#preserveObjectID) */ preserveObjectID?: boolean; /** * Use this property to specify which restrictions should be honored by the operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#restrictionAttributes) */ restrictionAttributes?: ( | "any-hazmat-prohibited" | "avoid-carpool-roads" | "avoid-express-lanes" | "avoid-ferries" | "avoid-gates" | "avoid-limited-access-roads" | "avoid-private-roads" | "avoid-roads-unsuitable-for-pedestrians" | "avoid-stairways" | "avoid-toll-roads" | "avoid-toll-roads-for-trucks" | "avoid-truck-restricted-roads" | "avoid-unpaved-roads" | "axle-count-restriction" | "driving-a-bus" | "driving-a-taxi" | "driving-a-truck" | "driving-an-automobile" | "driving-an-emergency-vehicle" | "height-restriction" | "kingpin-to-rear-axle-length-restriction" | "length-restriction" | "preferred-for-pedestrians" | "riding-a-motorcycle" | "roads-under-construction-prohibited" | "semi-or-tractor-with-one-or-more-trailers-prohibited" | "single-axle-vehicles-prohibited" | "tandem-axle-vehicles-prohibited" | "through-traffic-prohibited" | "truck-with-trailers-restriction" | "use-preferred-hazmat-routes" | "use-preferred-truck-routes" | "walking" | "weight-restriction" | string )[]; /** * Specifies how U-Turns should be handled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#restrictUTurns) */ restrictUTurns?: "allow-backtrack" | "at-dead-ends-only" | "no-backtrack" | "at-dead-ends-and-intersections"; /** * Determines if facilities will be returned by the service. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#returnFacilities) */ returnFacilities?: boolean; /** * Specify whether [point barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#pointBarriers) will be returned by the routing operation. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#returnPointBarriers) */ returnPointBarriers?: boolean; /** * Specify whether [polygon barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#polygonBarriers) will be returned by the routing operation. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#returnPolygonBarriers) */ returnPolygonBarriers?: boolean; /** * Specify whether [polyline barriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#polylineBarriers) will be returned by the routing operation. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#returnPolylineBarriers) */ returnPolylineBarriers?: boolean; /** * Specifies whether the service area lines should be split at break values. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#splitLinesAtBreaks) */ splitLinesAtBreaks?: boolean; /** * Specifies whether multiple service areas around a facility are created as disks or rings. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#splitPolygonsAtBreaks) */ splitPolygonsAtBreaks?: boolean; /** * Specify the time and date to depart from or arrive at incidents or facilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#timeOfDay) */ timeOfDay?: DateProperties | "now"; /** * Specify the time zone or zones of the [timeOfDay](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#timeOfDay) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#timeOfDayIsUTC) */ timeOfDayIsUTC?: boolean; /** * Specifies whether the direction of travel used to generate the service area polygons is toward or away from the facilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#travelDirection) */ travelDirection?: "from-facility" | "to-facility"; /** * A travel mode represents a means of transportation, such as driving or walking. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#travelMode) */ travelMode?: TravelModeProperties; /** * Specifies whether the service areas are trimmed. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#trimOuterPolygon) */ trimOuterPolygon?: boolean; /** * The property defines the distance that can be reached from the network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#trimPolygonDistance) */ trimPolygonDistance?: number; /** * Specifies the units of the value specified [trimPolygonDistance](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#trimPolygonDistance). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#trimPolygonDistanceUnits) */ trimPolygonDistanceUnits?: | "centimeters" | "decimal-degrees" | "decimeters" | "feet" | "inches" | "kilometers" | "meters" | "miles" | "millimeters" | "nautical-miles" | "points" | "yards"; /** * Specify whether hierarchy should be used when finding the shortest paths. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#useHierarchy) */ useHierarchy?: boolean; } /** * An object describing the parameter values for the [attributeParameterValues](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#attributeParameterValues) property of [ServiceAreaParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#AttributeParameterValue) */ export interface ServiceAreaParametersAttributeParameterValue { /** * The name of the restriction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#AttributeParameterValue) */ attributeName: string; /** * The name of the parameter associated with the restriction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#AttributeParameterValue) */ parameterName: string; /** * The value for `parameterName`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html#AttributeParameterValue) */ value: string | number; } export interface ServiceAreaSolveResult extends Accessor, JSONSupport { } export class ServiceAreaSolveResult { /** * This provides access to the output facilities from a closest facility analysis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaSolveResult.html#facilities) */ facilities: FeatureSet; /** * An array of processing [messages](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-NAMessage.html) generated by the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaSolveResult.html#messages) */ messages: NAMessage[]; /** * A set of features representing point barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaSolveResult.html#pointBarriers) */ pointBarriers: FeatureSet; /** * A set of features representing polygon barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaSolveResult.html#polygonBarriers) */ polygonBarriers: FeatureSet; /** * A set of features representing polyline barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaSolveResult.html#polylineBarriers) */ polylineBarriers: FeatureSet; /** * A feature set containing polygon features that represent areas that can be reached from the input locations with a given travel time, travel distance, or travel cost. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaSolveResult.html#serviceAreaPolygons) */ serviceAreaPolygons: FeatureSet; /** * A feature set containing linear features and covers the streets, or network edges, that can be reached within the given time, distance, or other travel-cost cutoff. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaSolveResult.html#serviceAreaPolylines) */ serviceAreaPolylines: FeatureSet; /** * The result from [serviceArea](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-serviceArea.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaSolveResult.html) */ constructor(properties?: ServiceAreaSolveResultProperties); static fromJSON(json: any): ServiceAreaSolveResult; } interface ServiceAreaSolveResultProperties { /** * This provides access to the output facilities from a closest facility analysis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaSolveResult.html#facilities) */ facilities?: FeatureSetProperties; /** * An array of processing [messages](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-NAMessage.html) generated by the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaSolveResult.html#messages) */ messages?: NAMessageProperties[]; /** * A set of features representing point barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaSolveResult.html#pointBarriers) */ pointBarriers?: FeatureSetProperties; /** * A set of features representing polygon barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaSolveResult.html#polygonBarriers) */ polygonBarriers?: FeatureSetProperties; /** * A set of features representing polyline barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaSolveResult.html#polylineBarriers) */ polylineBarriers?: FeatureSetProperties; /** * A feature set containing polygon features that represent areas that can be reached from the input locations with a given travel time, travel distance, or travel cost. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaSolveResult.html#serviceAreaPolygons) */ serviceAreaPolygons?: FeatureSetProperties; /** * A feature set containing linear features and covers the streets, or network edges, that can be reached within the given time, distance, or other travel-cost cutoff. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaSolveResult.html#serviceAreaPolylines) */ serviceAreaPolylines?: FeatureSetProperties; } export interface StatisticDefinition extends Accessor, JSONSupport { } export class StatisticDefinition { /** * Defines the field for which statistics will be calculated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-StatisticDefinition.html#onStatisticField) */ onStatisticField: string; /** * Specifies the output field name for the requested statistic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-StatisticDefinition.html#outStatisticFieldName) */ outStatisticFieldName: string; /** * The parameters for [percentile statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-StatisticDefinition.html#statisticType). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-StatisticDefinition.html#statisticParameters) */ statisticParameters: StatisticDefinitionStatisticParameters; /** * Defines the type of statistic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-StatisticDefinition.html#statisticType) */ statisticType: | "count" | "sum" | "min" | "max" | "avg" | "stddev" | "var" | "percentile-continuous" | "percentile-discrete" | "envelope-aggregate" | "centroid-aggregate" | "convex-hull-aggregate"; /** * This class defines the parameters for querying a layer or layer view for statistics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-StatisticDefinition.html) */ constructor(properties?: StatisticDefinitionProperties); /** * Creates a deep clone of StatisticDefinition object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-StatisticDefinition.html#clone) */ clone(): StatisticDefinition; static fromJSON(json: any): StatisticDefinition; } interface StatisticDefinitionProperties { /** * Defines the field for which statistics will be calculated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-StatisticDefinition.html#onStatisticField) */ onStatisticField?: string; /** * Specifies the output field name for the requested statistic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-StatisticDefinition.html#outStatisticFieldName) */ outStatisticFieldName?: string; /** * The parameters for [percentile statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-StatisticDefinition.html#statisticType). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-StatisticDefinition.html#statisticParameters) */ statisticParameters?: StatisticDefinitionStatisticParameters; /** * Defines the type of statistic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-StatisticDefinition.html#statisticType) */ statisticType?: | "count" | "sum" | "min" | "max" | "avg" | "stddev" | "var" | "percentile-continuous" | "percentile-discrete" | "envelope-aggregate" | "centroid-aggregate" | "convex-hull-aggregate"; } export interface StatisticDefinitionStatisticParameters { /** * Percentile value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-StatisticDefinition.html#statisticParameters) */ value: number; /** * Specify `ASC` (ascending) or `DESC` (descending) to control the order of the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-StatisticDefinition.html#statisticParameters) */ orderBy?: "ASC" | "DESC"; } export interface Stop extends Accessor, JSONSupport { } export class Stop { /** * The date and time value indicating the arrival time at the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#arriveTime) */ arriveTime: Date; /** * The local time offset (in minutes) for the arrival time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#arriveTimeOffset) */ arriveTimeOffset: number; /** * Specify the direction a vehicle may arrive at and depart from the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#curbApproach) */ curbApproach: "either-side-of-vehicle" | "right-side-of-vehicle" | "left-side-of-vehicle" | "no-u-turn"; /** * The date and time value indicating the departure time from the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#departTime) */ departTime: Date; /** * The local time offset in minutes for the departure time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#departTimeOffset) */ departTimeOffset: number; /** * The point location of the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#geometry) */ geometry: Point; locationType: "stop" | "waypoint" | "break"; /** * The name of the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#name) */ name: string; /** * If the findBestSequence parameter is set to false, the output routes will visit the stops in the order you specify with this attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#sequence) */ sequence: number; /** * Indicates the status of the point with respect to its location on the network and the outcome of the analysis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#status) */ status: | "ok" | "not-located" | "network-element-not-located" | "element-not-traversable" | "invalid-field-values" | "not-reached" | "time-window-violation" | "not-located-on-closest"; /** * The latest time the route can visit the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#timeWindowEnd) */ timeWindowEnd: Date; /** * The earliest time the route can visit the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#timeWindowStart) */ timeWindowStart: Date; readonly type: "stop"; /** * A stop respresents the start, end, or midpoint of a route in [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#stops) or [RouteParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#stops). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html) */ constructor(properties?: StopProperties); /** * Creates a [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) from the [Stop](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html) instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#toGraphic) */ toGraphic(): Graphic; /** * Creates a [Stop](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html) from the parsed [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#fromGraphic) */ static fromGraphic(graphic?: Graphic): Stop; static fromJSON(json: any): Stop; } interface StopProperties { /** * The date and time value indicating the arrival time at the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#arriveTime) */ arriveTime?: DateProperties; /** * The local time offset (in minutes) for the arrival time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#arriveTimeOffset) */ arriveTimeOffset?: number; /** * Specify the direction a vehicle may arrive at and depart from the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#curbApproach) */ curbApproach?: "either-side-of-vehicle" | "right-side-of-vehicle" | "left-side-of-vehicle" | "no-u-turn"; /** * The date and time value indicating the departure time from the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#departTime) */ departTime?: DateProperties; /** * The local time offset in minutes for the departure time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#departTimeOffset) */ departTimeOffset?: number; /** * The point location of the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#geometry) */ geometry?: PointProperties; locationType?: "stop" | "waypoint" | "break"; /** * The name of the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#name) */ name?: string; /** * If the findBestSequence parameter is set to false, the output routes will visit the stops in the order you specify with this attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#sequence) */ sequence?: number; /** * Indicates the status of the point with respect to its location on the network and the outcome of the analysis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#status) */ status?: | "ok" | "not-located" | "network-element-not-located" | "element-not-traversable" | "invalid-field-values" | "not-reached" | "time-window-violation" | "not-located-on-closest"; /** * The latest time the route can visit the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#timeWindowEnd) */ timeWindowEnd?: DateProperties; /** * The earliest time the route can visit the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Stop.html#timeWindowStart) */ timeWindowStart?: DateProperties; } export interface TopFeaturesQuery extends Accessor, JSONSupport { } export class TopFeaturesQuery { /** * Indicates if the service should cache the query results. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#cacheHint) */ cacheHint: boolean; /** * Specifies a search distance from a given [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#geometry) in a spatial query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#distance) */ distance: number; /** * The geometry to apply to the spatial filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#geometry) */ geometry: Geometry; /** * Specifies the number of decimal places for geometries returned by the query operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#geometryPrecision) */ geometryPrecision: number; /** * The maximum distance in units of [outSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#outSpatialReference) used for generalizing geometries returned by the query operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#maxAllowableOffset) */ maxAllowableOffset: number; /** * The number of features to retrieve. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#num) */ num: number; /** * An array of ObjectIDs to be used to query for features in a layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#objectIds) */ objectIds: number[]; /** * One or more field names used to order the query results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#orderByFields) */ orderByFields: string[]; /** * Attribute fields to include in the [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#outFields) */ outFields: string[]; /** * The spatial reference for the returned geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * If `true`, each feature in the returned [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html) includes the geometry. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#returnGeometry) */ returnGeometry: boolean; /** * If `true`, and [returnGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#returnGeometry) is `true`, then m-values are included in the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#returnM) */ returnM: boolean; /** * If `true`, and [returnGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#returnGeometry) is `true`, then z-values are included in the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#returnZ) */ returnZ: boolean; /** * For spatial queries, this parameter defines the spatial relationship to query features in the layer or layer view against the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#geometry). * * @default intersects * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#spatialRelationship) */ spatialRelationship: | "intersects" | "contains" | "crosses" | "envelope-intersects" | "index-intersects" | "overlaps" | "touches" | "within" | "relation"; /** * The zero-based index indicating where to begin retrieving features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#start) */ start: number; /** * A time extent for a temporal query against [time-aware layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#timeInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#timeExtent) */ timeExtent: TimeExtent; /** * The `topFilter` parameter is used to set the [groupByFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFilter.html#groupByFields), [orderByFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFilter.html#orderByFields), and [topCount](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFilter.html#topCount) criteria used in generating the result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#topFilter) */ topFilter: TopFilter; /** * The unit for calculating the buffer distance when [distance](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#distance) is specified in spatial queries. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#units) */ units: "feet" | "miles" | "nautical-miles" | "us-nautical-miles" | "meters" | "kilometers"; /** * A where clause for the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#where) */ where: string; /** * This class defines parameters for executing [top features queries](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryTopFeatures) from a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html) */ constructor(properties?: TopFeaturesQueryProperties); /** * Creates a deep clone of TopFeaturesQuery object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#clone) */ clone(): TopFeaturesQuery; static fromJSON(json: any): TopFeaturesQuery; } interface TopFeaturesQueryProperties { /** * Indicates if the service should cache the query results. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#cacheHint) */ cacheHint?: boolean; /** * Specifies a search distance from a given [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#geometry) in a spatial query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#distance) */ distance?: number; /** * The geometry to apply to the spatial filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#geometry) */ geometry?: GeometryProperties; /** * Specifies the number of decimal places for geometries returned by the query operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#geometryPrecision) */ geometryPrecision?: number; /** * The maximum distance in units of [outSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#outSpatialReference) used for generalizing geometries returned by the query operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#maxAllowableOffset) */ maxAllowableOffset?: number; /** * The number of features to retrieve. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#num) */ num?: number; /** * An array of ObjectIDs to be used to query for features in a layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#objectIds) */ objectIds?: number[]; /** * One or more field names used to order the query results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#orderByFields) */ orderByFields?: string[]; /** * Attribute fields to include in the [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#outFields) */ outFields?: string[]; /** * The spatial reference for the returned geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; /** * If `true`, each feature in the returned [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html) includes the geometry. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#returnGeometry) */ returnGeometry?: boolean; /** * If `true`, and [returnGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#returnGeometry) is `true`, then m-values are included in the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#returnM) */ returnM?: boolean; /** * If `true`, and [returnGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#returnGeometry) is `true`, then z-values are included in the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#returnZ) */ returnZ?: boolean; /** * For spatial queries, this parameter defines the spatial relationship to query features in the layer or layer view against the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#geometry). * * @default intersects * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#spatialRelationship) */ spatialRelationship?: | "intersects" | "contains" | "crosses" | "envelope-intersects" | "index-intersects" | "overlaps" | "touches" | "within" | "relation"; /** * The zero-based index indicating where to begin retrieving features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#start) */ start?: number; /** * A time extent for a temporal query against [time-aware layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#timeInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#timeExtent) */ timeExtent?: TimeExtentProperties; /** * The `topFilter` parameter is used to set the [groupByFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFilter.html#groupByFields), [orderByFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFilter.html#orderByFields), and [topCount](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFilter.html#topCount) criteria used in generating the result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#topFilter) */ topFilter?: TopFilterProperties; /** * The unit for calculating the buffer distance when [distance](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#distance) is specified in spatial queries. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#units) */ units?: "feet" | "miles" | "nautical-miles" | "us-nautical-miles" | "meters" | "kilometers"; /** * A where clause for the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFeaturesQuery.html#where) */ where?: string; } export interface TopFilter extends Accessor, JSONSupport { } export class TopFilter { /** * When one or more field names are provided in this property, the output result will be grouped based on unique values from those fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFilter.html#groupByFields) */ groupByFields: string[]; /** * One or more field names used to order the query results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFilter.html#orderByFields) */ orderByFields: string[]; /** * Defines the number of features to be returned from the top features query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFilter.html#topCount) */ topCount: number; /** * This class defines the top filter parameters for executing top features queries for features from a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFilter.html) */ constructor(properties?: TopFilterProperties); /** * Creates a deep clone of TopFilter object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFilter.html#clone) */ clone(): TopFilter; static fromJSON(json: any): TopFilter; } interface TopFilterProperties { /** * When one or more field names are provided in this property, the output result will be grouped based on unique values from those fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFilter.html#groupByFields) */ groupByFields?: string[]; /** * One or more field names used to order the query results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFilter.html#orderByFields) */ orderByFields?: string[]; /** * Defines the number of features to be returned from the top features query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TopFilter.html#topCount) */ topCount?: number; } export interface TravelMode extends Accessor, JSONSupport, Clonable { } export class TravelMode { /** * Lists the parameterized attributes used by the travel mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#attributeParameterValues) */ attributeParameterValues: TravelModeAttributeParameterValues[]; /** * A short text description of the travel mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#description) */ description: string; /** * Indicates the distance-based cost attribute for reporting directions and for solving vehicle routing problems. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#distanceAttributeName) */ distanceAttributeName: "kilometers" | "miles" | "meters" | string; /** * The unique identifier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#id) */ id: string; /** * The network cost attribute used as impedance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#impedanceAttributeName) */ impedanceAttributeName: | "kilometers" | "miles" | "meters" | "minutes" | "travel-time" | "truck-minutes" | "truck-travel-time" | "walk-time" | string; /** * The unique name of the travel mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#name) */ name: string; /** * The list of the restriction attributes used when solving network analysis problems with this travel mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#restrictionAttributeNames) */ restrictionAttributeNames: ( | "any-hazmat-prohibited" | "avoid-carpool-roads" | "avoid-express-lanes" | "avoid-ferries" | "avoid-gates" | "avoid-limited-access-roads" | "avoid-private-roads" | "avoid-roads-unsuitable-for-pedestrians" | "avoid-stairways" | "avoid-toll-roads" | "avoid-toll-roads-for-trucks" | "avoid-truck-restricted-roads" | "avoid-unpaved-roads" | "axle-count-restriction" | "driving-a-bus" | "driving-a-taxi" | "driving-a-truck" | "driving-an-automobile" | "driving-an-emergency-vehicle" | "height-restriction" | "kingpin-to-rear-axle-length-restriction" | "length-restriction" | "preferred-for-pedestrians" | "riding-a-motorcycle" | "roads-under-construction-prohibited" | "semi-or-tractor-with-one-or-more-trailers-prohibited" | "single-axle-vehicles-prohibited" | "tandem-axle-vehicles-prohibited" | "through-traffic-prohibited" | "truck-with-trailers-restriction" | "use-preferred-hazmat-routes" | "use-preferred-truck-routes" | "walking" | "weight-restriction" | string )[]; /** * Specifies whether the travel mode generalizes the geometry of analysis results and by how much. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#simplificationTolerance) */ simplificationTolerance: number; /** * The linear units associated with [simplificationTolerance](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#simplificationTolerance). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#simplificationToleranceUnits) */ simplificationToleranceUnits: | "centimeters" | "decimal-degrees" | "decimeters" | "feet" | "inches" | "kilometers" | "meters" | "miles" | "millimeters" | "nautical-miles" | "points" | "unknown" | "yards"; /** * Indicates the time-based cost attribute for reporting directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#timeAttributeName) */ timeAttributeName: "minutes" | "travel-time" | "truck-minutes" | "truck-travel-time" | "walk-time" | string; /** * Indicates the category of travel or vehicle represented by this travel mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#type) */ type: "automobile" | "truck" | "walk" | "other"; /** * Indicates whether the travel mode uses a hierarchy attribute while performing the analysis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#useHierarchy) */ useHierarchy: boolean; /** * Indicates how the U-turns at junctions that could occur during network traversal are handled by the solver. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#uturnAtJunctions) */ uturnAtJunctions: "allow-backtrack" | "at-dead-ends-only" | "no-backtrack" | "at-dead-ends-and-intersections"; /** * A TravelMode is a set of characteristics that define how an object like a vehicle, bicycle, or pedestrian moves along a street network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html) */ constructor(properties?: TravelModeProperties); static fromJSON(json: any): TravelMode; } interface TravelModeProperties { /** * Lists the parameterized attributes used by the travel mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#attributeParameterValues) */ attributeParameterValues?: TravelModeAttributeParameterValues[]; /** * A short text description of the travel mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#description) */ description?: string; /** * Indicates the distance-based cost attribute for reporting directions and for solving vehicle routing problems. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#distanceAttributeName) */ distanceAttributeName?: "kilometers" | "miles" | "meters" | string; /** * The unique identifier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#id) */ id?: string; /** * The network cost attribute used as impedance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#impedanceAttributeName) */ impedanceAttributeName?: | "kilometers" | "miles" | "meters" | "minutes" | "travel-time" | "truck-minutes" | "truck-travel-time" | "walk-time" | string; /** * The unique name of the travel mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#name) */ name?: string; /** * The list of the restriction attributes used when solving network analysis problems with this travel mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#restrictionAttributeNames) */ restrictionAttributeNames?: ( | "any-hazmat-prohibited" | "avoid-carpool-roads" | "avoid-express-lanes" | "avoid-ferries" | "avoid-gates" | "avoid-limited-access-roads" | "avoid-private-roads" | "avoid-roads-unsuitable-for-pedestrians" | "avoid-stairways" | "avoid-toll-roads" | "avoid-toll-roads-for-trucks" | "avoid-truck-restricted-roads" | "avoid-unpaved-roads" | "axle-count-restriction" | "driving-a-bus" | "driving-a-taxi" | "driving-a-truck" | "driving-an-automobile" | "driving-an-emergency-vehicle" | "height-restriction" | "kingpin-to-rear-axle-length-restriction" | "length-restriction" | "preferred-for-pedestrians" | "riding-a-motorcycle" | "roads-under-construction-prohibited" | "semi-or-tractor-with-one-or-more-trailers-prohibited" | "single-axle-vehicles-prohibited" | "tandem-axle-vehicles-prohibited" | "through-traffic-prohibited" | "truck-with-trailers-restriction" | "use-preferred-hazmat-routes" | "use-preferred-truck-routes" | "walking" | "weight-restriction" | string )[]; /** * Specifies whether the travel mode generalizes the geometry of analysis results and by how much. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#simplificationTolerance) */ simplificationTolerance?: number; /** * The linear units associated with [simplificationTolerance](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#simplificationTolerance). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#simplificationToleranceUnits) */ simplificationToleranceUnits?: | "centimeters" | "decimal-degrees" | "decimeters" | "feet" | "inches" | "kilometers" | "meters" | "miles" | "millimeters" | "nautical-miles" | "points" | "unknown" | "yards"; /** * Indicates the time-based cost attribute for reporting directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#timeAttributeName) */ timeAttributeName?: "minutes" | "travel-time" | "truck-minutes" | "truck-travel-time" | "walk-time" | string; /** * Indicates the category of travel or vehicle represented by this travel mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#type) */ type?: "automobile" | "truck" | "walk" | "other"; /** * Indicates whether the travel mode uses a hierarchy attribute while performing the analysis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#useHierarchy) */ useHierarchy?: boolean; /** * Indicates how the U-turns at junctions that could occur during network traversal are handled by the solver. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#uturnAtJunctions) */ uturnAtJunctions?: "allow-backtrack" | "at-dead-ends-only" | "no-backtrack" | "at-dead-ends-and-intersections"; } export interface TravelModeAttributeParameterValues { /** * The name of the attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#attributeParameterValues) */ attributeName: string; /** * The parameter name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#attributeParameterValues) */ parameterName: string; /** * The parameter value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html#attributeParameterValues) */ value: string; } export interface TrimExtendParameters extends Accessor, JSONSupport { } export class TrimExtendParameters { /** * A flag used with the `trimExtend` operation. * * @default "default-curve-extension" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TrimExtendParameters.html#extendHow) */ extendHow: | "default-curve-extension" | "relocate-ends" | "keep-end-attributes" | "no-end-attributes" | "no-extend-at-from" | "no-extend-at-to"; /** * The array of polylines to trim or extend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TrimExtendParameters.html#polylines) */ polylines: Polyline[]; /** * A polyline used as a guide for trimming or extending input polylines. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TrimExtendParameters.html#trimExtendTo) */ trimExtendTo: Polyline; /** * Used to set the parameters for the [geometryService.trimExtend](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#trimExtend) operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TrimExtendParameters.html) */ constructor(properties?: TrimExtendParametersProperties); static fromJSON(json: any): TrimExtendParameters; } interface TrimExtendParametersProperties { /** * A flag used with the `trimExtend` operation. * * @default "default-curve-extension" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TrimExtendParameters.html#extendHow) */ extendHow?: | "default-curve-extension" | "relocate-ends" | "keep-end-attributes" | "no-end-attributes" | "no-extend-at-from" | "no-extend-at-to"; /** * The array of polylines to trim or extend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TrimExtendParameters.html#polylines) */ polylines?: PolylineProperties[]; /** * A polyline used as a guide for trimming or extending input polylines. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TrimExtendParameters.html#trimExtendTo) */ trimExtendTo?: PolylineProperties; } /** * Represents [symbol service](https://developers.arcgis.com/rest/services-reference/enterprise/symbol-server.htm) resources exposed by the ArcGIS REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-symbolService.html) */ interface symbolService { /** * Converts a [Scalable Vector Graphic](https://pro.arcgis.com/en/pro-app/latest/help/mapping/layer-properties/scalable-vector-graphics-support.htm) (SVG) to a [CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-symbolService.html#generateSymbol) */ generateSymbol(url: string, params: GenerateSymbolParameters, requestOptions?: RequestOptions): Promise; } export const symbolService: symbolService; /** * Input parameters for the [generateSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-symbolService.html#generateSymbol) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-symbolService.html#GenerateSymbolParameters) */ export interface GenerateSymbolParameters { /** * The SVG image to convert. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-symbolService.html#GenerateSymbolParameters) */ svgImage?: string | FormData | HTMLFormElement; } /** * The response of the [generateSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-symbolService.html#generateSymbol) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-symbolService.html#GenerateSymbolResponse) */ export interface GenerateSymbolResponse { /** * The CIMSymbol created from the [generateSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-symbolService.html#generateSymbol) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-symbolService.html#GenerateSymbolResponse) */ symbol: CIMSymbol; } /** * Function that suggests a [fixedBinLevel](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#fixedBinLevel) in a [FeatureReductionBinning](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html) visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-heuristics-binLevel.html) */ interface binLevel { /** * Generates a suggested [fixedBinLevel](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#fixedBinLevel) for a binning visualization based on the view scale at the time this method is called. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-heuristics-binLevel.html#binLevel) */ binLevel(params: binLevelBinLevelParams): Promise; } export const binLevel: binLevel; export interface binLevelBinLevelParams { /** * The [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) where the layer will be rendered. * * [Read more...](global.html) */ view: MapView; } /** * Function for determining suggested [min](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#minScale) and [max](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#maxScale) scale ranges for an input layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-heuristics-scaleRange.html) */ interface scaleRange { /** * Generates a suggested scale range (i.e. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-heuristics-scaleRange.html#scaleRange) */ scaleRange(params: scaleRangeScaleRangeParams): Promise; } const __scaleRangeMapped: scaleRange; export const scaleRange: typeof __scaleRangeMapped.scaleRange; /** * Suggested `min` and `max` scales to apply to the input layer for the [scaleRange()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-heuristics-scaleRange.html#scaleRange) function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-heuristics-scaleRange.html#ScaleRangeResult) */ export interface ScaleRangeResult { /** * The suggested [minScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#minScale) to apply to the input layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-heuristics-scaleRange.html#ScaleRangeResult) */ minScale: number; /** * The suggested [maxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#maxScale) to apply to the input layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-heuristics-scaleRange.html#ScaleRangeResult) */ maxScale: number; } export interface scaleRangeScaleRangeParams { /** * The layer for which to generate a suggested min/max scale range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-heuristics-scaleRange.html#scaleRange) */ layer: | FeatureLayer | SceneLayer | CSVLayer | OGCFeatureLayer | PointCloudLayer | GeoJSONLayer | WFSLayer | StreamLayer | OrientedImageryLayer; /** * The [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) where the layer will be rendered. * * [Read more...](global.html) */ view: View; /** * The number of features in the `layer` to sample for spatial statistics. * * @default 500 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-heuristics-scaleRange.html#scaleRange) */ sampleSize?: number; /** * Indicates whether the generated renderer is for a binning visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-heuristics-scaleRange.html#scaleRange) */ forBinning?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-heuristics-scaleRange.html#scaleRange) */ signal?: AbortSignal; } /** * Function for determining the suggested `minSize` and `maxSize` of a [scale-dependent size visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#ScaleDependentIcons). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-heuristics-sizeRange.html) */ interface sizeRange { /** * Generates a suggested size range (i.e. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-heuristics-sizeRange.html#sizeRange) */ sizeRange(params: sizeRangeSizeRangeParams): Promise; } const __sizeRangeMapped: sizeRange; export const sizeRange: typeof __sizeRangeMapped.sizeRange; /** * The suggested `minSize` and `maxSize` [size stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#ScaleDependentStops) generated from the [sizeRange()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-heuristics-sizeRange.html#sizeRange) function to apply to the [scale-dependent size visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#ScaleDependentIcons). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-heuristics-sizeRange.html#SizeRangeResult) */ export interface SizeRangeResult { /** * The suggested sizes of the smallest symbols at various scales in a layer with a [size visualization](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-heuristics-sizeRange.html#SizeRangeResult) */ minSize: ScaleDependentStops; /** * The suggested sizes of the largest symbols at various scales in a layer with a [size visualization](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-heuristics-sizeRange.html#SizeRangeResult) */ maxSize: ScaleDependentStops; } export interface sizeRangeSizeRangeParams { /** * The layer for which to generate a suggested min/max size range based on scale for a size visual variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-heuristics-sizeRange.html#sizeRange) */ layer: | FeatureLayer | SceneLayer | CSVLayer | OGCFeatureLayer | PointCloudLayer | GeoJSONLayer | WFSLayer | StreamLayer | OrientedImageryLayer; /** * The [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) where the layer will be rendered. * * [Read more...](global.html) */ view: MapView; /** * Indicates whether the generated renderer is for a binning visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-heuristics-sizeRange.html#sizeRange) */ forBinning?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-heuristics-sizeRange.html#sizeRange) */ signal?: AbortSignal; } /** * This object contains a helper method for generating default labels to be set on a layer's [binning configuration](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#labelingInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-bins.html) */ interface bins { /** * Generates default [labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#labelingInfo) schemes to be set on a FeatureLayer's [featureReduction](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#featureReduction) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-bins.html#getLabelSchemes) */ getLabelSchemes(params: binsGetLabelSchemesParams): Promise; } export const bins: bins; export interface binsGetLabelSchemesParams { /** * The point layer that has or will have binning enabled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-bins.html#getLabelSchemes) */ layer: FeatureLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The name of the [AggregateField](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#name) to use in the primary label scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-bins.html#getLabelSchemes) */ field?: string; /** * The renderer to set on `layer.featureReduction.renderer` when binning is enabled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-bins.html#getLabelSchemes) */ renderer?: Renderer; } /** * Contains suggested labelingInfo to be set on the layer's [featureReduction.labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#labelingInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-bins.html#Scheme) */ export interface Scheme { /** * The name of the generated binning labeling scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-bins.html#Scheme) */ name: string; /** * The name of the aggregate field used in the labeling scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-bins.html#Scheme) */ fieldName: string; /** * An array of LabelClass objects to set on the layer's [featureReduction.labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#labelingInfo) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-bins.html#Scheme) */ labelingInfo: LabelClass[]; } /** * The return object of the [getLabelSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-bins.html#getLabelSchemes) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-bins.html#Schemes) */ export interface Schemes { /** * Includes the primary labeling scheme suggested for the input layer's bins. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-bins.html#Schemes) */ primaryScheme: Scheme; /** * Includes secondary labeling schemes suggested for the input layer's bins. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-bins.html#Schemes) */ secondarySchemes: Scheme[]; } /** * This object contains a helper method for generating default labels to be set on a layer's [cluster configuration](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#labelingInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-clusters.html) */ interface clusters { /** * Generates default [labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#labelingInfo) schemes to be set on a FeatureLayer's [featureReduction](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#featureReduction) configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-clusters.html#getLabelSchemes) */ getLabelSchemes(params: clustersGetLabelSchemesParams): Promise; } export const clusters: clusters; export interface clustersGetLabelSchemesParams { /** * The point layer that has or will have clustering enabled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-clusters.html#getLabelSchemes) */ layer: FeatureLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The view where the input layer will be rendered. * * [Read more...](global.html) */ view: MapView; /** * The name of the [AggregateField](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#name) to use in the primary label scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-clusters.html#getLabelSchemes) */ field?: string; /** * The renderer to set on the input layer when clustering is enabled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-clusters.html#getLabelSchemes) */ renderer?: Renderer; } /** * Contains a suggested labelingInfo to be set on the layer's [featureReduction.labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#labelingInfo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-clusters.html#Scheme) */ export interface clustersScheme { /** * The name of the generated cluster labeling scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-clusters.html#Scheme) */ name: string; /** * The name of the aggregate field the labeling scheme is based on. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-clusters.html#Scheme) */ fieldName: string; /** * An array of LabelClass objects to set on the layer's [featureReduction.labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#labelingInfo) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-clusters.html#Scheme) */ labelingInfo: LabelClass[]; /** * The suggested [featureReduction.clusterMinSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterMinSize) required to fit labels within clusters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-clusters.html#Scheme) */ clusterMinSize: number; } /** * The return object of the [getLabelSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-clusters.html#getLabelSchemes) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-clusters.html#Schemes) */ export interface clustersSchemes { /** * Includes the primary labeling scheme suggested for the input layer's clusters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-clusters.html#Schemes) */ primaryScheme: clustersScheme; /** * Includes secondary labeling schemes suggested for the input layer's clusters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-clusters.html#Schemes) */ secondarySchemes: clustersScheme[]; } /** * This object contains helper methods for generating popup templates to be set on a layer's [FeatureReductionCluster](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupTemplate). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-popup-clusters.html) */ interface popupClusters { /** * Returns one or more suggested default [popupTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) for a given layer's [FeatureReductionCluster](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupTemplate) configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-popup-clusters.html#getTemplates) */ getTemplates(params: clustersGetTemplatesParams): Promise; } export const popupClusters: popupClusters; export interface clustersGetTemplatesParams { /** * The point layer that is or will be clustered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-popup-clusters.html#getTemplates) */ layer: FeatureLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * Specify the renderer to be used on the layer when `featureReduction` is enabled if it will be different than the renderer already set on the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-popup-clusters.html#getTemplates) */ renderer?: Renderer; } /** * This object contains helper methods for generating popup templates to be set on a [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#popupTemplate). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-popup-templates.html) */ interface templates { /** * Returns one or more suggested [popupTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) for a given layer based on its renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-popup-templates.html#getTemplates) */ getTemplates(params: templatesGetTemplatesParams): Promise; } export const templates: templates; /** * Defines a suggested PopupTemplate with a given name and title describing the content and purpose of the PopupTemplate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-popup-templates.html#Template) */ export interface Template { /** * The name of the auto-generated PopupTemplate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-popup-templates.html#Template) */ name: string; /** * The title of the PopupTemplate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-popup-templates.html#Template) */ title: string; /** * The suggested PopupTemplate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-popup-templates.html#Template) */ value: PopupTemplate; } /** * The return object of the [getTemplates()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-popup-templates.html#getTemplates) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-popup-templates.html#Templates) */ export interface Templates { /** * Includes the primary PopupTemplate suggested for the input layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-popup-templates.html#Templates) */ primaryTemplate: Template; /** * Includes secondary PopupTemplates that may be applied to the input layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-popup-templates.html#Templates) */ secondaryTemplates: Template[]; } export interface templatesGetTemplatesParams { /** * The layer to which the suggested popup templates can be applied. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-popup-templates.html#getTemplates) */ layer: FeatureLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * Specify the renderer to be used on the layer when if it will be different than the renderer already set on the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-popup-templates.html#getTemplates) */ renderer?: Renderer; } /** * This object contains helper methods for generating class breaks visualizations for raster layers (i.e. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-classBreaks.html) */ interface classBreaks { /** * Generates a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html) used to render imagery data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-classBreaks.html#createRenderer) */ createRenderer(params: classBreaksCreateRendererParams): Promise; } export const classBreaks: classBreaks; export interface classBreaksCreateRendererParams { /** * The input layer for which the renderer is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-classBreaks.html#createRenderer) */ layer: ImageryLayer | ImageryTileLayer | WCSLayer; /** * Deprecated since 4.27. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-classBreaks.html#createRenderer) */ renderingRule?: RasterFunction; /** * Specifies the function for how the requested image should be processed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-classBreaks.html#createRenderer) */ rasterFunction?: RasterFunction; /** * The field whose data will be used in the classification. * * @default value * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-classBreaks.html#createRenderer) */ field?: string; /** * The classification method used for generating breaks. * * @default natural-breaks * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-classBreaks.html#createRenderer) */ classificationMethod?: "equal-interval" | "natural-breaks" | "quantile" | "standard-deviation" | "defined-interval"; /** * Only applicable to multidimensional datasets where a raster layer can contain more than one variable (such as temperature, humidity, wind speed) with different statistics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-classBreaks.html#createRenderer) */ variableName?: string; /** * The number of class breaks to generate for the classification. * * @default 5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-classBreaks.html#createRenderer) */ numClasses?: number; /** * The color ramp to apply to the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-classBreaks.html#createRenderer) */ colorRamp?: AlgorithmicColorRamp | MultipartColorRamp; /** * The colors to apply to each class break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-classBreaks.html#createRenderer) */ colors?: number[][]; /** * Only applicable when `classificationMethod` is `defined-interval`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-classBreaks.html#createRenderer) */ definedInterval?: number; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-classBreaks.html#createRenderer) */ signal?: AbortSignal; } /** * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-classBreaks.html#createRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-classBreaks.html#RasterClassBreaksResult) */ export interface RasterClassBreaksResult { /** * The renderer object configured to best match the given basemap and the spread of the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-classBreaks.html#RasterClassBreaksResult) */ renderer: ClassBreaksRenderer; /** * This object describes class breaks generated from data in a layer for a given field with a specified classification method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-classBreaks.html#RasterClassBreaksResult) */ classBreaksResult: ClassBreaksResult; } /** * This object contains helper methods for generating a [RasterColormapRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterColormapRenderer.html) for raster layers (i.e. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-colormap.html) */ interface colormap { /** * Generates a [RasterColormapRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterColormapRenderer.html) used to render imagery data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-colormap.html#createRenderer) */ createRenderer(params: colormapCreateRendererParams): Promise; } export const colormap: colormap; export interface colormapCreateRendererParams { /** * The input layer for which the renderer is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-colormap.html#createRenderer) */ layer: ImageryLayer | ImageryTileLayer; /** * Deprecated since 4.27. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-colormap.html#createRenderer) */ renderingRule?: RasterFunction; /** * Specifies the function for how the requested image should be processed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-colormap.html#createRenderer) */ rasterFunction?: RasterFunction; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-colormap.html#createRenderer) */ signal?: AbortSignal; } /** * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-colormap.html#createRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-colormap.html#RasterColormapResult) */ export interface RasterColormapResult { /** * The colormap renderer to apply to the input layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-colormap.html#RasterColormapResult) */ renderer: RasterColormapRenderer; } /** * This object contains helper methods for generating a [FlowRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html) for a `Vector-UV` or `Vector-MagDir` [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html) or [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html) */ interface flow { /** * Generates a [FlowRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html) to display raster data with stream lines. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#createRenderer) */ createRenderer(params: flowCreateRendererParams): Promise; } export const flow: flow; export interface flowCreateRendererParams { /** * The input layer for which the renderer is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#createRenderer) */ layer: ImageryLayer | ImageryTileLayer; /** * The view where the input layer is rendered. * * [Read more...](global.html) */ view?: MapView; /** * Determines how flow lines will render. * * @default "flow-line" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#createRenderer) */ theme?: "flow-line" | "wave-front"; /** * When `true`, the color of stream lines will vary depending on the magnitude of the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#createRenderer) */ includeColorVariable?: boolean; /** * When `true`, the width of stream lines will vary depending on the magnitude of the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#createRenderer) */ includeSizeVariable?: boolean; /** * When `true`, the opacity of stream lines will vary depending on the magnitude of the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#createRenderer) */ includeOpacityVariable?: boolean; /** * Provides options for setting a title to the renderer in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#createRenderer) */ legendOptions?: flowCreateRendererParamsLegendOptions; /** * The flow scheme used to set colors and sizes to the flow lines. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#createRenderer) */ flowScheme?: FlowScheme; /** * Deprecated since 4.27. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#createRenderer) */ renderingRule?: RasterFunction; /** * Specifies the function for how the requested image should be processed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#createRenderer) */ rasterFunction?: RasterFunction; /** * Defines the flow direction of the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#createRenderer) */ flowRepresentation?: "flow-from" | "flow-to"; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#createRenderer) */ signal?: AbortSignal; } export interface flowCreateRendererParamsLegendOptions { /** * The title used to represent the data in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#createRenderer) */ title?: string; } /** * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#createRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#FlowRendererResult) */ export interface FlowRendererResult { /** * The FlowRenderer renderer to apply to the input layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#FlowRendererResult) */ renderer: FlowRenderer; /** * The flow scheme used to set colors and sizes to the flow lines. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#FlowRendererResult) */ flowScheme: FlowScheme; /** * Visual variables included in the output renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#FlowRendererResult) */ visualVariables: VisualVariable[]; /** * Summary statistics of the raster layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#FlowRendererResult) */ statistics: SummaryStatisticsResult; /** * The ID of the basemap used to determine the optimal color of the flow lines. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#FlowRendererResult) */ basemapId: string; /** * Indicates whether the average color of the input view's basemap is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#FlowRendererResult) */ basemapTheme: string; /** * A suggested layer effect to apply to the input layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#FlowRendererResult) */ layerEffect: string; } /** * This object contains helper methods for generating an RGB [stretch visualization](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html) for raster layers (i.e. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-rgb.html) */ interface rgb { /** * Generates an RGB [RasterStretchRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html) to render three selected bands into red, green, and blue color channels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-rgb.html#createRenderer) */ createRenderer(params: rgbCreateRendererParams): Promise; } export const rgb: rgb; /** * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-rgb.html#createRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-rgb.html#RasterRGBResult) */ export interface RasterRGBResult { /** * The RGB RasterStretchRenderer renderer to apply to the input layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-rgb.html#RasterRGBResult) */ renderer: RasterStretchRenderer; /** * The RGB band indexes following the order of red, green, and blue channels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-rgb.html#RasterRGBResult) */ rgbBandIds: number[]; } export interface rgbCreateRendererParams { /** * The input layer for which the renderer is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-rgb.html#createRenderer) */ layer: ImageryLayer | ImageryTileLayer | WCSLayer; /** * Deprecated since 4.27. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-rgb.html#createRenderer) */ renderingRule?: RasterFunction; /** * Specifies the function for how the requested image should be processed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-rgb.html#createRenderer) */ rasterFunction?: RasterFunction; /** * A preferred stretch type can be provided. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-rgb.html#createRenderer) */ stretchType?: "none" | "min-max" | "standard-deviation" | "histogram-equalization" | "percent-clip" | "sigmoid"; /** * The RGB band indexes following the order of red, green, and blue channels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-rgb.html#createRenderer) */ rgbBandIds?: number[]; /** * The gamma values to be used if `useGamma` is `true`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-rgb.html#createRenderer) */ gamma?: number[]; /** * Indicates whether the `gamma` values should be used. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-rgb.html#createRenderer) */ useGamma?: boolean; /** * When `true`, calculates the renderer's statistics based on the current display extent and recalculates them as you zoom and pan around the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-rgb.html#createRenderer) */ dynamicRangeAdjustment?: boolean; /** * Useful in scenarios where an image service does not have statistics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-rgb.html#createRenderer) */ estimateStatistics?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-rgb.html#createRenderer) */ signal?: AbortSignal; } /** * This object contains helper methods for generating a [RasterShadedReliefRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html) to render elevation values in raster layers (i.e. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-shadedRelief.html) */ interface shadedRelief { /** * Generates a [RasterShadedReliefRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html) to render elevation data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-shadedRelief.html#createRenderer) */ createRenderer(params: shadedReliefCreateRendererParams): Promise; } export const shadedRelief: shadedRelief; /** * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-shadedRelief.html#createRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-shadedRelief.html#RasterShadedReliefResult) */ export interface RasterShadedReliefResult { /** * The RasterShadedReliefRenderer renderer to apply to the input layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-shadedRelief.html#RasterShadedReliefResult) */ renderer: RasterShadedReliefRenderer; } export interface shadedReliefCreateRendererParams { /** * The input layer for which the renderer is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-shadedRelief.html#createRenderer) */ layer: ImageryLayer | ImageryTileLayer; /** * Deprecated since 4.27. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-shadedRelief.html#createRenderer) */ renderingRule?: RasterFunction; /** * Specifies the function for how the requested image should be processed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-shadedRelief.html#createRenderer) */ rasterFunction?: RasterFunction; /** * The preferred hillshade type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-shadedRelief.html#createRenderer) */ hillshadeType?: "traditional" | "multi-directional"; /** * Applies a constant or adjusted z-factor based on resolution changes. * * @default none * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-shadedRelief.html#createRenderer) */ scalingType?: "none" | "adjusted"; /** * The color ramp to apply to the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-shadedRelief.html#createRenderer) */ colorRamp?: AlgorithmicColorRamp | MultipartColorRamp; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-shadedRelief.html#createRenderer) */ signal?: AbortSignal; } /** * This object contains helper methods for generating a single-band [stretch visualization](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html) for raster layers (i.e. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-stretch.html) */ interface stretch { /** * Generates a [RasterStretchRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html) to render data from a single raster band. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-stretch.html#createRenderer) */ createRenderer(params: stretchCreateRendererParams): Promise; } export const stretch: stretch; /** * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-stretch.html#createRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-stretch.html#RasterStretchColorrampResult) */ export interface RasterStretchColorrampResult { /** * The RasterStretchRenderer renderer to apply to the input layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-stretch.html#RasterStretchColorrampResult) */ renderer: RasterStretchRenderer; /** * The zero-based index of the band represented by the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-stretch.html#RasterStretchColorrampResult) */ bandId: number; } export interface stretchCreateRendererParams { /** * The input layer for which the renderer is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-stretch.html#createRenderer) */ layer: ImageryLayer | ImageryTileLayer | WCSLayer; /** * Deprecated since 4.27. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-stretch.html#createRenderer) */ renderingRule?: RasterFunction; /** * Specifies the function for how the requested image should be processed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-stretch.html#createRenderer) */ rasterFunction?: RasterFunction; /** * A preferred stretch type can be provided. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-stretch.html#createRenderer) */ stretchType?: "none" | "min-max" | "standard-deviation" | "histogram-equalization" | "percent-clip" | "sigmoid"; /** * The 0-based index of a selected band. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-stretch.html#createRenderer) */ bandId?: number; /** * The color ramp to apply to the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-stretch.html#createRenderer) */ colorRamp?: AlgorithmicColorRamp | MultipartColorRamp; /** * Only applicable to multidimensional datasets where a raster layer can contain more than one variable (such as temperature, humidity, wind speed) with different statistics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-stretch.html#createRenderer) */ variableName?: string; /** * The gamma values to be used if `useGamma` is `true`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-stretch.html#createRenderer) */ gamma?: number[]; /** * Indicates whether the `gamma` values should be used. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-stretch.html#createRenderer) */ useGamma?: boolean; /** * When `true`, calculates the renderer's statistics based on the current display extent and recalculates them as you zoom and pan around the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-stretch.html#createRenderer) */ dynamicRangeAdjustment?: boolean; /** * Useful in scenarios where an image service does not have statistics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-stretch.html#createRenderer) */ estimateStatistics?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-stretch.html#createRenderer) */ signal?: AbortSignal; } /** * This object contains helper methods for generating a [UniqueValueRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html) for raster layers (i.e. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-uniqueValue.html) */ interface uniqueValue { /** * Generates a [UniqueValueRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html) to render thematic imagery. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-uniqueValue.html#createRenderer) */ createRenderer(params: uniqueValueCreateRendererParams): Promise; } export const uniqueValue: uniqueValue; /** * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-uniqueValue.html#createRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-uniqueValue.html#RasterUniqueValuesResult) */ export interface RasterUniqueValuesResult { /** * The UniqueValueRenderer renderer to apply to the input layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-uniqueValue.html#RasterUniqueValuesResult) */ renderer: UniqueValueRenderer; /** * The class field name from which the unique value infos were generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-uniqueValue.html#RasterUniqueValuesResult) */ classFieldName: string; } export interface uniqueValueCreateRendererParams { /** * The input layer for which the renderer is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-uniqueValue.html#createRenderer) */ layer: ImageryLayer | ImageryTileLayer; /** * Deprecated since 4.27. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-uniqueValue.html#createRenderer) */ renderingRule?: RasterFunction; /** * Specifies the function for how the requested image should be processed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-uniqueValue.html#createRenderer) */ rasterFunction?: RasterFunction; /** * A preferred class field name used for calculating unique values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-uniqueValue.html#createRenderer) */ classFieldName?: string; /** * The colors to apply to each unique value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-uniqueValue.html#createRenderer) */ colors?: number[][]; /** * The color ramp to apply to the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-uniqueValue.html#createRenderer) */ colorRamp?: AlgorithmicColorRamp | MultipartColorRamp; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-uniqueValue.html#createRenderer) */ signal?: AbortSignal; } /** * This object contains helper methods for generating a [VectorFieldRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-VectorFieldRenderer.html) for a `Vector-UV` or `Vector-MagDir` [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html) or [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-vectorField.html) */ interface vectorField { /** * Generates a [VectorFieldRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-VectorFieldRenderer.html) to display raster data with vector symbols. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-vectorField.html#createRenderer) */ createRenderer(params: vectorFieldCreateRendererParams): Promise; } export const vectorField: vectorField; export interface vectorFieldCreateRendererParams { /** * The input layer for which the renderer is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-vectorField.html#createRenderer) */ layer: ImageryLayer | ImageryTileLayer; /** * Deprecated since 4.27. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-vectorField.html#createRenderer) */ renderingRule?: RasterFunction; /** * Specifies the function for how the requested image should be processed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-vectorField.html#createRenderer) */ rasterFunction?: RasterFunction; /** * Defines the flow direction of the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-vectorField.html#createRenderer) */ flowRepresentation?: "flow-from" | "flow-to"; /** * Defines the origin and direction of rotation depending on how the angle of rotation was measured. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-vectorField.html#createRenderer) */ rotationType?: "geographic" | "arithmetic"; /** * The predefined symbol styles used to represent the vector flow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-vectorField.html#createRenderer) */ style?: | "beaufort-ft" | "beaufort-km" | "beaufort-kn" | "beaufort-m" | "beaufort-mi" | "classified-arrow" | "ocean-current-kn" | "ocean-current-m" | "simple-scalar" | "single-arrow" | "wind-barb"; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-vectorField.html#createRenderer) */ signal?: AbortSignal; } /** * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-vectorField.html#createRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-vectorField.html#VectorFieldRendererResult) */ export interface VectorFieldRendererResult { /** * The VectorFieldRenderer renderer to apply to the input layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-vectorField.html#VectorFieldRendererResult) */ renderer: VectorFieldRenderer; } /** * This module provides convenience methods for querying color ramps (arrays of colors) used for raster renderers in the `module:esri/smartMapping/raster/color/renderers` modules. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-colorRamps.html) */ interface colorRamps { /** * Returns all color ramps designed for raster renderers, each as an array of colors. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-colorRamps.html#all) */ all(): colorRampsColorRamp[]; /** * Returns the color ramp matching the given name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-colorRamps.html#byName) */ byName(name: string): colorRampsColorRamp; /** * Creates a raster color ramp from a list of colors. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-colorRamps.html#createColorRamp) */ createColorRamp(colors: Color[], algorithm?: "cie-lab" | "lab-lch" | "hsv"): MultipartColorRamp | AlgorithmicColorRamp; /** * Returns a raster color ramp's name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-colorRamps.html#getColorRampName) */ getColorRampName(colorRamp: MultipartColorRamp | AlgorithmicColorRamp): ColorRampName; /** * Returns the names of all raster color ramps. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-colorRamps.html#names) */ names(): string[]; } export const colorRamps: colorRamps; /** * Defines a ramp of colors to use for visualizing raster data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-colorRamps.html#ColorRamp) */ export interface colorRampsColorRamp { /** * The unique name of the color ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-colorRamps.html#ColorRamp) */ name: string; /** * An array of colors intended for displaying a continuous color ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-colorRamps.html#ColorRamp) */ colors: Color[]; } /** * The name of a color ramp and whether it is inverted. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-colorRamps.html#ColorRampName) */ export interface ColorRampName { /** * The unique name of the color ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-colorRamps.html#ColorRampName) */ name: string; /** * Indicates if the ramp's colors are inverted. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-colorRamps.html#ColorRampName) */ inverted: boolean; } /** * This object contains utility methods for obtaining information about supported renderers of raster layers (i.e. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-utils.html) */ interface supportUtils { /** * Returns default band ids used by a multispectral imagery layer when using a raster [rgb](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-rgb.html) or [stretch](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-stretch.html) renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-utils.html#getDefaultBandCombination) */ getDefaultBandCombination(params: utilsGetDefaultBandCombinationParams): Promise; /** * Returns supported raster renderer information of an imagery layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-utils.html#getSupportedRendererInfo) */ getSupportedRendererInfo(params: utilsGetSupportedRendererInfoParams): Promise; } export const supportUtils: supportUtils; /** * The result object of the [getSupportedRendererInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-utils.html#getSupportedRendererInfo) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-utils.html#SupportedRendererInfo) */ export interface SupportedRendererInfo { /** * The default renderer of the input layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-utils.html#SupportedRendererInfo) */ defaultRenderer: | ClassBreaksRenderer | RasterColormapRenderer | UniqueValueRenderer | RasterStretchRenderer | VectorFieldRenderer | RasterShadedReliefRenderer | FlowRenderer; /** * A list of supported renderer types that may be applied to the input layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-utils.html#SupportedRendererInfo) */ supportedTypes: SupportedRendererType[]; } /** * Supported renderer types for imagery layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-utils.html#SupportedRendererType) */ export type SupportedRendererType = | "raster-stretch" | "raster-unique-value" | "raster-rgb" | "raster-class-breaks" | "raster-colormap" | "raster-shaded-relief" | "raster-vector-field" | "raster-flow"; export interface utilsGetDefaultBandCombinationParams { /** * Layer for which the default band ids are returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-utils.html#getDefaultBandCombination) */ layer: ImageryLayer | ImageryTileLayer | WCSLayer; /** * Deprecated since 4.27. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-utils.html#getDefaultBandCombination) */ renderingRule?: RasterFunction; /** * Specifies the function for how the requested image should be processed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-utils.html#getDefaultBandCombination) */ rasterFunction?: RasterFunction; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-utils.html#getDefaultBandCombination) */ signal?: AbortSignal; } export interface utilsGetSupportedRendererInfoParams { /** * The input layer for which the renderer info is returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-utils.html#getSupportedRendererInfo) */ layer: ImageryLayer | ImageryTileLayer | WCSLayer; /** * Deprecated since 4.27. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-utils.html#getSupportedRendererInfo) */ renderingRule?: RasterFunction; /** * Specifies the function for how the requested image should be processed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-utils.html#getSupportedRendererInfo) */ rasterFunction?: RasterFunction; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-support-utils.html#getSupportedRendererInfo) */ signal?: AbortSignal; } /** * This object contains helper methods for generating data-driven visualizations with continuous color or class breaks based on a field value or expression from features in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html) */ interface color { /** * Generates a continuous color [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) representing the age of features based on one or more fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createAgeRenderer) */ createAgeRenderer(params: colorCreateAgeRendererParams): Promise; /** * Generates a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html) that may be applied directly to the layer used to call this method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ createClassBreaksRenderer(params: colorCreateClassBreaksRendererParams): Promise; /** * Generates a [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) that may be applied directly to the layer used to call this method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) */ createContinuousRenderer(params: colorCreateContinuousRendererParams): Promise; /** * Generates a [PointCloudStretchRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html) with a color scheme best-suited for the view's background based on statistics returned from a given field of a [PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createPCContinuousRenderer) */ createPCContinuousRenderer(params: colorCreatePCContinuousRendererParams): Promise; /** * Generates a [PointCloudRGBRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRGBRenderer.html) based on the `RGB` field of a given [PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createPCTrueColorRenderer) */ createPCTrueColorRenderer(params: colorCreatePCTrueColorRendererParams): Promise; /** * This method generates a color visual variable with default stops that are optimally chosen based on the statistics queried for the indicated field or expression and colors determined by the view's background. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createVisualVariable) */ createVisualVariable(params: colorCreateVisualVariableParams): Promise; } export const color: color; /** * The result object of the [createAgeRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createAgeRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#AgeRendererResult) */ export interface AgeRendererResult { /** * The renderer object configured to best match the background of the view and the spread of the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#AgeRendererResult) */ renderer: ClassBreaksRenderer; /** * A color visual variable configured based on the statistics of the data and the background of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#AgeRendererResult) */ visualVariable: ColorVariable; /** * The time unit used to represent age in the output `renderer`. * * [Read more...](global.html#unit) */ unit: string; /** * The color scheme used by the visual variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#AgeRendererResult) */ colorScheme: ColorScheme; /** * Indicates whether default values are used in the absence of sufficient data and/or statistics from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#AgeRendererResult) */ defaultValuesUsed: boolean; /** * Basic statistics returned from a query to the service for data from the given field name or expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#AgeRendererResult) */ statistics: SummaryStatisticsResult; /** * The ID of the basemap used to determine the optimal fill color of the features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#AgeRendererResult) */ basemapId: string; /** * Indicates whether the average color of the input view's basemap is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#AgeRendererResult) */ basemapTheme: string; } /** * The result object of the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#ClassBreaksRendererResult) */ export interface ClassBreaksRendererResult { /** * The renderer object configured to best match the background of the view and the spread of the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#ClassBreaksRendererResult) */ renderer: ClassBreaksRenderer; /** * This object describes class breaks generated from data in a layer for a given field with a specified classification method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#ClassBreaksRendererResult) */ classBreaksResult: ClassBreaksResult; /** * The color scheme used for the class breaks. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#ClassBreaksRendererResult) */ colorScheme: ColorScheme; /** * Indicates whether default values are used in the absence of sufficient data and/or statistics from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#ClassBreaksRendererResult) */ defaultValuesUsed: boolean; /** * The ID of the basemap used to determine the optimal fill color of the features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#ClassBreaksRendererResult) */ basemapId: string; /** * Indicates whether the average color of the input view's basemap is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#ClassBreaksRendererResult) */ basemapTheme: string; } export interface colorCreateAgeRendererParams { /** * The layer for which the visualization is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createAgeRenderer) */ layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The view where the input layer is rendered. * * [Read more...](global.html) */ view: View; /** * The name of the field, or a date value representing the start time in the age calculation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createAgeRenderer) */ startTime: Date | string | number; /** * The name of the field, or a date value representing the end time in the age calculation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createAgeRenderer) */ endTime: Date | string | number; /** * The time unit used to calculate the difference between `endTime` and `startTime`. * * [Read more...](global.html#unit) */ unit?: "years" | "months" | "days" | "hours" | "minutes" | "seconds"; /** * Sets a maximum age for the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createAgeRenderer) */ maxValue?: number; /** * Sets a minimum age for the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createAgeRenderer) */ minValue?: number; /** * Determines which values will be emphasized in the continuous ramp and the map. * * @default high-to-low * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createAgeRenderer) */ theme?: "high-to-low" | "above" | "below" | "above-and-below" | "centered-on" | "extremes"; /** * For polygon layers only. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createAgeRenderer) */ outlineOptimizationEnabled?: boolean; /** * For point and polyline layers only. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createAgeRenderer) */ sizeOptimizationEnabled?: boolean; /** * Provides options for modifying [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) properties describing the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createAgeRenderer) */ legendOptions?: colorCreateAgeRendererParamsLegendOptions; /** * A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html) function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createAgeRenderer) */ statistics?: SummaryStatisticsResult; /** * In authoring apps, the user may select a pre-defined color scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createAgeRenderer) */ colorScheme?: ColorScheme; /** * The type of symbol to generate. * * @default 2d * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createAgeRenderer) */ symbolType?: "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform"; /** * Enables the `defaultSymbol` on the renderer and assigns it to features with no value. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createAgeRenderer) */ defaultSymbolEnabled?: boolean; /** * **This option only applies to generating renderers for mesh SceneLayers**. * * @default replace * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createAgeRenderer) */ colorMixMode?: string; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createAgeRenderer) */ signal?: AbortSignal; } export interface colorCreateAgeRendererParamsLegendOptions { /** * The title used to represent the age color ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createAgeRenderer) */ title?: string; /** * Indicates whether to include the age renderer in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createAgeRenderer) */ showLegend?: boolean; } export interface colorCreateClassBreaksRendererParams { /** * The layer for which the visualization is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The view where the input layer is rendered. * * [Read more...](global.html) */ view?: View; /** * The name of the field whose data will be queried for statistics and classified. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ field?: string; /** * The name of the field to normalize the values of the given `field`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ normalizationField?: string; /** * Indicates how the data is normalized. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ normalizationType?: "field" | "log" | "percent-of-total"; /** * When `normalizationType` is `percent-of-total`, this property contains the total of all data values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ normalizationTotal?: number; /** * The classification method used for generating breaks. * * @default equal-interval * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ classificationMethod?: "equal-interval" | "natural-breaks" | "quantile" | "standard-deviation"; /** * If a `standard-deviation` classification method is used, then this indicates the interval by which to generate class breaks. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ standardDeviationInterval?: number; /** * The number of class breaks to generate. * * @default 5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ numClasses?: number; /** * In authoring apps, the user may select a pre-defined color scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ colorScheme?: ColorScheme; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ valueExpression?: string; /** * Text describing the value returned from the `valueExpression`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ valueExpressionTitle?: string; /** * A SQL expression evaluating to a number. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ sqlWhere?: string; /** * For polygon layers only. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ outlineOptimizationEnabled?: boolean; /** * Provides options for setting a title to describe a field instead of using the field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ legendOptions?: colorCreateClassBreaksRendererParamsLegendOptions; /** * A minimum value set by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ minValue?: number; /** * A maximum value set by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ maxValue?: number; /** * Enables the `defaultSymbol` on the renderer and assigns it to features with no value and features that do not fall within the configured data range. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ defaultSymbolEnabled?: boolean; /** * The type of symbol to generate. * * @default 2d * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ symbolType?: "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform"; /** * **This option only applies to generating renderers for mesh SceneLayers**. * * @default replace * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ colorMixMode?: string; /** * Indicates whether the generated renderer is for a binning visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ forBinning?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ signal?: AbortSignal; } export interface colorCreateClassBreaksRendererParamsLegendOptions { /** * The title used to represent the given field or expression in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) */ title?: string; } export interface colorCreateContinuousRendererParams { /** * The layer for which the visualization is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) */ layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The view where the input layer is rendered. * * [Read more...](global.html) */ view?: View; /** * The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) */ field?: string; /** * The name of the field to normalize the values of the given `field`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) */ normalizationField?: string; /** * Determines which values will be emphasized in the continuous ramp and the map. * * @default high-to-low * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) */ theme?: "high-to-low" | "above" | "below" | "above-and-below" | "centered-on" | "extremes"; /** * In authoring apps, the user may select a pre-defined color scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) */ colorScheme?: ColorScheme; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) */ valueExpression?: string; /** * Text describing the value returned from the `valueExpression`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) */ valueExpressionTitle?: string; /** * A SQL expression evaluating to a number. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) */ sqlWhere?: string; /** * For polygon layers only. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) */ outlineOptimizationEnabled?: boolean; /** * For point and polyline layers only. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) */ sizeOptimizationEnabled?: boolean; /** * Provides options for setting a title to a field when an expression is provided instead of a field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) */ legendOptions?: colorCreateContinuousRendererParamsLegendOptions; /** * A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html) function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) */ statistics?: SummaryStatisticsResult; /** * A custom minimum value set by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) */ minValue?: number; /** * A custom maximum value set by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) */ maxValue?: number; /** * Enables the `defaultSymbol` on the renderer and assigns it to features with no value and features that do not fall within the configured data range. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) */ defaultSymbolEnabled?: boolean; /** * The type of symbol to generate. * * @default 2d * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) */ symbolType?: "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform"; /** * **This option only applies to generating renderers for mesh SceneLayers**. * * @default replace * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) */ colorMixMode?: string; /** * Indicates whether the generated renderer is for a binning visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) */ forBinning?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) */ signal?: AbortSignal; } export interface colorCreateContinuousRendererParamsLegendOptions { /** * The title used to represent the given field or expression in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) */ title?: string; /** * Indicates whether to describe the renderer in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) */ showLegend?: boolean; } export interface colorCreatePCContinuousRendererParams { /** * The layer for which the visualization is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createPCContinuousRenderer) */ layer: PointCloudLayer; /** * The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createPCContinuousRenderer) */ field: string; /** * The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. * * @default gray * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createPCContinuousRenderer) */ basemap?: string | Basemap; /** * The size of each point expressed as a percentage. * * @default 100% * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createPCContinuousRenderer) */ size?: string; /** * The number of points per inch in the view. * * @default 25 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createPCContinuousRenderer) */ density?: number; /** * In authoring apps, the user may select a pre-defined color scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createPCContinuousRenderer) */ colorScheme?: ColorScheme; /** * A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html) function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createPCContinuousRenderer) */ statistics?: SummaryStatisticsResult; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createPCContinuousRenderer) */ signal?: AbortSignal; } export interface colorCreatePCTrueColorRendererParams { /** * The layer for which the visualization is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createPCTrueColorRenderer) */ layer: PointCloudLayer; /** * The size of each point expressed as a percentage. * * @default 100% * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createPCTrueColorRenderer) */ size?: string; /** * The number of points per inch in the view. * * @default 25 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createPCTrueColorRenderer) */ density?: number; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createPCTrueColorRenderer) */ signal?: AbortSignal; } export interface colorCreateVisualVariableParams { /** * The layer for which the visual variable is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createVisualVariable) */ layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The view where the input layer is rendered. * * [Read more...](global.html) */ view?: View; /** * The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createVisualVariable) */ field?: string; /** * The name of the field to normalize the values of the given `field`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createVisualVariable) */ normalizationField?: string; /** * Determines which values will be emphasized in the continuous ramp and the map. * * @default high-to-low * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createVisualVariable) */ theme?: "high-to-low" | "above" | "below" | "above-and-below" | "centered-on" | "extremes"; /** * In authoring apps, the user may select a pre-defined color scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createVisualVariable) */ colorScheme?: ColorScheme; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createVisualVariable) */ valueExpression?: string; /** * Text describing the value returned from the `valueExpression`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createVisualVariable) */ valueExpressionTitle?: string; /** * A SQL expression evaluating to a number. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createVisualVariable) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createVisualVariable) */ sqlWhere?: string; /** * Provides options for setting a title to a field when an expression is provided instead of a field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createVisualVariable) */ legendOptions?: colorCreateVisualVariableParamsLegendOptions; /** * A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html) function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createVisualVariable) */ statistics?: SummaryStatisticsResult; /** * A custom minimum value set by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createVisualVariable) */ minValue?: number; /** * A custom maximum value set by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createVisualVariable) */ maxValue?: number; /** * Indicates if the size units of the symbols will be in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createVisualVariable) */ worldScale?: boolean; /** * Indicates whether the generated renderer is for a binning visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createVisualVariable) */ forBinning?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createVisualVariable) */ signal?: AbortSignal; } export interface colorCreateVisualVariableParamsLegendOptions { /** * The title used to represent the given field or expression in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createVisualVariable) */ title?: string; /** * Indicates whether to describe the renderer in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createVisualVariable) */ showLegend?: boolean; } /** * The result object of the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#ContinuousRendererResult) */ export interface ContinuousRendererResult { /** * The renderer object configured to best match the view's background and the spread of the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#ContinuousRendererResult) */ renderer: ClassBreaksRenderer; /** * A color visual variable configured based on the statistics of the data and the view's background. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#ContinuousRendererResult) */ visualVariable: ColorVariable; /** * The color scheme used by the visual variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#ContinuousRendererResult) */ colorScheme: ColorScheme; /** * Indicates whether default values are used in the absence of sufficient data and/or statistics from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#ContinuousRendererResult) */ defaultValuesUsed: boolean; /** * Basic statistics returned from a query to the service for data from the given field name or expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#ContinuousRendererResult) */ statistics: SummaryStatisticsResult; /** * The ID of the basemap used to determine the optimal fill color of the features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#ContinuousRendererResult) */ basemapId: string; /** * Indicates whether the average color of the input view's basemap is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#ContinuousRendererResult) */ basemapTheme: string; } /** * The result object of the [createPCContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createPCContinuousRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#PCContinuousRendererResult) */ export interface PCContinuousRendererResult { /** * The renderer object configured to best match the background of the view and the spread of the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#PCContinuousRendererResult) */ renderer: PointCloudStretchRenderer; /** * The color scheme used by the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#PCContinuousRendererResult) */ colorScheme: ColorScheme; /** * Indicates whether default values are used in the absence of sufficient data and/or statistics from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#PCContinuousRendererResult) */ defaultValuesUsed: boolean; /** * Basic statistics returned from a query to the service for data from the given field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#PCContinuousRendererResult) */ statistics: SummaryStatisticsResult; /** * The ID of the basemap used to determine the optimal color scheme for the output renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#PCContinuousRendererResult) */ basemapId: string; /** * Indicates whether the average color of the input view's basemap is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#PCContinuousRendererResult) */ basemapTheme: string; } /** * The result object of the [createPCTrueColorRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createPCTrueColorRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#PCTrueColorRendererResult) */ export interface PCTrueColorRendererResult { /** * The renderer object configured to represent the true color of each point in the point cloud. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#PCTrueColorRendererResult) */ renderer: PointCloudRGBRenderer; } /** * The result object of the [createVisualVariable()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createVisualVariable) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#VisualVariableResult) */ export interface VisualVariableResult { /** * A color visual variable configured based on the statistics of the data and the view's background. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#VisualVariableResult) */ visualVariable: ColorVariable; /** * The color scheme used by the visual variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#VisualVariableResult) */ colorScheme: ColorScheme; /** * Basic statistics returned from a query to the service for the given field or expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#VisualVariableResult) */ statistics: SummaryStatisticsResult; /** * Indicates whether default values are used in the absence of sufficient data and/or statistics from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#VisualVariableResult) */ defaultValuesUsed: boolean; /** * The ID of the basemap used to determine the optimal fill color of the features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#VisualVariableResult) */ basemapId: string; /** * Indicates whether the average color of the input view's basemap is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#VisualVariableResult) */ basemapTheme: string; /** * Authoring information related to the creation of the visual variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#VisualVariableResult) */ authoringInfo: AuthoringInfo; } /** * This object contains a helper method for generating a [dot density visualization](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-dotDensity.html) */ interface dotDensity { /** * Generates a [DotDensityRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html) based on one or more complementary numeric fields and/or Arcade expressions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-dotDensity.html#createRenderer) */ createRenderer(params: dotDensityCreateRendererParams): Promise; } export const dotDensity: dotDensity; export interface dotDensityCreateRendererParams { /** * The **polygon** layer for which the visualization is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-dotDensity.html#createRenderer) */ layer: FeatureLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer; /** * The MapView instance in which the visualization will be rendered. * * [Read more...](global.html) */ view: MapView; /** * A set of complementary numeric fields/expressions used as the basis of the dot density visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-dotDensity.html#createRenderer) */ attributes: dotDensityCreateRendererParamsAttributes[]; /** * Indicates whether to vary the value of each dot by the view's scale. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-dotDensity.html#createRenderer) */ dotValueOptimizationEnabled?: boolean; /** * Indicates whether to enable color blending of different colored dots rendered at the same pixel. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-dotDensity.html#createRenderer) */ dotBlendingEnabled?: boolean; /** * Indicates whether the polygon outline width should vary based on view scale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-dotDensity.html#createRenderer) */ outlineOptimizationEnabled?: boolean; /** * Provides options for modifying [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) properties describing the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-dotDensity.html#createRenderer) */ legendOptions?: dotDensityCreateRendererParamsLegendOptions; /** * In authoring apps, the user may select a pre-defined dot density scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-dotDensity.html#createRenderer) */ dotDensityScheme?: DotDensityScheme; /** * Indicates whether the generated renderer is for a binning visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-dotDensity.html#createRenderer) */ forBinning?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-dotDensity.html#createRenderer) */ signal?: AbortSignal; } export interface dotDensityCreateRendererParamsAttributes { /** * The name of a numeric field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-dotDensity.html#createRenderer) */ field?: string; /** * The label describing the field name (or category) in the legend. * * [Read more...](global.html) */ label?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-dotDensity.html#createRenderer) */ valueExpression?: string; /** * Text describing the value returned from the `valueExpression`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-dotDensity.html#createRenderer) */ valueExpressionTitle?: string; } export interface dotDensityCreateRendererParamsLegendOptions { /** * Indicates the unit represented by each dot in the legend. * * [Read more...](global.html#unit) */ unit?: string; } /** * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-dotDensity.html#createRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-dotDensity.html#RendererResult) */ export interface RendererResult { /** * The object representing the dot density visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-dotDensity.html#RendererResult) */ renderer: DotDensityRenderer; /** * The dot density scheme used by the renderer based on the view's background. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-dotDensity.html#RendererResult) */ dotDensityScheme: DotDensityScheme; /** * The ID of the basemap used to determine the optimal colors of the dots. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-dotDensity.html#RendererResult) */ basemapId: string; /** * Indicates whether the average color of the input view's basemap is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-dotDensity.html#RendererResult) */ basemapTheme: string; } /** * This object contains a helper method for generating a [HeatmapRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html) for a point [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html) */ interface heatmap { /** * Generates a [HeatmapRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html) that may be applied directly to the layer used to call this method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#createRenderer) */ createRenderer(params: heatmapCreateRendererParams): Promise; /** * Allows you to update the [colorStops](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#colorStops) of a [HeatmapRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html) with opacity, making the low density areas of the heat map to fade out. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#updateRenderer) */ updateRenderer(params: heatmapUpdateRendererParams): HeatmapRenderer; } export const heatmap: heatmap; export interface heatmapCreateRendererParams { /** * The point layer for which the visualization is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#createRenderer) */ layer: FeatureLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The view instance in which the visualization will be rendered. * * [Read more...](global.html) */ view: MapView | SceneView; /** * The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#createRenderer) */ field?: string; /** * In authoring apps, the user may select a pre-defined heatmap scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#createRenderer) */ heatmapScheme?: HeatmapScheme; /** * A statistics object generated from the [heatmapStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-heatmapStatistics.html) function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#createRenderer) */ statistics?: HeatmapStatisticsResult; /** * Indicates how much to fade the lower color stops with transparency to create a fuzzy boundary on the edge of the heatmap. * * @default 0.2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#createRenderer) */ fadeRatio?: number; /** * Indicates whether the heatmap should fade its colors to transparent. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#createRenderer) */ fadeToTransparent?: boolean; /** * The [radius](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#radius) in points that determines the area of influence of each point. * * @default 18 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#createRenderer) */ radius?: number; /** * The minimum [ratio](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-HeatmapColorStop.html#ratio) used in the [HeatmapRenderer.colorStops](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#colorStops) of the output renderer. * * @default 0.01 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#createRenderer) */ minRatio?: number; /** * The maximum [ratio](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-HeatmapColorStop.html#ratio) used in the [HeatmapRenderer.colorStops](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#colorStops) of the output renderer. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#createRenderer) */ maxRatio?: number; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#createRenderer) */ signal?: AbortSignal; } /** * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#createRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#HeatmapRendererResult) */ export interface HeatmapRendererResult { /** * The renderer object configured to best match the view's background and the spread of the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#HeatmapRendererResult) */ renderer: HeatmapRenderer; /** * The color scheme used by the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#HeatmapRendererResult) */ scheme: HeatmapScheme; /** * Indicates whether default values are used in the absence of sufficient data and/or statistics from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#HeatmapRendererResult) */ defaultValuesUsed: boolean; /** * Basic statistics required for generating a renderer with optimal values for the given layer and view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#HeatmapRendererResult) */ statistics: HeatmapStatisticsResult; /** * The ID of the basemap used to determine the optimal color stops of the heatmap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#HeatmapRendererResult) */ basemapId: string; /** * Indicates whether the average color of the input view's basemap is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#HeatmapRendererResult) */ basemapTheme: string; } export interface heatmapUpdateRendererParams { /** * The heatmap renderer for which to add or remove opacity. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#updateRenderer) */ renderer: HeatmapRenderer; /** * Indicates how much to fade the lower color stops with transparency to create a fuzzy boundary on the edge of the heatmap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#updateRenderer) */ fadeRatio?: number; } /** * This object contains helper methods for generating location-only visualizations (not data-driven) in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-location.html) */ interface location { /** * Generates a [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) that may be applied directly to a supported [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-location.html#createRenderer) */ createRenderer(params: locationCreateRendererParams): Promise; } export const location: location; export interface locationCreateRendererParams { /** * The layer for which the visualization is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-location.html#createRenderer) */ layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The view where the input layer is rendered. * * [Read more...](global.html) */ view?: View; /** * In authoring apps, the user may select a pre-defined location scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-location.html#createRenderer) */ locationScheme?: LocationScheme; /** * For point and polyline layers only. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-location.html#createRenderer) */ sizeOptimizationEnabled?: boolean; /** * For polygon layers only. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-location.html#createRenderer) */ outlineOptimizationEnabled?: boolean; /** * The type of symbol to generate. * * @default 2d * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-location.html#createRenderer) */ symbolType?: "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform"; /** * **This option only applies to generating renderers for mesh SceneLayers**. * * @default replace * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-location.html#createRenderer) */ colorMixMode?: string; /** * Indicates whether the generated renderer is for a binning visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-location.html#createRenderer) */ forBinning?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-location.html#createRenderer) */ signal?: AbortSignal; } /** * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-location.html#createRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-location.html#RendererResult) */ export interface locationRendererResult { /** * A simple renderer configured with a single color best suited to match the background of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-location.html#RendererResult) */ renderer: SimpleRenderer; /** * The location scheme used by the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-location.html#RendererResult) */ locationScheme: LocationScheme; /** * The ID of the basemap used to determine the optimal fill color of the features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-location.html#RendererResult) */ basemapId: string; /** * Indicates whether the average color of the input view's basemap is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-location.html#RendererResult) */ basemapTheme: string; } /** * This object contains a helper method for generating data-driven visualizations with continuous opacity based on data returned from a field value or expression in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html) */ interface opacity { /** * This method generates an opacity visual variable with default alpha values optimally mapped to data values based on the statistics queried for the indicated field or expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#createVisualVariable) */ createVisualVariable(params: opacityCreateVisualVariableParams): Promise; } export const opacity: opacity; export interface opacityCreateVisualVariableParams { /** * The layer for which the visual variable is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#createVisualVariable) */ layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#createVisualVariable) */ field?: string; /** * The name of the field to normalize the values of the given `field`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#createVisualVariable) */ normalizationField?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#createVisualVariable) */ valueExpression?: string; /** * Text describing the value returned from the `valueExpression`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#createVisualVariable) */ valueExpressionTitle?: string; /** * A SQL expression evaluating to a number. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#createVisualVariable) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#createVisualVariable) */ sqlWhere?: string; /** * Provides options for setting a title to a field when an expression is provided instead of a field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#createVisualVariable) */ legendOptions?: opacityCreateVisualVariableParamsLegendOptions; /** * A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html) function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#createVisualVariable) */ statistics?: SummaryStatisticsResult; /** * A custom minimum value set by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#createVisualVariable) */ minValue?: number; /** * A custom maximum value set by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#createVisualVariable) */ maxValue?: number; /** * A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) instance is required when a `valueExpression` is specified. * * [Read more...](global.html) */ view?: View; /** * Indicates whether the generated renderer is for a binning visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#createVisualVariable) */ forBinning?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#createVisualVariable) */ signal?: AbortSignal; } export interface opacityCreateVisualVariableParamsLegendOptions { /** * The title used to represent the given field or expression in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#createVisualVariable) */ title?: string; } /** * The result object of the [createVisualVariable()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#createVisualVariable) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#VisualVariableResult) */ export interface opacityVisualVariableResult { /** * An opacity visual variable configured based on the statistics of the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#VisualVariableResult) */ visualVariable: OpacityVariable; /** * Basic statistics returned from a query to the service for the given field or expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#VisualVariableResult) */ statistics: SummaryStatisticsResult; /** * Indicates whether default values are used in the absence of sufficient data and/or statistics from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#VisualVariableResult) */ defaultValuesUsed: boolean; /** * Authoring information related to the creation of the visual variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#VisualVariableResult) */ authoringInfo: AuthoringInfo; } /** * This object contains a helper method for generating a pie chart for every feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html) */ interface pieChart { /** * Generates a [PieChartRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html) based on a set of numeric fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRenderer) */ createRenderer(params: pieChartCreateRendererParams): Promise; /** * Generates a [PieChartRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html) to use for a [FeatureReductionCluster](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html) visualization based off an input layer's [UniqueValueRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html) or [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRendererForClustering) */ createRendererForClustering(params: pieChartCreateRendererForClusteringParams): Promise; } export const pieChart: pieChart; /** * The result object of the [createRendererForClustering()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRendererForClustering) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#ClusterRendererResult) */ export interface ClusterRendererResult { /** * The generated pie chart renderer to use for clustering. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#ClusterRendererResult) */ renderer: PieChartRenderer; /** * The aggregate fields used by the `renderer`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#ClusterRendererResult) */ fields: AggregateField[]; } export interface pieChartCreateRendererForClusteringParams { /** * The layer for which the visualization is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRendererForClustering) */ layer: FeatureLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * Determines whether to create a pie chart or a donut chart. * * @default "pie" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRendererForClustering) */ shape?: "pie" | "donut"; /** * Includes the `defaultSymbol` defined in the input layer's renderer in the output pie chart renderer. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRendererForClustering) */ defaultSymbolEnabled?: boolean; /** * Provides options for modifying [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) properties describing the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRendererForClustering) */ legendOptions?: pieChartCreateRendererForClusteringParamsLegendOptions; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRendererForClustering) */ signal?: AbortSignal; } export interface pieChartCreateRendererForClusteringParamsLegendOptions { /** * The title used to describe the renderer in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRendererForClustering) */ title?: string; } export interface pieChartCreateRendererParams { /** * The layer for which the visualization is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRenderer) */ layer: FeatureLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The view instance in which the visualization will be rendered. * * [Read more...](global.html) */ view: MapView; /** * A set of complementary numeric fields/expressions used to create the charts. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRenderer) */ attributes: pieChartCreateRendererParamsAttributes[]; /** * Determines whether to create a pie chart or a donut chart. * * @default "pie" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRenderer) */ shape?: "pie" | "donut"; /** * Indicates whether to include data-driven size in the final renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRenderer) */ includeSizeVariable?: boolean; /** * Only for polygon layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRenderer) */ outlineOptimizationEnabled?: boolean; /** * Indicates whether chart sizes should vary based on view scale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRenderer) */ sizeOptimizationEnabled?: boolean; /** * Provides options for modifying [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) properties describing the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRenderer) */ legendOptions?: pieChartCreateRendererParamsLegendOptions; /** * In authoring apps, the user may select a pre-defined color scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRenderer) */ pieChartScheme?: PieChartScheme; /** * Indicates whether the generated renderer is for a binning visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRenderer) */ forBinning?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRenderer) */ signal?: AbortSignal; } export interface pieChartCreateRendererParamsAttributes { /** * The name of a numeric field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRenderer) */ field?: string; /** * The label describing the field name (or pie slice) in the legend. * * [Read more...](global.html) */ label?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRenderer) */ valueExpression?: string; /** * Text describing the value returned from the `valueExpression`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRenderer) */ valueExpressionTitle?: string; } export interface pieChartCreateRendererParamsLegendOptions { /** * The title used to describe the renderer in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRenderer) */ title?: string; } /** * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#RendererResult) */ export interface pieChartRendererResult { /** * The generated pie chart renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#RendererResult) */ renderer: PieChartRenderer; /** * A size visual variable representing the sum of all attributes included in the pie chart. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#RendererResult) */ size?: sizeVisualVariableResult; /** * The color scheme used by the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#RendererResult) */ pieChartScheme: PieChartScheme; /** * The ID of the basemap used to determine the optimal color schemes for the charts. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#RendererResult) */ basemapId: string; /** * Indicates whether the average color of the input view's basemap is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#RendererResult) */ basemapTheme: string; /** * Contains the total counts of each attribute used in the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#RendererResult) */ statistics: UniqueValuesResult; } /** * This object contains a helper method for generating a predominance visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html) */ interface predominance { /** * Generates a predominance renderer based on a set of competing numeric fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#createRenderer) */ createRenderer(params: predominanceCreateRendererParams): Promise; } export const predominance: predominance; export interface predominanceCreateRendererParams { /** * The layer for which the visualization is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#createRenderer) */ layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The view instance in which the visualization will be rendered. * * [Read more...](global.html) */ view: View; /** * A set of competing numeric fields used as the basis of the predominance visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#createRenderer) */ fields: predominanceCreateRendererParamsFields[]; /** * Indicates whether to include data-driven opacity in the final renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#createRenderer) */ includeOpacityVariable?: boolean; /** * Indicates whether to include data-driven size in the final renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#createRenderer) */ includeSizeVariable?: boolean; /** * Only for polygon layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#createRenderer) */ outlineOptimizationEnabled?: boolean; /** * Indicates whether symbol sizes should vary based on view scale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#createRenderer) */ sizeOptimizationEnabled?: boolean; /** * Provides options for modifying [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) properties describing the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#createRenderer) */ legendOptions?: predominanceCreateRendererParamsLegendOptions; /** * A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html) function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#createRenderer) */ statistics?: SummaryStatisticsResult; /** * Indicates how values should be sorted in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * @default count * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#createRenderer) */ sortBy?: "count" | "value"; /** * In authoring apps, the user may select a pre-defined predominance scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#createRenderer) */ predominanceScheme?: PredominanceScheme; /** * The type of symbol to generate. * * @default 2d * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#createRenderer) */ symbolType?: "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform"; /** * Enables the `defaultSymbol` on the renderer and assigns it to features with no value. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#createRenderer) */ defaultSymbolEnabled?: boolean; /** * **This option only applies to generating renderers for mesh SceneLayers**. * * @default replace * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#createRenderer) */ colorMixMode?: string; /** * Indicates whether the generated renderer is for a binning visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#createRenderer) */ forBinning?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#createRenderer) */ signal?: AbortSignal; } export interface predominanceCreateRendererParamsFields { /** * The name of a numeric field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#createRenderer) */ name: string; /** * The label describing the field name (or category) in the legend. * * [Read more...](global.html) */ label?: string; } export interface predominanceCreateRendererParamsLegendOptions { /** * The title used to describe the renderer in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#createRenderer) */ title?: string; /** * Indicates whether to include the renderer in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#createRenderer) */ showLegend?: boolean; } /** * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#createRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#RendererResult) */ export interface predominanceRendererResult { /** * The unique value renderer object representing the predominance visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#RendererResult) */ renderer: UniqueValueRenderer; /** * An array of objects describing the value, symbol, and count of each unique type or category represented in the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#RendererResult) */ predominantCategoryInfos: typeUniqueValueInfo[]; /** * An array of objects describing the values or categories excluded from consideration in visualizing data from the given fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#RendererResult) */ excludedCategoryInfos: any[]; /** * A size visual variable representing the total count of all fields included in the predominance visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#RendererResult) */ size?: sizeVisualVariableResult; /** * An opacity visual variable representing the percentage of the total count comprised by the predominant value of all fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#RendererResult) */ opacity?: opacityVisualVariableResult; /** * The predominance scheme used by the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#RendererResult) */ predominanceScheme: PredominanceScheme; /** * The ID of the basemap used to determine the optimal fill color of the features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#RendererResult) */ basemapId: string; /** * Indicates whether the average color of the input view's basemap is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#RendererResult) */ basemapTheme: string; } /** * This object contains a helper method for creating a renderer for exploring the relationship between two numeric attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html) */ interface relationship { /** * Generates a relationship renderer (bivariate choropleth) based on a set of competing numeric fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ createRenderer(params: relationshipCreateRendererParams): Promise; /** * Updates a relationship renderer (bivariate choropleth) generated from [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) based on the given input parameters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#updateRenderer) */ updateRenderer(params: relationshipUpdateRendererParams): Promise; } export const relationship: relationship; export interface relationshipCreateRendererParams { /** * The layer for which the visualization is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The view instance in which the visualization will be rendered. * * [Read more...](global.html) */ view: View; /** * A numeric field that will be used to explore its relationship with `field2`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ field1: relationshipCreateRendererParamsField1; /** * A numeric field that will be used to explore its relationship with `field1`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ field2: relationshipCreateRendererParamsField2; /** * The method for classifying each field's data values. * * @default quantile * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ classificationMethod?: "quantile" | "equal-interval" | "natural-breaks"; /** * Determines the orientation of the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ focus?: string; /** * Indicates the number of classes by which to break up the values of each field. * * @default 3 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ numClasses?: number; /** * For polygon layers only. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ outlineOptimizationEnabled?: boolean; /** * For point and polyline layers only. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ sizeOptimizationEnabled?: boolean; /** * Provides options for modifying [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) properties describing the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ legendOptions?: relationshipCreateRendererParamsLegendOptions; /** * In authoring apps, the user may select a pre-defined relationship scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ relationshipScheme?: RelationshipScheme; /** * The type of symbol to generate. * * @default 2d * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ symbolType?: "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform"; /** * Enables the `defaultSymbol` on the renderer and assigns it to features with no value or that fall outside of the prescribed class breaks. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ defaultSymbolEnabled?: boolean; /** * **This option only applies to generating renderers for mesh SceneLayers**. * * @default replace * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ colorMixMode?: string; /** * Indicates whether the generated renderer is for a binning visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ forBinning?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ signal?: AbortSignal; } export interface relationshipCreateRendererParamsField1 { /** * The name of a numeric field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ field: string; /** * The name of a numeric field used to normalize the given `field`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ normalizationField?: string; /** * The maximum bound of values to visualize in the given field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ maxValue?: number; /** * The minimum bound of values to visualize in the given field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ minValue?: number; /** * The label used to describe the field or variable in the legend. * * [Read more...](global.html) */ label?: string; } export interface relationshipCreateRendererParamsField2 { /** * The name of a numeric field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ field: string; /** * The name of a numeric field used to normalize the given `field`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ normalizationField?: string; /** * The maximum bound of values to visualize in the given field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ maxValue?: number; /** * The minimum bound of values to visualize in the given field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ minValue?: number; /** * The label used to describe the field or variable in the legend. * * [Read more...](global.html) */ label?: string; } export interface relationshipCreateRendererParamsLegendOptions { /** * The title used to describe the renderer in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ title?: string; /** * Indicates whether to include the renderer in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) */ showLegend?: boolean; } export interface relationshipUpdateRendererParams { /** * A numeric field used to explore its relationship with `field2`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#updateRenderer) */ field1: relationshipUpdateRendererParamsField1; /** * A numeric field used to explore its relationship with `field1`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#updateRenderer) */ field2: relationshipUpdateRendererParamsField2; /** * Determines the orientation of the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#updateRenderer) */ focus?: string; /** * Indicates the number of classes by which to break up the values of each field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#updateRenderer) */ numClasses: number; /** * The array of colors to be used by the symbols in the uniqueValueInfos of the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#updateRenderer) */ colors: Color[]; /** * The relationship renderer (generated from [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer)) to update with the other parameters provided in this method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#updateRenderer) */ renderer: UniqueValueRenderer; } export interface relationshipUpdateRendererParamsField1 { /** * The name of a numeric field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#updateRenderer) */ field: string; /** * The name of a numeric field used to normalize the given `field`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#updateRenderer) */ normalizationField?: string; /** * The class breaks for the first field used in the relationship visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#updateRenderer) */ classBreakInfos: ClassBreak[]; /** * The label used to describe the field or variable in the legend. * * [Read more...](global.html) */ label?: string; } export interface relationshipUpdateRendererParamsField2 { /** * The name of a numeric field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#updateRenderer) */ field: string; /** * The name of a numeric field used to normalize the given `field`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#updateRenderer) */ normalizationField?: string; /** * The class breaks for the second field used in the relationship visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#updateRenderer) */ classBreakInfos: ClassBreak[]; /** * The label used to describe the field or variable in the legend. * * [Read more...](global.html) */ label?: string; } /** * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#createRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#RendererResult) */ export interface relationshipRendererResult { /** * The renderer object representing the relationship visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#RendererResult) */ renderer: UniqueValueRenderer; /** * Describes each class break for both fields considered in the relationship visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#RendererResult) */ classBreaks: RendererResultClassBreaks; /** * Describes each container or bin used in the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#RendererResult) */ uniqueValueInfos: typeUniqueValueInfo[]; /** * The relationship scheme used by the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#RendererResult) */ relationshipScheme: RelationshipScheme; /** * The ID of the basemap used to determine the optimal fill colors of the features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#RendererResult) */ basemapId: string; /** * Indicates whether the average color of the input view's basemap is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#RendererResult) */ basemapTheme: string; } export interface RendererResultClassBreaks { /** * The class breaks generated for values in the `field1` parameter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#RendererResult) */ field1: ClassBreaksResult; /** * The class breaks generated for values in the `field2` parameter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html#RendererResult) */ field2: ClassBreaksResult; } /** * This object contains helper methods for generating data-driven visualizations with continuous size or class breaks based on a field value or expression from features in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html) */ interface size { /** * Generates a continuous size [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) representing the age of features based on one or more fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createAgeRenderer) */ createAgeRenderer(params: sizeCreateAgeRendererParams): Promise; /** * Generates a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html) that may be applied directly to the layer used to call this method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) */ createClassBreaksRenderer(params: sizeCreateClassBreaksRendererParams): Promise; /** * Generates a [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) that may be applied directly to the layer used to call this method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) */ createContinuousRenderer(params: sizeCreateContinuousRendererParams): Promise; /** * This method generates an array of size visual variables with default stops that are optimally chosen based on the statistics queried for the indicated field or expression and mapped to appropriate sizes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createVisualVariables) */ createVisualVariables(params: sizeCreateVisualVariablesParams): Promise; } export const size: size; /** * The result object of the [createAgeRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createAgeRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#AgeRendererResult) */ export interface sizeAgeRendererResult { /** * The renderer object configured to best match the view's background and the spread of the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#AgeRendererResult) */ renderer: ClassBreaksRenderer; /** * Size visual variables configured based on the statistics of the data and the size scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#AgeRendererResult) */ visualVariables: SizeVariable[]; /** * The time unit used to represent age in the output `renderer`. * * [Read more...](global.html#unit) */ unit: string; /** * The size scheme used by the visual variables. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#AgeRendererResult) */ sizeScheme: SizeScheme; /** * Indicates whether default values are used in the absence of sufficient data and/or statistics from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#AgeRendererResult) */ defaultValuesUsed: boolean; /** * Basic statistics returned from a query for the generated expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#AgeRendererResult) */ statistics: SummaryStatisticsResult; /** * The ID of the basemap used to determine the optimal fill color of the features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#AgeRendererResult) */ basemapId: string; /** * Indicates whether the average color of the input view's basemap is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#AgeRendererResult) */ basemapTheme: string; } /** * The result object of the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#ClassBreaksRendererResult) */ export interface sizeClassBreaksRendererResult { /** * The renderer object configured to best match the view's background and the spread of the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#ClassBreaksRendererResult) */ renderer: ClassBreaksRenderer; /** * This object describes class breaks generated from data in a layer for a given field with a specified classification method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#ClassBreaksRendererResult) */ classBreaksResult: ClassBreaksResult; /** * The size scheme used by the visual variables. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#ClassBreaksRendererResult) */ sizeScheme: SizeScheme; /** * Indicates whether default values are used in the absence of sufficient data and/or statistics from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#ClassBreaksRendererResult) */ defaultValuesUsed: boolean; /** * The ID of the basemap used to determine the optimal fill color of the features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#ClassBreaksRendererResult) */ basemapId: string; /** * Indicates whether the average color of the input view's basemap is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#ClassBreaksRendererResult) */ basemapTheme: string; } /** * The result object of the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#ContinuousRendererResult) */ export interface sizeContinuousRendererResult { /** * The renderer object configured to best match the background of the view and the spread of the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#ContinuousRendererResult) */ renderer: ClassBreaksRenderer; /** * Size visual variables configured based on the statistics of the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#ContinuousRendererResult) */ visualVariables: SizeVariable[]; /** * The size scheme used by the visual variables. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#ContinuousRendererResult) */ sizeScheme: SizeScheme; /** * Indicates whether default values are used in the absence of sufficient data and/or statistics from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#ContinuousRendererResult) */ defaultValuesUsed: boolean; /** * Basic statistics returned from a query to the service for data from the given field name or expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#ContinuousRendererResult) */ statistics: SummaryStatisticsResult; /** * The ID of the basemap used to determine the optimal fill color of the features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#ContinuousRendererResult) */ basemapId: string; /** * Indicates whether the average color of the input view's basemap is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#ContinuousRendererResult) */ basemapTheme: string; } export interface sizeCreateAgeRendererParams { /** * The layer for which the visualization is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createAgeRenderer) */ layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The view where the input layer is rendered. * * [Read more...](global.html) */ view: View; /** * The name of the field, or a date value representing the start time in the age calculation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createAgeRenderer) */ startTime: Date | string | number; /** * The name of the field, or a date value representing the end time in the age calculation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createAgeRenderer) */ endTime: Date | string | number; /** * The time unit used to calculate the difference between `endTime` and `startTime`. * * [Read more...](global.html#unit) */ unit?: "years" | "months" | "days" | "hours" | "minutes" | "seconds"; /** * Sets the size stops based on meaningful data values. * * @default high-to-low * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createAgeRenderer) */ theme?: "high-to-low" | "above" | "below"; /** * Sets a maximum age for the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createAgeRenderer) */ maxValue?: number; /** * Sets a minimum age for the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createAgeRenderer) */ minValue?: number; /** * Only for polygon layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createAgeRenderer) */ outlineOptimizationEnabled?: boolean; /** * Indicates whether symbol sizes should vary based on view scale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createAgeRenderer) */ sizeOptimizationEnabled?: boolean; /** * Provides options for modifying [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) properties describing the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createAgeRenderer) */ legendOptions?: sizeCreateAgeRendererParamsLegendOptions; /** * A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html) function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createAgeRenderer) */ statistics?: SummaryStatisticsResult; /** * In authoring apps, the user may select a pre-defined size scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createAgeRenderer) */ sizeScheme?: SizeScheme; /** * The type of symbol to generate. * * @default 2d * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createAgeRenderer) */ symbolType?: "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform"; /** * Enables the `defaultSymbol` on the renderer and assigns it to features with no value. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createAgeRenderer) */ defaultSymbolEnabled?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createAgeRenderer) */ signal?: AbortSignal; } export interface sizeCreateAgeRendererParamsLegendOptions { /** * The title used to represent the age size ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createAgeRenderer) */ title?: string; /** * Indicates whether to include the age renderer in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createAgeRenderer) */ showLegend?: boolean; } export interface sizeCreateClassBreaksRendererParams { /** * The layer for which the visualization is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) */ layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The view where the input layer is rendered. * * [Read more...](global.html) */ view?: View; /** * The name of the field whose data will be queried for statistics and classified. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) */ field?: string; /** * The name of the field to normalize the values of the given `field`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) */ normalizationField?: string; /** * Indicates how the data is normalized. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) */ normalizationType?: "field" | "log" | "percent-of-total"; /** * When `normalizationType` is `percent-of-total`, this property contains the total of all data values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) */ normalizationTotal?: number; /** * The classification method used for generating breaks. * * @default equal-interval * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) */ classificationMethod?: "equal-interval" | "natural-breaks" | "quantile" | "standard-deviation"; /** * If a `standard-deviation` classification method is used, then this indicates the interval by which to generate class breaks. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) */ standardDeviationInterval?: number; /** * The number of class breaks to generate. * * @default 5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) */ numClasses?: number; /** * In authoring apps, the user may select a pre-defined size scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) */ sizeScheme?: SizeScheme; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) */ valueExpression?: string; /** * Text describing the value returned from the `valueExpression`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) */ valueExpressionTitle?: string; /** * A SQL expression evaluating to a number. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) */ sqlWhere?: string; /** * Only for polygon layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) */ outlineOptimizationEnabled?: boolean; /** * Provides options for setting a title to describe a field instead of using the field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) */ legendOptions?: sizeCreateClassBreaksRendererParamsLegendOptions; /** * A minimum value set by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) */ minValue?: number; /** * A maximum value set by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) */ maxValue?: number; /** * Enables the `defaultSymbol` on the renderer and assigns it to features with no value and features that do not fall within the configured data range. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) */ defaultSymbolEnabled?: boolean; /** * The type of symbol to generate. * * @default 2d * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) */ symbolType?: "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform"; /** * Indicates whether the generated renderer is for a binning visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) */ forBinning?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) */ signal?: AbortSignal; } export interface sizeCreateClassBreaksRendererParamsLegendOptions { /** * The title used to represent the given field or expression in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) */ title?: string; } export interface sizeCreateContinuousRendererParams { /** * The layer for which the renderer is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) */ layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The view where the input layer is rendered. * * [Read more...](global.html) */ view?: View; /** * The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) */ field?: string; /** * The name of the field to normalize the values of the given `field`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) */ normalizationField?: string; /** * In authoring apps, the user may select a pre-defined size scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) */ sizeScheme?: SizeScheme; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) */ valueExpression?: string; /** * Text describing the value returned from the `valueExpression`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) */ valueExpressionTitle?: string; /** * Sets the size stops based on meaningful data values. * * @default high-to-low * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) */ theme?: "high-to-low" | "above" | "below"; /** * A SQL expression evaluating to a number. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) */ sqlWhere?: string; /** * Only for polygon layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) */ outlineOptimizationEnabled?: boolean; /** * Indicates whether symbol sizes should vary based on view scale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) */ sizeOptimizationEnabled?: boolean; /** * Provides options for setting a title to a field when an expression is provided instead of a field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) */ legendOptions?: sizeCreateContinuousRendererParamsLegendOptions; /** * A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html) function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) */ statistics?: SummaryStatisticsResult; /** * A custom minimum value set by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) */ minValue?: number; /** * A custom maximum value set by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) */ maxValue?: number; /** * Enables the `defaultSymbol` on the renderer and assigns it to features with no value and features that do not fall within the configured data range. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) */ defaultSymbolEnabled?: boolean; /** * The type of symbol to generate. * * @default 2d * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) */ symbolType?: "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform"; /** * Indicates whether the generated renderer is for a binning visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) */ forBinning?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) */ signal?: AbortSignal; } export interface sizeCreateContinuousRendererParamsLegendOptions { /** * The title used to represent the given field or expression in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) */ title?: string; /** * Indicates whether to describe the renderer in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) */ showLegend?: boolean; } export interface sizeCreateVisualVariablesParams { /** * The layer for which the visual variables are generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createVisualVariables) */ layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The view where the input layer is rendered. * * [Read more...](global.html) */ view?: View; /** * The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createVisualVariables) */ field: string; /** * The name of the field to normalize the values of the given `field`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createVisualVariables) */ normalizationField?: string; /** * In authoring apps, the user may select a pre-defined size scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createVisualVariables) */ sizeScheme?: SizeScheme; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createVisualVariables) */ valueExpression?: string; /** * Text describing the value returned from the `valueExpression`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createVisualVariables) */ valueExpressionTitle?: string; /** * Sets the size stops based on meaningful data values. * * @default high-to-low * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createVisualVariables) */ theme?: "high-to-low" | "above" | "below"; /** * A SQL expression evaluating to a number. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createVisualVariables) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createVisualVariables) */ sqlWhere?: string; /** * Indicates whether symbol sizes should vary based on view scale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createVisualVariables) */ sizeOptimizationEnabled?: boolean; /** * Provides options for setting a title to a field when an expression is provided instead of a field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createVisualVariables) */ legendOptions?: sizeCreateVisualVariablesParamsLegendOptions; /** * A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html) function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createVisualVariables) */ statistics?: SummaryStatisticsResult; /** * A custom minimum value set by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createVisualVariables) */ minValue?: number; /** * A custom maximum value set by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createVisualVariables) */ maxValue?: number; /** * Indicates if the size units of the symbols will be in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createVisualVariables) */ worldScale?: boolean; /** * When set to `all`, a single size variable that scales uniformly in all dimensions is generated. * * @default all * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createVisualVariables) */ axis?: "all" | "height"; /** * Indicates whether the generated renderer is for a binning visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createVisualVariables) */ forBinning?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createVisualVariables) */ signal?: AbortSignal; } export interface sizeCreateVisualVariablesParamsLegendOptions { /** * The title used to represent the given field or expression in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createVisualVariables) */ title?: string; /** * Indicates whether to describe the renderer in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createVisualVariables) */ showLegend?: boolean; } /** * The result object of the [createVisualVariables()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createVisualVariables) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#VisualVariableResult) */ export interface sizeVisualVariableResult { /** * An array of size visual variables configured based on the statistics of the data and the view scale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#VisualVariableResult) */ visualVariables: SizeVariable[]; /** * The size scheme used by the main visual variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#VisualVariableResult) */ sizeScheme: SizeScheme; /** * Indicates whether default values were used in the absence of sufficient data and/or statistics from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#VisualVariableResult) */ defaultValuesUsed: boolean; /** * Basic statistics returned from a query to the service for the given field or expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#VisualVariableResult) */ statistics: SummaryStatisticsResult; /** * The ID of the basemap used to determine the optimal fill color of the features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#VisualVariableResult) */ basemapId: string; /** * Indicates whether the average color of the input view's basemap is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#VisualVariableResult) */ basemapTheme: string; /** * Authoring information related to the creation of the visual variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#VisualVariableResult) */ authoringInfo: AuthoringInfo; } /** * This object contains helper methods for generating data-driven visualizations with unique types (or categories) based on a field value from features in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html) */ interface type { /** * Generates a [PointCloudUniqueValueRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html) based on a given field of a [PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createPCClassRenderer) */ createPCClassRenderer(params: typeCreatePCClassRendererParams): Promise; /** * Generates a [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) that may be applied directly to a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) that supports renderers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) */ createRenderer(params: typeCreateRendererParams): Promise; } export const type: type; /** * The result object of the [createPCClassRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createPCClassRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#PCClassRendererResult) */ export interface PCClassRendererResult { /** * The renderer object configured to represent the class codes in the point cloud. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#PCClassRendererResult) */ renderer: PointCloudUniqueValueRenderer; } /** * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#RendererResult) */ export interface typeRendererResult { /** * The renderer object configured to best match the background of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#RendererResult) */ renderer: UniqueValueRenderer; /** * An array of objects describing the value, symbol, and count of each unique type or category represented in the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#RendererResult) */ uniqueValueInfos: typeUniqueValueInfo[]; /** * An array of objects describing the values or categories excluded from consideration in visualizing data from the given field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#RendererResult) */ excludedUniqueValueInfos: any[]; /** * The scheme used to represent each category within the `uniqueValueInfos`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#RendererResult) */ typeScheme: TypeScheme; /** * The ID of the basemap used to determine the optimal color scheme to represent the categorical variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#RendererResult) */ basemapId: string; /** * Indicates whether the average color of the input view's basemap is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#RendererResult) */ basemapTheme: string; } export interface typeCreatePCClassRendererParams { /** * The layer for which the visualization is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createPCClassRenderer) */ layer: PointCloudLayer; /** * The name of the field containing classification data for the given layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createPCClassRenderer) */ field: string; /** * The size of each point expressed as a percentage. * * @default 100% * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createPCClassRenderer) */ size?: string; /** * The number of points per inch in the view. * * @default 25 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createPCClassRenderer) */ density?: number; /** * In authoring apps, the user may select a pre-defined type scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createPCClassRenderer) */ typeScheme?: TypeSchemeForPoint; /** * A statistics object generated from the [uniqueValues](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-uniqueValues.html) function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createPCClassRenderer) */ statistics?: UniqueValuesResult; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createPCClassRenderer) */ signal?: AbortSignal; } export interface typeCreateRendererParams { /** * The layer for which the renderer is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) */ layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The view where the input layer is rendered. * * [Read more...](global.html) */ view?: View; /** * The name of the field from which to extract unique values that will be used for the basis of the data-driven visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) */ field?: string; /** * Specifies the name of a second attribute field used to categorize features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) */ field2?: string; /** * Specifies the name of a third attribute field used to categorize features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) */ field3?: string; /** * The number of types (or categories) displayed by the renderer. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) */ numTypes?: number; /** * Indicates how values should be sorted in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * @default count * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) */ sortBy?: "count" | "value" | "none"; /** * In authoring apps, the user may select a pre-defined type scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) */ typeScheme?: TypeScheme; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) */ valueExpression?: string; /** * Text describing the value returned from the `valueExpression`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) */ valueExpressionTitle?: string; /** * For polygon layers only. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) */ outlineOptimizationEnabled?: boolean; /** * For point and polyline layers only. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) */ sizeOptimizationEnabled?: boolean; /** * Provides options for setting a title to a field that will override the field alias defined in the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) */ legendOptions?: typeCreateRendererParamsLegendOptions; /** * Enables the `defaultSymbol` on the renderer and assigns it to features with no value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) */ defaultSymbolEnabled?: boolean; /** * The type of symbol to generate. * * @default 2d * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) */ symbolType?: "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform"; /** * A statistics object generated from the [uniqueValues](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-uniqueValues.html) function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) */ statistics?: UniqueValuesResult; /** * **This option only applies to generating renderers for mesh SceneLayers**. * * @default replace * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) */ colorMixMode?: string; /** * Indicates that all domain codes should be returned if the given field has domain values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) */ returnAllCodedValues?: boolean; /** * Indicates whether the generated renderer is for a binning visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) */ forBinning?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) */ signal?: AbortSignal; } export interface typeCreateRendererParamsLegendOptions { /** * The title used to represent the given field in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) */ title: string; } /** * Describes the symbol, label, and value of a unique value generated by the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#UniqueValueInfo) */ export interface typeUniqueValueInfo { /** * A unique value representing a type or category of features in a layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#UniqueValueInfo) */ value: string | number; /** * The number of features with the given `value` (or belonging to the given category). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#UniqueValueInfo) */ count: number; /** * The label describing the value or category in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](global.html) */ label: string; /** * The symbol used to represent features belonging to the given category. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#UniqueValueInfo) */ symbol: Symbol; } /** * This object contains helper methods for generating data-driven univariate visualizations using both continuous color and continuous size based on a single field value or expression from features in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html) */ interface univariateColorSize { /** * Generates a [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) that may be applied directly to a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ createContinuousRenderer(params: univariateColorSizeCreateContinuousRendererParams): Promise; /** * This method generates color and size visual variables, both based on the same given field or expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ createVisualVariables(params: univariateColorSizeCreateVisualVariablesParams): Promise; } export const univariateColorSize: univariateColorSize; /** * The result object of the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#ContinuousRendererResult) */ export interface univariateColorSizeContinuousRendererResult { /** * The renderer object configured to best match the view's background and the spread of the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#ContinuousRendererResult) */ renderer: ClassBreaksRenderer; /** * Object containing visual variable and scheme information for the color portion of the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#ContinuousRendererResult) */ color: ContinuousRendererResultColor; /** * Object containing visual variable and scheme information for the size portion of the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#ContinuousRendererResult) */ size: ContinuousRendererResultSize; /** * Indicates whether default values were used in the absence of sufficient data and/or statistics from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#ContinuousRendererResult) */ defaultValuesUsed: boolean; /** * Basic statistics returned from a query to the service for the given field or expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#ContinuousRendererResult) */ statistics: SummaryStatisticsResult; /** * The ID of the basemap used to determine the optimal fill color of the features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#ContinuousRendererResult) */ basemapId: string; /** * Indicates whether the average color of the input view's basemap is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#ContinuousRendererResult) */ basemapTheme: string; } export interface univariateColorSizeCreateContinuousRendererParams { /** * The layer for which the visual variable is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The view where the input layer is rendered. * * [Read more...](global.html) */ view?: View; /** * The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ field?: string; /** * The name of the field to normalize the values of the given `field`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ normalizationField?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ valueExpression?: string; /** * Text describing the value returned from the `valueExpression`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ valueExpressionTitle?: string; /** * Sets the size stops and colors based on meaningful data values. * * @default high-to-low * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ theme?: "high-to-low" | "above" | "below" | "above-and-below"; /** * A SQL expression evaluating to a number. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ sqlWhere?: string; /** * A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html) function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ statistics?: SummaryStatisticsResult; /** * A custom minimum value set by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ minValue?: number; /** * A custom maximum value set by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ maxValue?: number; /** * Enables the `defaultSymbol` on the renderer and assigns it to features with no value and features that do not fall within the configured data range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ defaultSymbolEnabled?: boolean; /** * Options for configuring the color portion of the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ colorOptions?: univariateColorSizeCreateContinuousRendererParamsColorOptions; /** * Options for configuring the size portion of the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ sizeOptions?: univariateColorSizeCreateContinuousRendererParamsSizeOptions; /** * Options for setting symbols for the `above-and-below` theme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ symbolOptions?: univariateColorSizeCreateContinuousRendererParamsSymbolOptions; /** * Provides options for configuring the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) representing the renderer generated from this method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ legendOptions?: univariateColorSizeCreateContinuousRendererParamsLegendOptions; /** * The type of symbol to generate. * * @default 2d * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ symbolType?: "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform"; /** * Indicates whether the generated renderer is for a binning visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ forBinning?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ signal?: AbortSignal; } export interface univariateColorSizeCreateContinuousRendererParamsColorOptions { /** * In authoring apps, the user may select a pre-defined color scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ colorScheme?: ColorScheme; /** * Only applies to the `above-and-below` theme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ isContinuous?: boolean; } export interface univariateColorSizeCreateContinuousRendererParamsLegendOptions { /** * The title used to represent the renderer generated from this method in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ title?: string; /** * Indicates if the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget should display content describing the generated renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ showLegend?: boolean; } export interface univariateColorSizeCreateContinuousRendererParamsSizeOptions { /** * In authoring apps, the user may select a pre-defined size scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ sizeScheme?: SizeScheme; /** * Indicates whether symbol sizes should vary based on view scale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ sizeOptimizationEnabled?: boolean; } export interface univariateColorSizeCreateContinuousRendererParamsSymbolOptions { /** * Sets above and below symbols based on pre-defined named symbol pairs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ symbolStyle?: | "caret" | "circle-caret" | "arrow" | "circle-arrow" | "plus-minus" | "circle-plus-minus" | "square" | "circle" | "triangle" | "happy-sad" | "thumb"; /** * Allows you to specify custom symbols in the `above-and-below` theme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ symbols?: univariateColorSizeCreateContinuousRendererParamsSymbolOptionsSymbols; } export interface univariateColorSizeCreateContinuousRendererParamsSymbolOptionsSymbols { /** * The symbol to use for the above portion of the `above-and-below` visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ above: Symbol; /** * The symbol to use for the below portion of the `above-and-below` visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) */ below: Symbol; } export interface univariateColorSizeCreateVisualVariablesParams { /** * The layer for which the visual variable is generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The view where the input layer is rendered. * * [Read more...](global.html) */ view?: View; /** * The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ field?: string; /** * The name of the field to normalize the values of the given `field`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ normalizationField?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ valueExpression?: string; /** * Text describing the value returned from the `valueExpression`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ valueExpressionTitle?: string; /** * Sets the size stops and colors based on meaningful data values. * * @default high-to-low * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ theme?: "high-to-low" | "above" | "below" | "above-and-below"; /** * A SQL expression evaluating to a number. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ sqlWhere?: string; /** * A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html) function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ statistics?: SummaryStatisticsResult; /** * A custom minimum value set by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ minValue?: number; /** * A custom maximum value set by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ maxValue?: number; /** * Options for configuring the color portion of the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ colorOptions?: univariateColorSizeCreateVisualVariablesParamsColorOptions; /** * Options for configuring the size portion of the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ sizeOptions?: univariateColorSizeCreateVisualVariablesParamsSizeOptions; /** * Indicates if the size units of the symbols will be in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ worldScale?: boolean; /** * Indicates whether the generated renderer is for a binning visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ forBinning?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ signal?: AbortSignal; } export interface univariateColorSizeCreateVisualVariablesParamsColorOptions { /** * Determines which values will be emphasized in the continuous ramp and the map. * * @default high-to-low * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ theme?: "high-to-low" | "above-and-below" | "centered-on" | "extremes"; /** * In authoring apps, the user may select a pre-defined color scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ colorScheme?: ColorScheme; /** * Provides options for setting a title to a field when an expression is provided instead of a field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ legendOptions?: univariateColorSizeCreateVisualVariablesParamsColorOptionsLegendOptions; /** * Only applies to the `above-and-below` theme. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ isContinuous?: boolean; } export interface univariateColorSizeCreateVisualVariablesParamsColorOptionsLegendOptions { /** * The title used to represent the given field or expression in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ title: string; } export interface univariateColorSizeCreateVisualVariablesParamsSizeOptions { /** * When set to `all`, a single size variable that scales uniformly in all dimensions is generated. * * @default all * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ axis?: "all" | "height"; /** * In authoring apps, the user may select a pre-defined size scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ sizeScheme?: SizeScheme; /** * Provides options for setting a title to a field when an expression is provided instead of a field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ legendOptions?: univariateColorSizeCreateVisualVariablesParamsSizeOptionsLegendOptions; } export interface univariateColorSizeCreateVisualVariablesParamsSizeOptionsLegendOptions { /** * The title used to represent the given field or expression in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) */ title: string; } /** * The result object of the [createVisualVariables()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createVisualVariables) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#VisualVariablesResult) */ export interface VisualVariablesResult { /** * Object containing visual variable and scheme information for the color portion of the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#VisualVariablesResult) */ color: VisualVariablesResultColor; /** * Object containing visual variable and scheme information for the size portion of the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#VisualVariablesResult) */ size: VisualVariablesResultSize; /** * Indicates whether default values were used in the absence of sufficient data and/or statistics from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#VisualVariablesResult) */ defaultValuesUsed: boolean; /** * Basic statistics returned from a query to the service for the given field or expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#VisualVariablesResult) */ statistics: SummaryStatisticsResult; /** * The ID of the basemap used to determine the optimal fill color of the features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#VisualVariablesResult) */ basemapId: string; /** * Indicates whether the average color of the input view's basemap is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#VisualVariablesResult) */ basemapTheme: string; /** * Authoring information related to the creation of the visual variables. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#VisualVariablesResult) */ authoringInfo: AuthoringInfo; } export interface ContinuousRendererResultColor { /** * A color visual variable configured based on the statistics of the data and the color scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#ContinuousRendererResult) */ visualVariable: ColorVariable; /** * The color scheme used by the visual variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#ContinuousRendererResult) */ colorScheme: ColorScheme; } export interface ContinuousRendererResultSize { /** * The size visual variable(s) configured based on the statistics of the data and the view scale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#ContinuousRendererResult) */ visualVariables: SizeVariable[]; /** * The size scheme used by the visual variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#ContinuousRendererResult) */ sizeScheme: SizeScheme; } export interface VisualVariablesResultColor { /** * A color visual variable configured based on the statistics of the data and the color scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#VisualVariablesResult) */ visualVariable: ColorVariable; /** * The color scheme used by the visual variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#VisualVariablesResult) */ colorScheme: ColorScheme; } export interface VisualVariablesResultSize { /** * The size visual variable(s) configured based on the statistics of the data and the view scale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#VisualVariablesResult) */ visualVariables: SizeVariable[]; /** * The size scheme used by the visual variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#VisualVariablesResult) */ sizeScheme: SizeScheme; } /** * Function for generating class breaks for an input field in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) based on a given classification method and normalization type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html) */ interface statisticsClassBreaks { /** * Generates class breaks for an input field (or expression) of a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) based on a given classification method and normalization type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#classBreaks) */ classBreaks(params: classBreaksClassBreaksParams): Promise; } const __statisticsClassBreaksMapped: statisticsClassBreaks; export const statisticsClassBreaks: typeof __statisticsClassBreaksMapped.classBreaks; /** * An object describing a single class break generated from the [classBreaks()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#classBreaks) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#ClassBreak) */ export interface ClassBreak { /** * The label describing the given class break for use in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](global.html) */ label: string; /** * The lower bound of the class break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#ClassBreak) */ minValue: number; /** * The upper bound of the class break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#ClassBreak) */ maxValue: number; } export interface classBreaksClassBreaksParams { /** * The layer from which to generate class breaks. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#classBreaks) */ layer: | FeatureLayer | SceneLayer | CSVLayer | PointCloudLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The class breaks will be generated based on values of this field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#classBreaks) */ field?: string; /** * The field by which to normalize the values returned from the given `field`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#classBreaks) */ normalizationField?: string; /** * The method for classifying the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#classBreaks) */ classificationMethod?: "equal-interval" | "natural-breaks" | "quantile" | "standard-deviation"; /** * When `classificationMethod = "standard-deviation"`, this sets the interval at which each class break should be set (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#classBreaks) */ standardDeviationInterval?: number; /** * The minimum bounding value for the class breaks definition. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#classBreaks) */ minValue?: number; /** * The maximum bounding value for the class breaks definition. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#classBreaks) */ maxValue?: number; /** * Indicates the number of classes to generate for the class breaks definition. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#classBreaks) */ numClasses?: number; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#classBreaks) */ valueExpression?: string; /** * A SQL expression evaluating to a number. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#classBreaks) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#classBreaks) */ sqlWhere?: string; /** * A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) instance is required when a `valueExpression` is specified. * * [Read more...](global.html) */ view?: View; /** * A feature filter used to filter statistic queries by geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#classBreaks) */ filter?: FeatureFilter; /** * A subset of features for which to generate the class breaks. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#classBreaks) */ features?: Graphic[]; /** * Only applicable when the input `layer` is a service-backed FeatureLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#classBreaks) */ useFeaturesInView?: boolean; /** * Indicates whether the generated statistics are for a binning or clustering visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#classBreaks) */ forBinning?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#classBreaks) */ signal?: AbortSignal; } /** * Object returned from the [classBreaks()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#classBreaks) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#ClassBreaksResult) */ export interface ClassBreaksResult { /** * An array of objects describing the class breaks generated from the [classBreaks()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#classBreaks) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#ClassBreaksResult) */ classBreakInfos: ClassBreak[]; /** * The minimum value of features in the dataset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#ClassBreaksResult) */ minValue: number; /** * The maximum value of features in the dataset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#ClassBreaksResult) */ maxValue: number; /** * The normalization total if `normalizationType` is set to `percent-of-total` when generating class breaks with [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-classBreaks.html#ClassBreaksResult) */ normalizationTotal: number; } /** * Function for generating statistics from a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) for a [HeatmapRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html) visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-heatmapStatistics.html) */ interface heatmapStatistics { /** * Returns an object containing various statistics describing the intensity values for a heatmap visualization of a given point [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-heatmapStatistics.html#heatmapStatistics) */ heatmapStatistics(params: heatmapStatisticsHeatmapStatisticsParams): Promise; } const __heatmapStatisticsMapped: heatmapStatistics; export const heatmapStatistics: typeof __heatmapStatisticsMapped.heatmapStatistics; export interface heatmapStatisticsHeatmapStatisticsParams { /** * The layer from which to generate statistics for the pixel intensity values and a given `field` if provided. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-heatmapStatistics.html#heatmapStatistics) */ layer: FeatureLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * A view instance used to calculate pixel intensity values based on the features in the current view. * * [Read more...](global.html) */ view: MapView | SceneView; /** * The name of the numeric field for which the statistics will be generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-heatmapStatistics.html#heatmapStatistics) */ field?: string; /** * The area of influence for each point as a radius in points from the point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-heatmapStatistics.html#heatmapStatistics) */ radius?: number; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-heatmapStatistics.html#heatmapStatistics) */ signal?: AbortSignal; } /** * The statistics returned from the [heatmapStatistics()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-heatmapStatistics.html#heatmapStatistics) function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-heatmapStatistics.html#HeatmapStatisticsResult) */ export interface HeatmapStatisticsResult { /** * The maximum kernel density value of all pixels in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-heatmapStatistics.html#HeatmapStatisticsResult) */ max: number; /** * The minimum kernel density value of all pixels in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-heatmapStatistics.html#HeatmapStatisticsResult) */ min: number; } /** * Generates a histogram based on data in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) for a given field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html) */ interface histogram { /** * Generates a histogram for data returned from a `field` in a given `layer`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#histogram) */ histogram(params: histogramHistogramParams): Promise; } const __histogramMapped: histogram; export const histogram: typeof __histogramMapped.histogram; export interface histogramHistogramParams { /** * The layer for which to generate a histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#histogram) */ layer: | FeatureLayer | SceneLayer | CSVLayer | PointCloudLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The name of the numeric field for which the histogram will be generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#histogram) */ field?: string; /** * Determines how the provided `field` values will be normalized. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#histogram) */ normalizationType?: "field" | "log" | "percent-of-total" | "natural-log" | "square-root"; /** * The field by which to normalize the values returned from the given `field`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#histogram) */ normalizationField?: string; /** * Only applies if `normalizationType` is `percent-of-total`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#histogram) */ normalizationTotal?: number; /** * The method for classifying the data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#histogram) */ classificationMethod?: "equal-interval" | "natural-breaks" | "quantile" | "standard-deviation"; /** * When `classificationMethod = "standard-deviation"`, this sets the interval at which each class break should be set (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#histogram) */ standardDeviationInterval?: number; /** * The minimum bounding value for the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#histogram) */ minValue?: number; /** * The maximum bounding value for the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#histogram) */ maxValue?: number; /** * Indicates the number of classes to generate for the histogram. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#histogram) */ numBins?: number; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#histogram) */ valueExpression?: string; /** * A SQL expression evaluating to a number. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#histogram) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#histogram) */ sqlWhere?: string; /** * A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) instance is required when a `valueExpression` is specified. * * [Read more...](global.html) */ view?: View; /** * A feature filter used to filter statistic queries by geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#histogram) */ filter?: FeatureFilter; /** * A subset of features for which to generate the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#histogram) */ features?: Graphic[]; /** * Only applicable when the input `layer` is a service-backed FeatureLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#histogram) */ useFeaturesInView?: boolean; /** * Indicates whether the generated statistics are for a binning or clustering visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#histogram) */ forBinning?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#histogram) */ signal?: AbortSignal; } /** * The result returned from the [histogram()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#histogram) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#HistogramResult) */ export interface HistogramResult { /** * An array of objects representing each bin in the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#HistogramResult) */ bins: Bin[]; /** * The minimum value returned by the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#HistogramResult) */ minValue: number; /** * The maximum value returned by the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#HistogramResult) */ maxValue: number; /** * The number used to normalize all values when `percent-of-total` is specified as the `normalizationType`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#HistogramResult) */ normalizationTotal?: number; } /** * Function for generating category statistics for a [predominance](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html) renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-predominantCategories.html) */ interface predominantCategories { /** * Determines predominant categories for a layer based on a given set of competing numeric fields and returns the number of features belonging to each category. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-predominantCategories.html#predominantCategories) */ predominantCategories(params: predominantCategoriesPredominantCategoriesParams): Promise; } const __predominantCategoriesMapped: predominantCategories; export const predominantCategories: typeof __predominantCategoriesMapped.predominantCategories; export interface predominantCategoriesPredominantCategoriesParams { /** * The layer from which to generate predominant categories for the given set of `fields`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-predominantCategories.html#predominantCategories) */ layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * An array of numeric fields from which to determine predominant categories. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-predominantCategories.html#predominantCategories) */ fields: string[]; /** * Indicates whether the generated statistics are for a binning or clustering visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-predominantCategories.html#predominantCategories) */ forBinning?: boolean; /** * The view in which features will be rendered. * * [Read more...](global.html) */ view?: MapView | SceneView; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-predominantCategories.html#predominantCategories) */ signal?: AbortSignal; } /** * The statistics returned from the [predominantCategories()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-predominantCategories.html#predominantCategories) function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-predominantCategories.html#PredominantCategoriesResult) */ export interface PredominantCategoriesResult { /** * An array of objects describing the count of each predominant category. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-predominantCategories.html#PredominantCategoriesResult) */ predominantCategoryInfos: PredominantCategoriesResultPredominantCategoryInfos[]; } export interface PredominantCategoriesResultPredominantCategoryInfos { /** * The value or category referenced in a predominance visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-predominantCategories.html#PredominantCategoriesResult) */ value: string | number; /** * The number of features belonging to the predominant category. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-predominantCategories.html#PredominantCategoriesResult) */ count: number; /** * The label describing the predominant category, or field name. * * [Read more...](global.html) */ label?: string; } /** * Function for generating attribute statistics in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) based on values returned from a given field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html) */ interface summaryStatistics { /** * Returns an object containing statistics describing a set of values returned from a field (or expression) in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ summaryStatistics(params: summaryStatisticsSummaryStatisticsParams): Promise; } const __summaryStatisticsMapped: summaryStatistics; export const summaryStatistics: typeof __summaryStatisticsMapped.summaryStatistics; /** * The statistics returned from the [summaryStatistics()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#summaryStatistics) query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#SummaryStatisticsResult) */ export interface SummaryStatisticsResult { /** * The average of all values returned from the field or expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#SummaryStatisticsResult) */ avg: number; /** * The total number of features with a non-null value for the given field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#SummaryStatisticsResult) */ count: number; /** * The maximum of all values returned from the field or expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#SummaryStatisticsResult) */ max: number; /** * The median of all values returned from the field or expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#SummaryStatisticsResult) */ median: number; /** * The minimum of all values returned from the field or expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#SummaryStatisticsResult) */ min: number; /** * The standard deviation calculated from values returned from the field or expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#SummaryStatisticsResult) */ stddev: number; /** * The sum of all values returned from the field or expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#SummaryStatisticsResult) */ sum: number; /** * The calculated variance from all values returned from the field or expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#SummaryStatisticsResult) */ variance: number; /** * The number of null values stored in the given field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#SummaryStatisticsResult) */ nullcount?: number; } export interface summaryStatisticsSummaryStatisticsParams { /** * The layer from which to generate statistics for the given `field`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ layer: | FeatureLayer | SceneLayer | CSVLayer | PointCloudLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The name of the numeric or string field for which the summary statistics will be generated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ field?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ valueExpression?: string; /** * A SQL expression evaluating to a number. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ sqlWhere?: string; /** * Determines how the provided `field` values will be normalized. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ normalizationType?: "field" | "log" | "percent-of-total" | "natural-log" | "square-root"; /** * The field by which to normalize the values returned from the given `field`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ normalizationField?: string; /** * Only applies if `normalizationType` is `percent-of-total`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ normalizationTotal?: number; /** * The minimum bounding value for the statistics calculation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ minValue?: number; /** * The maximum bounding value for the statistics calculation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ maxValue?: number; /** * A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) instance is required when a `valueExpression` is specified. * * [Read more...](global.html) */ view?: View; /** * A feature filter used to filter statistic queries by geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ filter?: FeatureFilter; /** * A subset of features for which to calculate the statistics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ features?: Graphic[]; /** * Only applicable when the input `layer` is a service-backed FeatureLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ useFeaturesInView?: boolean; /** * Indicates whether the generated statistics are for a binning or clustering visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ forBinning?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ signal?: AbortSignal; } /** * Function for generating statistics for the age of features in a layer based on a given start time and end time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatisticsForAge.html) */ interface summaryStatisticsForAge { /** * Returns an object containing various statistics describing an age value (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatisticsForAge.html#summaryStatisticsForAge) */ summaryStatisticsForAge(params: summaryStatisticsForAgeSummaryStatisticsForAgeParams): Promise; } const __summaryStatisticsForAgeMapped: summaryStatisticsForAge; export const summaryStatisticsForAge: typeof __summaryStatisticsForAgeMapped.summaryStatisticsForAge; export interface summaryStatisticsForAgeSummaryStatisticsForAgeParams { /** * The layer from which to generate age statistics for the given `startTime` and `endTime`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatisticsForAge.html#summaryStatisticsForAge) */ layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The start time for the age calculation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatisticsForAge.html#summaryStatisticsForAge) */ startTime: Date | string | number; /** * The end time for the age calculation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatisticsForAge.html#summaryStatisticsForAge) */ endTime: Date | string | number; /** * The desired units of the age result. * * [Read more...](global.html#unit) */ unit: "years" | "months" | "days" | "hours" | "minutes" | "seconds"; /** * The view in which features will be rendered. * * [Read more...](global.html) */ view?: MapView | SceneView; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatisticsForAge.html#summaryStatisticsForAge) */ signal?: AbortSignal; } /** * Provides utility functions for generating [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expressions intended for use in an [age renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createAgeRenderer). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-ageUtils.html) */ interface ageUtils { /** * Returns an [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression for visualizing the age of a feature based on a given start time and end time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-ageUtils.html#getAgeExpressions) */ getAgeExpressions(params: ageUtilsGetAgeExpressionsParams): AgeExpressionsResult; } export const ageUtils: ageUtils; /** * The result object returned from the [getAgeExpressions()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-ageUtils.html#getAgeExpressions) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-ageUtils.html#AgeExpressionsResult) */ export interface AgeExpressionsResult { /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-ageUtils.html#AgeExpressionsResult) */ valueExpression: string; /** * A SQL expression and where clause that matches the generated `valueExpression` used to query statistics from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-ageUtils.html#AgeExpressionsResult) */ statisticsQuery: any; /** * A SQL expression and where clause that matches the generated `valueExpression` used to query for a histogram from the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-ageUtils.html#AgeExpressionsResult) */ histogramQuery: any; } export interface ageUtilsGetAgeExpressionsParams { /** * The layer from which to generate age statistics for the given `startTime` and `endTime`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-ageUtils.html#getAgeExpressions) */ layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The start time for the age calculation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-ageUtils.html#getAgeExpressions) */ startTime: Date | string | number; /** * The end time for the age calculation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-ageUtils.html#getAgeExpressions) */ endTime: Date | string | number; /** * The desired units of the age result. * * [Read more...](global.html#unit) */ unit?: "years" | "months" | "days" | "hours" | "minutes" | "seconds"; } /** * Provides utility functions for generating [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) and SQL expressions intended for use in an [predominance renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-predominanceUtils.html) */ interface predominanceUtils { /** * Returns [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) and SQL expressions used for visualizing the predominant category (or field) among a set of competing fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-predominanceUtils.html#getPredominanceExpressions) */ getPredominanceExpressions(layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer, fieldNames: string[]): PredominantExpressions; } export const predominanceUtils: predominanceUtils; /** * Contains the Arcade and SQL expressions used to query feature services and client-side layers for the strength of the predominant category compared with all other categories. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-predominanceUtils.html#OpacityExpressionInfo) */ export interface OpacityExpressionInfo { /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-predominanceUtils.html#OpacityExpressionInfo) */ valueExpression: string; /** * The SQL expressions used for querying the percentage the predominant value comprises among of a set of fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-predominanceUtils.html#OpacityExpressionInfo) */ statisticsQuery: SQLExpressionInfo; /** * The SQL expressions used for querying the histogram using the percentage the predominant value comprises among of a set of fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-predominanceUtils.html#OpacityExpressionInfo) */ histogramQuery: SQLExpressionInfo; } /** * The result object returned from the [getAgeExpressions()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-predominanceUtils.html#getAgeExpressions) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-predominanceUtils.html#PredominantExpressions) */ export interface PredominantExpressions { /** * The Arcade expression used to get the predominant category among a set of fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-predominanceUtils.html#PredominantExpressions) */ predominantCategory: PredominantExpressionsPredominantCategory; /** * The Arcade and SQL expressions used to query the server or client-side layer for statistics of the sum of all competing fields considered for the predominance visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-predominanceUtils.html#PredominantExpressions) */ size: SizeExpressionInfo; /** * The Arcade and SQL expressions used to query the server or client-side layer for statistics of the percentage among all competing fields comprised by the predominant category. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-predominanceUtils.html#PredominantExpressions) */ opacity: OpacityExpressionInfo; } /** * Contains the Arcade and SQL expressions used to query feature services and client-side layers for the sum of all values considered in a predominance visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-predominanceUtils.html#SizeExpressionInfo) */ export interface SizeExpressionInfo { /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-predominanceUtils.html#SizeExpressionInfo) */ valueExpression: string; /** * The SQL expressions used for querying the sum of a set of fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-predominanceUtils.html#SizeExpressionInfo) */ statisticsQuery: SQLExpressionInfo; /** * The SQL expressions used for querying the histogram for the sum of a set of fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-predominanceUtils.html#SizeExpressionInfo) */ histogramQuery: SQLExpressionInfo; } /** * SQL expressions used to query feature services for predominant values and related statistics given a set of fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-predominanceUtils.html#SQLExpressionInfo) */ export interface SQLExpressionInfo { /** * The SQL expression used for querying the predominant category given a set of fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-predominanceUtils.html#SQLExpressionInfo) */ sqlExpression: string; /** * The SQL where clause used to query the predominant value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-predominanceUtils.html#SQLExpressionInfo) */ sqlWhere: string; } export interface PredominantExpressionsPredominantCategory { /** * valueExpression - An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-predominanceUtils.html#PredominantExpressions) */ valueExpression: string; } /** * A function that queries for unique values from a field in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-uniqueValues.html) */ interface uniqueValues { /** * Returns an object containing an array of unique values queried from a given field (or values returned from an expression) in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) along with the total count of features that belong to the given category. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-uniqueValues.html#uniqueValues) */ uniqueValues(params: uniqueValuesUniqueValuesParams): Promise; } const __uniqueValuesMapped: uniqueValues; export const uniqueValues: typeof __uniqueValuesMapped.uniqueValues; /** * An object that contains the unique values returned from the [uniqueValues()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-uniqueValues.html#uniqueValues) query of a layer's field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-uniqueValues.html#UniqueValuesResult) */ export interface UniqueValuesResult { /** * An array of objects, each containing a unique value/type/category present in the field specified in the [uniqueValues()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-uniqueValues.html#uniqueValues) query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-uniqueValues.html#UniqueValuesResult) */ uniqueValueInfos: UniqueValuesResultUniqueValueInfos[]; } export interface uniqueValuesUniqueValuesParams { /** * The layer from which to query for unique values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-uniqueValues.html#uniqueValues) */ layer: | FeatureLayer | SceneLayer | CSVLayer | PointCloudLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; /** * The name of the numeric or string field from which the unique values will be obtained. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-uniqueValues.html#uniqueValues) */ field?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-uniqueValues.html#uniqueValues) */ valueExpression?: string; /** * A SQL expression evaluating to a number or string. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-uniqueValues.html#uniqueValues) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-uniqueValues.html#uniqueValues) */ sqlWhere?: string; /** * Indicates that all domain codes should be returned if the given field has domain values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-uniqueValues.html#uniqueValues) */ returnAllCodedValues?: boolean; /** * A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) instance is required when a `valueExpression` is specified. * * [Read more...](global.html) */ view?: View; /** * A feature filter used to filter statistic queries by geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-uniqueValues.html#uniqueValues) */ filter?: FeatureFilter; /** * A subset of features for which to generate the unique values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-uniqueValues.html#uniqueValues) */ features?: Graphic[]; /** * Only applicable when the input `layer` is a service-backed FeatureLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-uniqueValues.html#uniqueValues) */ useFeaturesInView?: boolean; /** * Indicates whether the generated statistics are for a binning or clustering visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-uniqueValues.html#uniqueValues) */ forBinning?: boolean; /** * Allows for cancelable requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-uniqueValues.html#uniqueValues) */ signal?: AbortSignal; } export interface UniqueValuesResultUniqueValueInfos { /** * A unique value representing a type or category of features in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-uniqueValues.html#UniqueValuesResult) */ value: string | number; /** * The number of features assigned the given `value` (or belonging to the given category). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-uniqueValues.html#UniqueValuesResult) */ count: number; } /** * Object containing helper methods for generating optimal symbols for data-driven color visualizations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html) */ interface symbologyColor { /** * Clones a color scheme object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#cloneScheme) */ cloneScheme(scheme: ColorScheme): ColorScheme; /** * Flips the colors in reverse order of the input color scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#flipColors) */ flipColors(scheme: ColorScheme): ColorScheme; /** * Returns all schemes matching the given color ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getMatchingSchemes) */ getMatchingSchemes(params: colorGetMatchingSchemesParams): ColorScheme[]; /** * Returns a color scheme with the provided name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getSchemeByName) */ getSchemeByName(params: colorGetSchemeByNameParams): ColorScheme; /** * Returns a primary scheme and secondary schemes defining symbol properties for data-driven color visualizations in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getSchemes) */ getSchemes(params: colorGetSchemesParams): ColorSchemes; /** * Returns an array of color schemes with the provided tags. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getSchemesByTag) */ getSchemesByTag(params: colorGetSchemesByTagParams): ColorScheme[]; /** * Returns metadata for the available themes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getThemes) */ getThemes(basemap?: string | Basemap): colorTheme[]; } export const symbologyColor: symbologyColor; export interface colorGetMatchingSchemesParams { /** * The name of the theme from which to get color schemes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getMatchingSchemes) */ theme: "high-to-low" | "above-and-below" | "centered-on" | "extremes"; /** * An array of colors used to match with schemes for the given theme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getMatchingSchemes) */ colors: Color[]; /** * The geometry type of the layer for which the color scheme will be applied. * * [Read more...](global.html#geometryType) */ geometryType: string; /** * Indicates whether 3D volumetric symbols will be used in the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getMatchingSchemes) */ worldScale?: boolean; /** * The [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) instance used to calculate the suggested sizes of the symbols. * * [Read more...](global.html) */ view?: SceneView; } export interface colorGetSchemeByNameParams { /** * The name of the scheme to retrieve. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getSchemeByName) */ name: string; /** * The basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getSchemeByName) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getSchemeByName) */ basemapTheme?: "light" | "dark"; /** * The geometry type of the features to visualize. * * [Read more...](global.html#geometryType) */ geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; /** * The theme determines which values will be emphasized in the continuous ramp and the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getSchemeByName) */ theme: "high-to-low" | "above-and-below" | "centered-on" | "extremes"; /** * The SceneView instance in which the scheme will be used. * * [Read more...](global.html) */ view?: SceneView; /** * Indicates if the size units of the scheme will be in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getSchemeByName) */ worldScale?: boolean; } export interface colorGetSchemesByTagParams { /** * When provided, only schemes containing all the matching tags will be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getSchemesByTag) */ includedTags?: string[]; /** * When provided, only schemes missing all the provided tags will be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getSchemesByTag) */ excludedTags?: string[]; /** * The basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getSchemesByTag) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getSchemesByTag) */ basemapTheme?: "light" | "dark"; /** * The geometry type of the features to visualize. * * [Read more...](global.html#geometryType) */ geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; /** * The theme determines which values will be emphasized in the continuous ramp and the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getSchemesByTag) */ theme: "high-to-low" | "above-and-below" | "centered-on" | "extremes"; /** * The SceneView instance in which the scheme will be used. * * [Read more...](global.html) */ view?: SceneView; /** * Indicates if the size units of the scheme will be in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getSchemesByTag) */ worldScale?: boolean; } export interface colorGetSchemesParams { /** * The Esri basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getSchemes) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getSchemes) */ basemapTheme?: "light" | "dark"; /** * The geometry type of the features to visualize. * * [Read more...](global.html#geometryType) */ geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; /** * The theme determines which values will be emphasized in the continuous ramp and the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getSchemes) */ theme: "high-to-low" | "above-and-below" | "centered-on" | "extremes"; /** * The SceneView instance in which the scheme will be used. * * [Read more...](global.html) */ view?: SceneView; /** * Indicates if the size units of the scheme will be in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getSchemes) */ worldScale?: boolean; } /** * Properties defining the symbology scheme used to visualize features with attribute data-driven color. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorScheme) */ export type ColorScheme = ColorSchemeForPoint | ColorSchemeForPolyline | ColorSchemeForPolygon | ColorSchemeForMesh; /** * Properties defining the symbology scheme used to visualize mesh features with attribute data-driven color. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForMesh) */ export interface ColorSchemeForMesh { /** * The unique name of the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForMesh) */ name: string; /** * Tags associated with the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForMesh) */ tags: string[]; /** * The unique id of the color scheme to use in the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForMesh) */ id: string; /** * Indicates which values will be emphasized in the continuous ramp and the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForMesh) */ theme: string; /** * The continuous color ramp that will be applied to the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForMesh) */ colors: Color[]; /** * The color of the symbol used to indicate features with no data and features that are out of range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForMesh) */ noDataColor: Color; /** * Predefined classed color schemes to use for the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForMesh) */ colorsForClassBreaks: ColorSchemeForMeshColorsForClassBreaks[]; /** * The opacity of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForMesh) */ opacity: number; } /** * Properties defining the symbology scheme used to visualize point features with attribute data-driven color. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPoint) */ export interface ColorSchemeForPoint { /** * The unique name of the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPoint) */ name: string; /** * Tags associated with the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPoint) */ tags: string[]; /** * The unique id of the color scheme to use in the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPoint) */ id: string; /** * Indicates which values will be emphasized in the continuous ramp and the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPoint) */ theme: string; /** * The continuous color ramp that will be applied to the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPoint) */ colors: Color[]; /** * The color of the symbol used to indicate features with no data and features that are out of range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPoint) */ noDataColor: Color; /** * Predefined classed color schemes to use for the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPoint) */ colorsForClassBreaks: ColorSchemeForPointColorsForClassBreaks[]; /** * Properties for defining the outline of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPoint) */ outline: ColorSchemeForPointOutline; /** * The default size of the symbol in pixels or points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPoint) */ size: number; /** * The opacity of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPoint) */ opacity: number; } /** * Properties defining the symbology scheme used to visualize polygon features with attribute data-driven color. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ export interface ColorSchemeForPolygon { /** * The unique name of the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ name: string; /** * Tags associated with the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ tags: string[]; /** * The unique id of the color scheme to use in the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ id: string; /** * Indicates which values will be emphasized in the continuous ramp and the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ theme: string; /** * The continuous color ramp that will be applied to the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ colors: Color[]; /** * The color of the symbol used to indicate features with no data and features that are out of range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ noDataColor: Color; /** * Predefined classed color schemes to use for the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ colorsForClassBreaks: ColorSchemeForPolygonColorsForClassBreaks[]; /** * Properties for defining the outline of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ outline: ColorSchemeForPolygonOutline; /** * The opacity of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ opacity: number; } /** * Properties defining the symbology scheme used to visualize polyline features with attribute data-driven color. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolyline) */ export interface ColorSchemeForPolyline { /** * The unique name of the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolyline) */ name: string; /** * Tags associated with the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolyline) */ tags: string[]; /** * The unique id of the color scheme to use in the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolyline) */ id: string; /** * Indicates which values will be emphasized in the continuous ramp and the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolyline) */ theme: string; /** * The continuous color ramp that will be applied to the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolyline) */ colors: Color[]; /** * The color of the symbol used to indicate features with no data and features that are out of range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolyline) */ noDataColor: Color; /** * Predefined classed color schemes to use for the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolyline) */ colorsForClassBreaks: ColorSchemeForPolylineColorsForClassBreaks[]; /** * The default width of the symbol in pixels or points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolyline) */ width: number; /** * The opacity of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolyline) */ opacity: number; } /** * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getSchemes) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemes) */ export interface ColorSchemes { /** * The color scheme best suited for the given basemap and geometry type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemes) */ primaryScheme: ColorScheme; /** * Additional color schemes that may be used to visualize data of the given geometry type overlaid on the given basemap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemes) */ secondarySchemes: ColorScheme[]; /** * The ID of the basemap associated with the given schemes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemes) */ basemapId: string; /** * Indicates whether the average basemap color is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemes) */ basemapTheme: string; } /** * Describes a theme that pairs well with the given basemaps. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#Theme) */ export interface colorTheme { /** * The name of the theme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#Theme) */ name: string; /** * The label identifying the theme in UI elements. * * [Read more...](global.html) */ label: string; /** * Text describing the theme in the UI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#Theme) */ description: string; /** * The Esri basemaps that pair well with the given theme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#Theme) */ basemaps: string[]; } export interface ColorSchemeForMeshColorsForClassBreaks { /** * An array of hex color strings. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForMesh) */ colors: Color[]; /** * The number of classes used in the classed color visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForMesh) */ numClasses: number; } export interface ColorSchemeForPointColorsForClassBreaks { /** * An array of hex color strings. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPoint) */ colors: Color[]; /** * The number of classes used in the classed color visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPoint) */ numClasses: number; } export interface ColorSchemeForPointOutline { /** * The outline color of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPoint) */ color: Color; /** * The width of the symbol in pixels or points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPoint) */ width: number; } export interface ColorSchemeForPolygonColorsForClassBreaks { /** * An array of hex color strings. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ colors: Color[]; /** * The number of classes used in the classed color visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ numClasses: number; } export interface ColorSchemeForPolygonOutline { /** * The outline color of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ color: Color; /** * The width of the symbol in pixels or points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ width: number; } export interface ColorSchemeForPolylineColorsForClassBreaks { /** * An array of hex color strings. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolyline) */ colors: Color[]; /** * The number of classes used in the classed color visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#ColorSchemeForPolyline) */ numClasses: number; } /** * Object containing helper methods for getting optimal symbol schemes used to create [dot density visualizations](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-dotDensity.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html) */ interface symbologyDotDensity { /** * Clones a dot density scheme object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#cloneScheme) */ cloneScheme(scheme: DotDensityScheme): DotDensityScheme; /** * Returns a dot density scheme with the provided name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#getSchemeByName) */ getSchemeByName(params: dotDensityGetSchemeByNameParams): DotDensityScheme; /** * Returns a primary scheme and secondary schemes defining symbol properties for dot density-based data-driven visualizations in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#getSchemes) */ getSchemes(params: dotDensityGetSchemesParams): DotDensitySchemes; /** * Returns an array of dot density schemes with the provided tags. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#getSchemesByTag) */ getSchemesByTag(params: dotDensityGetSchemesByTagParams): DotDensityScheme[]; } export const symbologyDotDensity: symbologyDotDensity; export interface dotDensityGetSchemeByNameParams { /** * The name of the scheme to retrieve. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#getSchemeByName) */ name: string; /** * The basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#getSchemeByName) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#getSchemeByName) */ basemapTheme?: "light" | "dark"; /** * The number of colors to visualize. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#getSchemeByName) */ numColors: number; } export interface dotDensityGetSchemesByTagParams { /** * When provided, only schemes containing all the matching tags will be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#getSchemesByTag) */ includedTags?: string[]; /** * When provided, only schemes missing all the provided tags will be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#getSchemesByTag) */ excludedTags?: string[]; /** * The basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#getSchemesByTag) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#getSchemesByTag) */ basemapTheme?: "light" | "dark"; /** * The number of colors to visualize. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#getSchemesByTag) */ numColors: number; } export interface dotDensityGetSchemesParams { /** * The Esri basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#getSchemes) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#getSchemes) */ basemapTheme?: "light" | "dark"; /** * The number of colors to visualize. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#getSchemes) */ numColors: number; } /** * Properties defining the symbology scheme used to visualize predominance for polygon features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#DotDensityScheme) */ export interface DotDensityScheme { /** * The unique name of the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#DotDensityScheme) */ name: string; /** * Tags associated with the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#DotDensityScheme) */ tags: string[]; /** * The dot color for each attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#DotDensityScheme) */ colors: Color[]; /** * Properties for defining the outline of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#DotDensityScheme) */ outline: DotDensitySchemeOutline; /** * The opacity of the symbol (0 - 1). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#DotDensityScheme) */ opacity: number; } /** * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#getSchemes) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#DotDensitySchemes) */ export interface DotDensitySchemes { /** * The dot density scheme best suited for the given basemap and geometry type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#DotDensitySchemes) */ primaryScheme: DotDensityScheme; /** * Additional dot density schemes that may be used to visualize data of the given geometry type overlaid on the given basemap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#DotDensitySchemes) */ secondarySchemes: DotDensityScheme[]; /** * The ID of the basemap associated with the given schemes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#DotDensitySchemes) */ basemapId: string; /** * Indicates whether the average basemap color is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#DotDensitySchemes) */ basemapTheme: string; } export interface DotDensitySchemeOutline { /** * The outline color of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#DotDensityScheme) */ color: Color; /** * The width of the symbol's outline in points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#DotDensityScheme) */ width: number; } /** * Object containing helper methods for generating optimal settings for [FlowRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html) */ interface symbologyFlow { /** * Clones a flow scheme object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#cloneScheme) */ cloneScheme(scheme: FlowScheme): FlowScheme; /** * Returns the flow scheme with the given name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#getSchemeByName) */ getSchemeByName(params: flowGetSchemeByNameParams): FlowScheme; /** * Returns a primary scheme and secondary schemes defining properties for flow visualizations in a [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html) and [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#getSchemes) */ getSchemes(params: flowGetSchemesParams): FlowSchemes; /** * Returns the flow schemes filtered by tags included and excluded from the paramters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#getSchemesByTag) */ getSchemesByTag(params: flowGetSchemesByTagParams): FlowScheme[]; /** * Returns metadata for the available themes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#getThemes) */ getThemes(basemap?: string | Basemap): flowTheme[]; } export const symbologyFlow: symbologyFlow; export interface flowGetSchemeByNameParams { /** * The name of the desired scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#getSchemeByName) */ name: string; /** * Determines how flow lines will render. * * @default "flow-line" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#getSchemeByName) */ theme?: "flow-line" | "wave-front"; /** * The Esri basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#getSchemeByName) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#getSchemeByName) */ basemapTheme?: "light" | "dark"; } export interface flowGetSchemesByTagParams { /** * When provided, only schemes containing all the matching tags will be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#getSchemesByTag) */ includedTags?: string[]; /** * When provided, only schemes excluding all the provided tags will be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#getSchemesByTag) */ excludedTags?: string[]; /** * Determines how flow lines will render. * * @default "flow-line" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#getSchemesByTag) */ theme?: "flow-line" | "wave-front"; /** * The Esri basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#getSchemesByTag) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#getSchemesByTag) */ basemapTheme?: "light" | "dark"; } export interface flowGetSchemesParams { /** * Determines how flow lines will render. * * @default "flow-line" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#getSchemes) */ theme?: "flow-line" | "wave-front"; /** * The Esri basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#getSchemes) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#getSchemes) */ basemapTheme?: "light" | "dark"; } /** * Suggested property values for defining the scheme used to visualize flow lines. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#FlowScheme) */ export interface FlowScheme { /** * The unique name of the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#FlowScheme) */ name: string; /** * Tags associated with the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#FlowScheme) */ tags: string[]; /** * The unique id of the color scheme to use in the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#FlowScheme) */ id: string; /** * Determines how flow lines will render. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#FlowScheme) */ theme: "flow-line" | "wave-front"; /** * The suggested color of the flow lines if a color visual variable is not desired. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#FlowScheme) */ color: Color; /** * The suggested colors to use if a [ColorVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html) is set on the flow renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#FlowScheme) */ colors: Color[]; /** * The suggested [density](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#density) of the stream lines. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#FlowScheme) */ density: number; /** * The suggested [flowSpeed](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#flowSpeed) of the stream lines. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#FlowScheme) */ flowSpeed: number; /** * The suggested [length](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#trailLength) of the stream lines. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#FlowScheme) */ trailLength: number; /** * The suggested [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#trailWidth) of the stream lines. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#FlowScheme) */ trailWidth: number; /** * The suggested [cap style](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#trailCap) of the stream lines. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#FlowScheme) */ trailCap: number; /** * The suggested [effect](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#effect) to apply to the input layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#FlowScheme) */ layerEffect: string; /** * The suggested size to apply to small magnitude values if a [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) is set on the flow renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#FlowScheme) */ minWidth: number; /** * The suggested size to apply to large magnitude values if a [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) is set on the flow renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#FlowScheme) */ maxWidth: number; /** * The suggested opacity to apply to small magnitude values if an [OpacityVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-OpacityVariable.html) is set on the flow renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#FlowScheme) */ minOpacity: number; /** * The suggested opacity to apply to large magnitude values if an [OpacityVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-OpacityVariable.html) is set on the flow renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#FlowScheme) */ maxOpacity: number; } /** * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#getSchemes) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#FlowSchemes) */ export interface FlowSchemes { /** * The flow scheme best suited for the given basemap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#FlowSchemes) */ primaryScheme: FlowScheme; /** * Additional flow schemes that may be used to visualize stream lines overlaid on the given basemap or basemap theme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#FlowSchemes) */ secondarySchemes: FlowScheme[]; /** * The ID of the basemap associated with the given schemes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#FlowSchemes) */ basemapId: string; /** * Indicates whether the average basemap color is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#FlowSchemes) */ basemapTheme: string; } /** * Describes a theme that pairs well with the given basemaps. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#Theme) */ export interface flowTheme { /** * The name of the theme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#Theme) */ name: string; /** * The label identifying the theme in UI elements. * * [Read more...](global.html) */ label: string; /** * Text describing the theme in the UI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#Theme) */ description: string; /** * The Esri basemaps that pair well with the given theme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#Theme) */ basemaps: string[]; } /** * Object containing helper methods for generating optimal colors for heatmap visualizations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html) */ interface symbologyHeatmap { /** * Clones a heatmap scheme object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#cloneScheme) */ cloneScheme(scheme: HeatmapScheme): HeatmapScheme; /** * Returns a heatmap scheme with the provided name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#getSchemeByName) */ getSchemeByName(params: heatmapGetSchemeByNameParams): HeatmapScheme; /** * Returns a primary scheme and secondary schemes defining properties for heatmap visualizations in a point [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#getSchemes) */ getSchemes(params: heatmapGetSchemesParams): HeatmapSchemes; /** * Returns an array of heatmap schemes with the provided tags. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#getSchemesByTag) */ getSchemesByTag(params: heatmapGetSchemesByTagParams): HeatmapScheme[]; /** * Returns metadata for the available themes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#getThemes) */ getThemes(basemap?: string | Basemap): colorTheme[]; } export const symbologyHeatmap: symbologyHeatmap; export interface heatmapGetSchemeByNameParams { /** * The name of the scheme to retrieve. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#getSchemeByName) */ name: string; /** * The basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#getSchemeByName) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#getSchemeByName) */ basemapTheme?: "light" | "dark"; } export interface heatmapGetSchemesByTagParams { /** * When provided, only schemes containing all the matching tags will be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#getSchemesByTag) */ includedTags?: string[]; /** * When provided, only schemes missing all the provided tags will be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#getSchemesByTag) */ excludedTags?: string[]; /** * The basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#getSchemesByTag) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#getSchemesByTag) */ basemapTheme?: "light" | "dark"; } export interface heatmapGetSchemesParams { /** * The Esri basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#getSchemes) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#getSchemes) */ basemapTheme?: "light" | "dark"; } /** * Properties defining the symbology scheme used to visualize point features as a heatmap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#HeatmapScheme) */ export interface HeatmapScheme { /** * The unique name of the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#HeatmapScheme) */ name: string; /** * Tags associated with the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#HeatmapScheme) */ tags: string[]; /** * The unique id of the color scheme to usee in the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#HeatmapScheme) */ id: string; /** * A continuous color ramp used to construct a heatmap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#HeatmapScheme) */ colors: Color[]; /** * The opacity of the heatmap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#HeatmapScheme) */ opacity: number; } /** * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#getSchemes) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#HeatmapSchemes) */ export interface HeatmapSchemes { /** * The heatmap color scheme best suited for the given basemap and geometry type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#HeatmapSchemes) */ primaryScheme: HeatmapScheme; /** * Additional heatmap color schemes that may be used to visualize data overlaid on the given basemap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#HeatmapSchemes) */ secondarySchemes: HeatmapScheme[]; /** * The ID of the basemap associated with the given schemes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#HeatmapSchemes) */ basemapId: string; /** * Indicates whether the average basemap color is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#HeatmapSchemes) */ basemapTheme: string; } /** * Object containing helper methods for generating optimal symbols for location-only visualizations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html) */ interface symbologyLocation { /** * Clones a location scheme object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#cloneScheme) */ cloneScheme(scheme: LocationScheme): LocationScheme; /** * Returns a primary scheme and secondary schemes defining symbol properties for location-only visualizions in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#getSchemes) */ getSchemes(params: locationGetSchemesParams): LocationSchemes; /** * Returns metadata for the available themes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#getThemes) */ getThemes(basemap?: string | Basemap): colorTheme[]; } export const symbologyLocation: symbologyLocation; export interface locationGetSchemesParams { /** * The Esri basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#getSchemes) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#getSchemes) */ basemapTheme?: "light" | "dark"; /** * The geometry type of the features to visualize. * * [Read more...](global.html#geometryType) */ geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; /** * The SceneView instance in which the scheme will be used. * * [Read more...](global.html) */ view?: SceneView; /** * Indicates if the size units of the scheme will be in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#getSchemes) */ worldScale?: boolean; } /** * Defines the symbology scheme used to visualize default location-based symbols depending on the layer's geometry type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationScheme) */ export type LocationScheme = | LocationSchemeForPoint | LocationSchemeForPolyline | LocationSchemeForPolygon | LocationSchemeForMesh; /** * Properties defining the location-only symbology scheme used to visualize mesh features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemeForMesh) */ export interface LocationSchemeForMesh { /** * The color of the fill symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemeForMesh) */ color: Color; /** * The opacity of the fill symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemeForMesh) */ opacity: number; } /** * Properties defining the location-only symbology scheme used to visualize point features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemeForPoint) */ export interface LocationSchemeForPoint { /** * The fill color of the marker symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemeForPoint) */ color: Color; /** * Properties for defining the outline of the marker symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemeForPoint) */ outline: LocationSchemeForPointOutline; /** * The size of the marker symbol in pixels or points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemeForPoint) */ size: number; /** * The opacity of the marker symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemeForPoint) */ opacity: number; } /** * Properties defining the location-only symbology scheme used to visualize polygon features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemeForPolygon) */ export interface LocationSchemeForPolygon { /** * The color of the fill symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemeForPolygon) */ color: Color; /** * Properties for defining the outline of the fill symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemeForPolygon) */ outline: LocationSchemeForPolygonOutline; /** * The opacity of the fill symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemeForPolygon) */ opacity: number; } /** * Properties defining the location-only symbology scheme used to visualize polyline features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemeForPolyline) */ export interface LocationSchemeForPolyline { /** * The color of the line symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemeForPolyline) */ color: Color; /** * The width of the line symbol in pixels or points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemeForPolyline) */ width: number; /** * The opacity of the line symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemeForPolyline) */ opacity: number; } /** * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#getSchemes) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemes) */ export interface LocationSchemes { /** * The location scheme best suited for the given basemap and geometry type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemes) */ primaryScheme: LocationScheme; /** * Additional location schemes that may be used to visualize data of the given geometry type overlaid on the given basemap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemes) */ secondarySchemes: LocationScheme[]; /** * The ID of the basemap associated with the given schemes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemes) */ basemapId: string; /** * Indicates whether the average basemap color is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemes) */ basemapTheme: string; } export interface LocationSchemeForPointOutline { /** * The outline color of the marker symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemeForPoint) */ color: Color; /** * The width of the marker symbol in pixels or points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemeForPoint) */ width: number; } export interface LocationSchemeForPolygonOutline { /** * The outline color of the fill symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemeForPolygon) */ color: Color; /** * The width of the fill symbol in pixels or points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#LocationSchemeForPolygon) */ width: number; } /** * Object containing helper methods for getting optimal color schemes used to create [pie chart visualizations](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html) */ interface symbologyPieChart { /** * Clones a pie chart scheme object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#cloneScheme) */ cloneScheme(scheme: PieChartScheme): PieChartScheme; /** * Returns a pie chart scheme with the given name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#getSchemeByName) */ getSchemeByName(params: pieChartGetSchemeByNameParams): PieChartScheme; /** * Returns a primary scheme and secondary schemes defining properties for pie chart visualizations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#getSchemes) */ getSchemes(params: pieChartGetSchemesParams): PieChartSchemes; /** * Returns an array of pie chart schemes with the provided tags. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#getSchemesByTag) */ getSchemesByTag(params: pieChartGetSchemesByTagParams): PieChartScheme[]; /** * Returns metadata for the available themes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#getThemes) */ getThemes(basemap?: string | Basemap): colorTheme[]; } export const symbologyPieChart: symbologyPieChart; export interface pieChartGetSchemeByNameParams { /** * The name of the scheme to retrieve. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#getSchemeByName) */ name: string; /** * The basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#getSchemeByName) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#getSchemeByName) */ basemapTheme?: "light" | "dark"; /** * The geometry type of the features to visualize. * * [Read more...](global.html#geometryType) */ geometryType: "point" | "polygon"; /** * The number of values to include in the pie chart. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#getSchemeByName) */ numColors: number; } export interface pieChartGetSchemesByTagParams { /** * When provided, only schemes containing all the matching tags will be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#getSchemesByTag) */ includedTags?: string[]; /** * When provided, only schemes missing all the provided tags will be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#getSchemesByTag) */ excludedTags?: string[]; /** * The basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#getSchemesByTag) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#getSchemesByTag) */ basemapTheme?: "light" | "dark"; /** * The geometry type of the features to visualize. * * [Read more...](global.html#geometryType) */ geometryType: "point" | "polygon"; /** * The number of categories to include in the pie chart visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#getSchemesByTag) */ numColors: number; } export interface pieChartGetSchemesParams { /** * The Esri basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#getSchemes) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#getSchemes) */ basemapTheme?: "light" | "dark"; /** * The geometry type of the features to visualize. * * [Read more...](global.html#geometryType) */ geometryType: "point" | "polygon"; /** * The number of unique values to include in the pie chart visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#getSchemes) */ numColors: number; } /** * Properties defining the colors and schemes used to visualize pie charts. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#PieChartScheme) */ export interface PieChartScheme { /** * The unique name of the color scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#PieChartScheme) */ name: string; /** * Tags associated with the color scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#PieChartScheme) */ tags: string[]; /** * The colors used to visualize pie slices in the chart. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#PieChartScheme) */ colors: Color[]; /** * The color of the "others" category. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#PieChartScheme) */ colorForOthersCategory: Color; /** * Properties for defining the outline of the pie chart. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#PieChartScheme) */ outline: PieChartSchemeOutline; /** * The scheme defining the size visual variable used to vary chart size per feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#PieChartScheme) */ sizeScheme: SizeScheme; /** * The default size of the pie charts in points or pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#PieChartScheme) */ size: number | string; } /** * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#getSchemes) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#PieChartSchemes) */ export interface PieChartSchemes { /** * The suggest default chart scheme based on the given basemap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#PieChartSchemes) */ primaryScheme: PieChartScheme; /** * Additional chart schemes that may be used to visualize data overlaid on the given basemap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#PieChartSchemes) */ secondarySchemes: PieChartScheme[]; /** * The ID of the basemap associated with the given schemes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#PieChartSchemes) */ basemapId: string; /** * Indicates whether the average basemap color is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#PieChartSchemes) */ basemapTheme: string; } export interface PieChartSchemeOutline { /** * The outline color of the pie chart. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#PieChartScheme) */ color: Color; /** * The width of the outline in points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#PieChartScheme) */ width: number | string; } /** * Object containing helper methods for getting optimal symbol schemes used to create [predominance visualizations](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html) */ interface symbologyPredominance { /** * Clones a predominance scheme object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#cloneScheme) */ cloneScheme(scheme: PredominanceScheme): PredominanceScheme; /** * Returns a predominance scheme with the provided name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemeByName) */ getSchemeByName(params: predominanceGetSchemeByNameParams): PredominanceScheme; /** * Returns a primary scheme and secondary schemes defining symbol properties for predominance-based data-driven visualizations in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemes) */ getSchemes(params: predominanceGetSchemesParams): PredominanceSchemes; /** * Returns an array of predominance schemes with the provided tags. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemesByTag) */ getSchemesByTag(params: predominanceGetSchemesByTagParams): PredominanceScheme[]; /** * Returns metadata for the available themes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getThemes) */ getThemes(basemap?: string | Basemap): colorTheme[]; } export const symbologyPredominance: symbologyPredominance; export interface predominanceGetSchemeByNameParams { /** * The name of the scheme to retrieve. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemeByName) */ name: string; /** * The basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemeByName) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemeByName) */ basemapTheme?: "light" | "dark"; /** * The geometry type of the features to visualize. * * [Read more...](global.html#geometryType) */ geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; /** * The number of unique values to include in the predominance visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemeByName) */ numColors: number; /** * Determines which set of primary and secondary color schemes to return. * * @default default * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemeByName) */ theme?: "default"; /** * Indicates if the size units of the scheme will be in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemeByName) */ worldScale?: boolean; /** * The SceneView instance in which the scheme will be used. * * [Read more...](global.html) */ view?: SceneView; } export interface predominanceGetSchemesByTagParams { /** * When provided, only schemes containing all the matching tags will be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemesByTag) */ includedTags?: string[]; /** * When provided, only schemes missing all the provided tags will be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemesByTag) */ excludedTags?: string[]; /** * The basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemesByTag) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemesByTag) */ basemapTheme?: "light" | "dark"; /** * The geometry type of the features to visualize. * * [Read more...](global.html#geometryType) */ geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; /** * The number of unique values to include in the predominance visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemesByTag) */ numColors: number; /** * Determines which set of primary and secondary color schemes to return. * * @default default * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemesByTag) */ theme?: "default"; /** * Indicates if the size units of the scheme will be in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemesByTag) */ worldScale?: boolean; /** * The SceneView instance in which the scheme will be used. * * [Read more...](global.html) */ view?: SceneView; } export interface predominanceGetSchemesParams { /** * The Esri basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemes) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemes) */ basemapTheme?: "light" | "dark"; /** * The geometry type of the features to visualize. * * [Read more...](global.html#geometryType) */ geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; /** * The number of unique values to include in the predominance visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemes) */ numColors: number; /** * Determines which set of primary and secondary color schemes to return. * * @default default * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemes) */ theme?: "default"; /** * Indicates if the size units of the scheme will be in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemes) */ worldScale?: boolean; /** * The SceneView instance in which the scheme will be used. * * [Read more...](global.html) */ view?: SceneView; } /** * Defines the symbology scheme used to visualize predominance based on the layer's geometry type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceScheme) */ export type PredominanceScheme = | PredominanceSchemeForPoint | PredominanceSchemeForPolyline | PredominanceSchemeForPolygon | PredominanceSchemeForMesh; /** * Properties defining the symbology scheme used to visualize predominance for mesh features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForMesh) */ export interface PredominanceSchemeForMesh { /** * The unique name of the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForMesh) */ name: string; /** * Tags associated with the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForMesh) */ tags: string[]; /** * The fill colors of the mesh symbols used for each category. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForMesh) */ colors: Color[]; /** * The color of the fill symbol used to indicate features with no data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForMesh) */ noDataColor: Color; /** * The opacity of the symbol (0 - 1). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForMesh) */ opacity: number; } /** * Properties defining the symbology scheme used to visualize predominance for point features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPoint) */ export interface PredominanceSchemeForPoint { /** * The unique name of the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPoint) */ name: string; /** * Tags associated with the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPoint) */ tags: string[]; /** * The fill colors of the point symbols used for each category. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPoint) */ colors: Color[]; /** * The color of the point symbol used to indicate features with no data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPoint) */ noDataColor: Color; /** * Properties for defining the outline of the marker symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPoint) */ outline: PredominanceSchemeForPointOutline; /** * The opacity of the point symbol (0 - 1). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPoint) */ opacity: number; /** * The scheme defining the size visual variable if included in a predominance visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPoint) */ sizeScheme: SizeSchemeForPoint; } /** * Properties defining the symbology scheme used to visualize predominance for polygon features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPolygon) */ export interface PredominanceSchemeForPolygon { /** * The unique name of the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPolygon) */ name: string; /** * Tags associated with the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPolygon) */ tags: string[]; /** * The fill colors of the polygon symbols used for each category. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPolygon) */ colors: Color[]; /** * The color of the fill symbol used to indicate features with no data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPolygon) */ noDataColor: Color; /** * Properties for defining the outline of the fill symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPolygon) */ outline: PredominanceSchemeForPolygonOutline; /** * The opacity of the symbol (0 - 1). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPolygon) */ opacity: number; /** * The scheme defining the size visual variable if included in a predominance visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPolygon) */ sizeScheme: SizeSchemeForPolygon; } /** * Properties defining the symbology scheme used to visualize predominance for polyline features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPolyline) */ export interface PredominanceSchemeForPolyline { /** * The unique name of the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPolyline) */ name: string; /** * Tags associated with the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPolyline) */ tags: string[]; /** * The colors of the line symbols used for each category. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPolyline) */ colors: Color[]; /** * The color of the line symbol used to indicate features with no data and features that are out of range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPolyline) */ noDataColor: Color; /** * The default width of the line symbol in pixels or points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPolyline) */ width: number; /** * The opacity of the line symbol (0 - 1). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPolyline) */ opacity: number; /** * The scheme defining the size visual variable if included in a predominance visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPolyline) */ sizeScheme: SizeSchemeForPolyline; } /** * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemes) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemes) */ export interface PredominanceSchemes { /** * The predominance scheme best suited for the given basemap and geometry type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemes) */ primaryScheme: PredominanceScheme; /** * Additional predominance schemes that may be used to visualize data of the given geometry type overlaid on the given basemap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemes) */ secondarySchemes: PredominanceScheme[]; /** * The ID of the basemap associated with the given schemes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemes) */ basemapId: string; /** * Indicates whether the average basemap color is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemes) */ basemapTheme: string; } export interface PredominanceSchemeForPointOutline { /** * The outline color of the marker symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPoint) */ color: Color; /** * The width of the marker symbol in points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPoint) */ width: number; } export interface PredominanceSchemeForPolygonOutline { /** * The outline color of the fill symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPolygon) */ color: Color; /** * The width of the fill symbol's outline in pixels or points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceSchemeForPolygon) */ width: number; } /** * Object containing helper methods for getting optimal symbol schemes used to create [relationship (bivariate choropleth) visualizations](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-relationship.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html) */ interface symbologyRelationship { /** * Clones a relationship (bivariate color) scheme object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#cloneScheme) */ cloneScheme(scheme: RelationshipScheme): RelationshipScheme; /** * Returns a relationship scheme with the provided name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#getSchemeByName) */ getSchemeByName(params: relationshipGetSchemeByNameParams): RelationshipScheme; /** * Returns a primary scheme and secondary schemes defining symbol properties for relationship-based (bivariate choropleth) data-driven visualizations in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#getSchemes) */ getSchemes(params: relationshipGetSchemesParams): RelationshipSchemes; /** * Returns an array of relationship schemes with the provided tags. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#getSchemesByTag) */ getSchemesByTag(params: relationshipGetSchemesByTagParams): RelationshipScheme[]; /** * Returns metadata for the available themes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#getThemes) */ getThemes(basemap?: string | Basemap): colorTheme[]; } export const symbologyRelationship: symbologyRelationship; export interface relationshipGetSchemeByNameParams { /** * The name of the scheme to retrieve. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#getSchemeByName) */ name: string; /** * The basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#getSchemeByName) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#getSchemeByName) */ basemapTheme?: "light" | "dark"; /** * The geometry type of the features to visualize. * * [Read more...](global.html#geometryType) */ geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; /** * Determines which set of primary and secondary color schemes to return. * * @default default * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#getSchemeByName) */ theme?: "default"; /** * Indicates if the size units of the scheme will be in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#getSchemeByName) */ worldScale?: boolean; /** * The SceneView instance in which the scheme will be used. * * [Read more...](global.html) */ view?: SceneView; } export interface relationshipGetSchemesByTagParams { /** * When provided, only schemes containing all the matching tags will be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#getSchemesByTag) */ includedTags?: string[]; /** * When provided, only schemes missing all the provided tags will be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#getSchemesByTag) */ excludedTags?: string[]; /** * The basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#getSchemesByTag) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#getSchemesByTag) */ basemapTheme?: "light" | "dark"; /** * The geometry type of the features to visualize. * * [Read more...](global.html#geometryType) */ geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; /** * Determines which set of primary and secondary color schemes to return. * * @default default * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#getSchemesByTag) */ theme?: "default"; /** * Indicates if the size units of the scheme will be in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#getSchemesByTag) */ worldScale?: boolean; /** * The SceneView instance in which the scheme will be used. * * [Read more...](global.html) */ view?: SceneView; } export interface relationshipGetSchemesParams { /** * The Esri basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#getSchemes) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#getSchemes) */ basemapTheme?: "light" | "dark"; /** * The geometry type of the features to visualize. * * [Read more...](global.html#geometryType) */ geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; /** * Determines which set of primary and secondary color schemes to return. * * @default default * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#getSchemes) */ theme?: "default"; /** * Indicates if the size units of the scheme will be in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#getSchemes) */ worldScale?: boolean; /** * The SceneView instance in which the scheme will be used. * * [Read more...](global.html) */ view?: SceneView; } /** * Defines the symbology scheme used to visualize relationship renderers (bivariate color) based on the layer's geometry type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipScheme) */ export type RelationshipScheme = | RelationshipSchemeForPoint | RelationshipSchemeForPolyline | RelationshipSchemeForPolygon | RelationshipSchemeForMesh; /** * Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for mesh features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForMesh) */ export interface RelationshipSchemeForMesh { /** * The unique name of the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForMesh) */ name: string; /** * Tags associated with the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForMesh) */ tags: string[]; /** * The ID uniquely identifying the color scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForMesh) */ id: string; /** * Defines the colors to use in each bin of the relationship visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForMesh) */ colorsForClassBreaks: RelationshipSchemeForMeshColorsForClassBreaks[]; /** * The color of the fill symbol used to indicate features with no data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForMesh) */ noDataColor: Color; /** * The opacity of the fill symbol (0 - 1). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForMesh) */ opacity: number; } /** * Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for point features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ export interface RelationshipSchemeForPoint { /** * The unique name of the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ name: string; /** * Tags associated with the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ tags: string[]; /** * The ID uniquely identifying the color scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ id: string; /** * Defines the colors to use in each bin of the relationship visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ colorsForClassBreaks: RelationshipSchemeForPointColorsForClassBreaks[]; /** * The color of the point symbol used to indicate features with no data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ noDataColor: Color; /** * Properties for defining the outline of the marker symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ outline: RelationshipSchemeForPointOutline; /** * The opacity of the point symbol (0 - 1). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ opacity: number; /** * The size of the point symbol in points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ size: number; } /** * Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for polygon features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPolygon) */ export interface RelationshipSchemeForPolygon { /** * The unique name of the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPolygon) */ name: string; /** * Tags associated with the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPolygon) */ tags: string[]; /** * The ID uniquely identifying the color scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPolygon) */ id: string; /** * Defines the colors to use in each bin of the relationship visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPolygon) */ colorsForClassBreaks: RelationshipSchemeForPolygonColorsForClassBreaks[]; /** * The color of the fill symbol used to indicate features with no data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPolygon) */ noDataColor: Color; /** * Properties for defining the outline of the fill symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPolygon) */ outline: RelationshipSchemeForPolygonOutline; /** * The opacity of the fill symbol (0 - 1). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPolygon) */ opacity: number; } /** * Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for polyline features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPolyline) */ export interface RelationshipSchemeForPolyline { /** * The unique name of the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPolyline) */ name: string; /** * Tags associated with the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPolyline) */ tags: string[]; /** * The ID uniquely identifying the color scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPolyline) */ id: string; /** * Defines the colors to use in each bin of the relationship visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPolyline) */ colorsForClassBreaks: RelationshipSchemeForPolylineColorsForClassBreaks[]; /** * The color of the line symbol used to indicate features with no data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPolyline) */ noDataColor: Color; /** * The opacity of the line symbol (0 - 1). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPolyline) */ opacity: number; /** * The width of the line symbol in points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPolyline) */ width: number; } /** * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#getSchemes) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemes) */ export interface RelationshipSchemes { /** * The relationship scheme best suited for the given basemap and geometry type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemes) */ primaryScheme: RelationshipScheme; /** * Additional relationship schemes that may be used to visualize data of the given geometry type overlaid on the given basemap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemes) */ secondarySchemes: RelationshipScheme[]; /** * The ID of the basemap associated with the given schemes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemes) */ basemapId: string; /** * Indicates whether the average basemap color is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemes) */ basemapTheme: string; } export interface RelationshipSchemeForMeshColorsForClassBreaks { /** * The colors of the fill symbols used for each bin in the relationship visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForMesh) */ colors: Color[][]; /** * The number of breaks (rows/columns) for each variable in the relationship visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForMesh) */ numClasses: number; } export interface RelationshipSchemeForPointColorsForClassBreaks { /** * The fill colors of the point symbols used for each bin in the relationship visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ colors: Color[][]; /** * The number of breaks (rows/columns) for each variable in the relationship visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ numClasses: number; } export interface RelationshipSchemeForPointOutline { /** * The outline color of the marker symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ color: Color; /** * The width of the outline in points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ width: number; } export interface RelationshipSchemeForPolygonColorsForClassBreaks { /** * The colors of the fill symbols used for each bin in the relationship visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPolygon) */ colors: Color[][]; /** * The number of breaks (rows/columns) for each variable in the relationship visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPolygon) */ numClasses: number; } export interface RelationshipSchemeForPolygonOutline { /** * The outline color of the fill symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPolygon) */ color: Color; /** * The width of the outline in points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPolygon) */ width: number; } export interface RelationshipSchemeForPolylineColorsForClassBreaks { /** * The colors of the line symbols used for each bin in the relationship visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPolyline) */ colors: Color[][]; /** * The number of breaks (rows/columns) for each variable in the relationship visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#RelationshipSchemeForPolyline) */ numClasses: number; } /** * Object containing helper methods for generating optimal symbols for data-driven size visualizations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html) */ interface symbologySize { /** * Clones a size scheme object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#cloneScheme) */ cloneScheme(scheme: SizeScheme): SizeScheme; /** * Returns a primary scheme and secondary schemes defining symbol properties for size-based data-driven visualizations in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#getSchemes) */ getSchemes(params: sizeGetSchemesParams): SizeSchemes; /** * Returns metadata for the available themes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#getThemes) */ getThemes(basemap?: string | Basemap): colorTheme[]; } export const symbologySize: symbologySize; export interface sizeGetSchemesParams { /** * The Esri basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#getSchemes) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#getSchemes) */ basemapTheme?: "light" | "dark"; /** * The geometry type of the features to visualize. * * [Read more...](global.html#geometryType) */ geometryType: "point" | "multipoint" | "polyline" | "polygon"; /** * The SceneView instance in which the scheme will be used. * * [Read more...](global.html) */ view?: SceneView; /** * Indicates if the size units of the scheme will be in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#getSchemes) */ worldScale?: boolean; } /** * Properties defining the symbology scheme used to visualize features with attribute data-driven size. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeScheme) */ export type SizeScheme = SizeSchemeForPoint | SizeSchemeForPolyline | SizeSchemeForPolygon; /** * Properties defining the symbology scheme used to visualize point features driven by attribute data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPoint) */ export interface SizeSchemeForPoint { /** * The fill color of the marker symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPoint) */ color: Color; /** * The color of the marker symbol used to indicate features with no data and features that are out of range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPoint) */ noDataColor: Color; /** * Properties for defining the outline of the marker symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPoint) */ outline: SizeSchemeForPointOutline; /** * The default size of the marker symbol in pixels or points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPoint) */ size: number; /** * The size of the marker symbol (in pixels or points) used to indicate features with no data and features that are out of range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPoint) */ noDataSize: number; /** * The minimum size of a marker symbol in pixels or points representing features with low data values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPoint) */ minSize: number; /** * The maximum size of a marker symbol in pixels or points representing features with high data values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPoint) */ maxSize: number; /** * The opacity of the marker symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPoint) */ opacity: number; } /** * Properties defining the symbology scheme used to visualize polygon features driven by attribute data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPolygon) */ export interface SizeSchemeForPolygon { /** * The scheme defining the symbology of the marker symbol used to represent polygon features by size. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPolygon) */ marker: SizeSchemeForPoint; /** * The schema defining the backgound symbol of the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPolygon) */ background: SizeSchemeForPolygonBackground; /** * The opacity of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPolygon) */ opacity: number; } /** * Properties defining the symbology scheme used to visualize polyline features driven by attribute data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPolyline) */ export interface SizeSchemeForPolyline { /** * The color of the line symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPolyline) */ color: Color; /** * The color of the line symbol used to indicate features with no data and features that are out of range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPolyline) */ noDataColor: Color; /** * The default width of the line symbol in pixels or points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPolyline) */ width: number; /** * The width of the line symbol in pixels or points used to indicate features with no data and features that are out of range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPolyline) */ noDataWidth: number; /** * The minimum width of a line symbol in pixels or points representing features with low data values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPolyline) */ minWidth: number; /** * The maximum width of a line symbol in pixels or points representing features with high data values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPolyline) */ maxWidth: number; /** * The opacity of the line symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPolyline) */ opacity: number; } /** * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#getSchemes) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemes) */ export interface SizeSchemes { /** * The size scheme best suited for the given basemap and geometry type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemes) */ primaryScheme: SizeScheme; /** * Additional size schemes that may be used to visualize data of the given geometry type overlaid on the given basemap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemes) */ secondarySchemes: SizeScheme[]; /** * The ID of the basemap associated with the given schemes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemes) */ basemapId: string; /** * Indicates whether the average basemap color is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemes) */ basemapTheme: string; } export interface SizeSchemeForPointOutline { /** * The outline color of the marker symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPoint) */ color: Color; /** * The width of the marker symbol in pixels or points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPoint) */ width: number; } export interface SizeSchemeForPolygonBackground { /** * The color of the fill symbol representing the polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPolygon) */ color: Color; /** * Properties for defining the outline of the background fill symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPolygon) */ outline: SizeSchemeForPolygonBackgroundOutline; } export interface SizeSchemeForPolygonBackgroundOutline { /** * The outline color of the background fill symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPolygon) */ color: Color; /** * The width of the background fill symbol's outline in pixels or points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#SizeSchemeForPolygon) */ width: number; } /** * This module provides convenience methods for querying color ramps (arrays of colors) used in the smart mapping [color symbology](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html) module. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-support-colorRamps.html) */ interface supportColorRamps { /** * Returns all color ramps available in smartMapping [color schemes](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-support-colorRamps.html#all) */ all(): supportColorRampsColorRamp[]; /** * Returns the color ramp available in the smartMapping [color schemes](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html) matching the given name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-support-colorRamps.html#byName) */ byName(name: string): supportColorRampsColorRamp; /** * Returns the color ramps available in the smartMapping [color schemes](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html) matching the given tags. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-support-colorRamps.html#byTag) */ byTag(params: colorRampsByTagParams): supportColorRampsColorRamp[]; /** * Returns the names of all color ramps available in the smartMapping [color schemes](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-support-colorRamps.html#names) */ names(): string[]; } export const supportColorRamps: supportColorRamps; /** * Defines a ramp of colors to use for visualizing data in a chart, [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html), or [ColorVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-support-colorRamps.html#ColorRamp) */ export interface supportColorRampsColorRamp { /** * The unique name of the color ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-support-colorRamps.html#ColorRamp) */ name: string; /** * Tags associated with the color ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-support-colorRamps.html#ColorRamp) */ tags: string[]; /** * An array of five colors intended for displaying a continuous color ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-support-colorRamps.html#ColorRamp) */ colors: Color[]; /** * Contains an array of ramps ranging in size from 1 color to 10 colors. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-support-colorRamps.html#ColorRamp) */ colorsForClassBreaks: ColorRampColorsForClassBreaks[]; } export interface colorRampsByTagParams { /** * When provided, only ramps containing all the matching tags will be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-support-colorRamps.html#byTag) */ includedTags?: string[]; /** * When provided, only ramps missing all the provided tags will be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-support-colorRamps.html#byTag) */ excludedTags?: string[]; } export interface ColorRampColorsForClassBreaks { /** * An array of 1 to 10 colors intended for displaying as a ramp with distinct or unique colors. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-support-colorRamps.html#ColorRamp) */ colors: Color[]; /** * The number of classes or colors used in the ramp of discrete colors. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-support-colorRamps.html#ColorRamp) */ numClasses: number; } /** * Object containing helper methods for getting optimal symbol themes used to create data-driven visualizations of unique values or types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html) */ interface symbologyType { /** * Clones a type scheme object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#cloneScheme) */ cloneScheme(scheme: TypeScheme): TypeScheme; /** * Returns a type scheme with the provided name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#getSchemeByName) */ getSchemeByName(params: typeGetSchemeByNameParams): TypeScheme; /** * Returns a primary scheme and secondary schemes defining symbol properties for type-based data-driven visualizations in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#getSchemes) */ getSchemes(params: typeGetSchemesParams): TypeSchemes; /** * Returns an array of type schemes with the provided tags. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#getSchemesByTag) */ getSchemesByTag(params: typeGetSchemesByTagParams): TypeScheme[]; /** * Returns metadata for the available themes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#getThemes) */ getThemes(basemap?: string | Basemap): colorTheme[]; } export const symbologyType: symbologyType; export interface typeGetSchemeByNameParams { /** * The name of the scheme to retrieve. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#getSchemeByName) */ name: string; /** * The basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#getSchemeByName) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#getSchemeByName) */ basemapTheme?: "light" | "dark"; /** * The geometry type of the features to visualize. * * [Read more...](global.html#geometryType) */ geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; /** * Determines whether to return a standardized unique value scheme for point cloud class renderers (i.e. * * @default default * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#getSchemeByName) */ theme?: "point-cloud-class" | "default"; /** * Indicates if the size units of the scheme will be in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#getSchemeByName) */ worldScale?: boolean; /** * The SceneView instance in which the scheme will be used. * * [Read more...](global.html) */ view?: SceneView; } export interface typeGetSchemesByTagParams { /** * When provided, only schemes containing all the matching tags will be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#getSchemesByTag) */ includedTags?: string[]; /** * When provided, only schemes missing all the provided tags will be returned. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#getSchemesByTag) */ excludedTags?: string[]; /** * The basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#getSchemesByTag) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#getSchemesByTag) */ basemapTheme?: "light" | "dark"; /** * The geometry type of the features to visualize. * * [Read more...](global.html#geometryType) */ geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; /** * Determines whether to return a standardized unique value scheme for point cloud class renderers (i.e. * * @default default * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#getSchemesByTag) */ theme?: "point-cloud-class" | "default"; /** * Indicates if the size units of the scheme will be in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#getSchemesByTag) */ worldScale?: boolean; /** * The SceneView instance in which the scheme will be used. * * [Read more...](global.html) */ view?: SceneView; } export interface typeGetSchemesParams { /** * The Esri basemap to pair with the visualization. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#getSchemes) */ basemap?: string | Basemap; /** * If you have a non-Esri basemap (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#getSchemes) */ basemapTheme?: "light" | "dark"; /** * The geometry type of the features to visualize. * * [Read more...](global.html#geometryType) */ geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; /** * Determines whether to return a standardized unique value scheme for point cloud class renderers (i.e. * * @default default * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#getSchemes) */ theme?: "point-cloud-class" | "default"; /** * Indicates if the size units of the scheme will be in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#getSchemes) */ worldScale?: boolean; /** * The SceneView instance in which the scheme will be used. * * [Read more...](global.html) */ view?: SceneView; } /** * Properties defining the symbology scheme used to visualize features with attribute data-driven types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeScheme) */ export type TypeScheme = TypeSchemeForPoint | TypeSchemeForPolyline | TypeSchemeForPolygon | TypeSchemeForMesh; /** * Properties defining the symbology scheme used to visualize mesh features driven by type-based attribute data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForMesh) */ export interface TypeSchemeForMesh { /** * The unique name of the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForMesh) */ name: string; /** * Tags associated with the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForMesh) */ tags: string[]; /** * The fill colors of the symbols comprising the theme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForMesh) */ colors: Color[]; /** * The color of the fill symbol used to indicate features with no data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForMesh) */ noDataColor: Color; /** * The opacity of the symbol (0 - 1). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForMesh) */ opacity: number; } /** * Properties defining the symbology scheme used to visualize point features driven by type-based attribute data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPoint) */ export interface TypeSchemeForPoint { /** * The unique name of the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPoint) */ name: string; /** * Tags associated with the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPoint) */ tags: string[]; /** * The fill colors of the point symbols comprising the theme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPoint) */ colors: Color[]; /** * The color of the point symbol used to indicate features with no data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPoint) */ noDataColor: Color; /** * Properties for defining the outline of the marker symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPoint) */ outline: TypeSchemeForPointOutline; /** * The default size of the point symbol in pixels, points, or real-world units. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPoint) */ size: number; /** * The opacity of the point symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPoint) */ opacity: number; } /** * Properties defining the symbology scheme used to visualize polygon features driven by type-based attribute data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPolygon) */ export interface TypeSchemeForPolygon { /** * The unique name of the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPolygon) */ name: string; /** * Tags associated with the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPolygon) */ tags: string[]; /** * The fill colors of the symbols comprising the theme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPolygon) */ colors: Color[]; /** * The color of the fill symbol used to indicate features with no data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPolygon) */ noDataColor: Color; /** * Properties for defining the outline of the fill symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPolygon) */ outline: TypeSchemeForPolygonOutline; /** * The opacity of the symbol (0 - 1). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPolygon) */ opacity: number; } /** * Properties defining the symbology scheme used to visualize polyline features driven by type-based attribute data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPolyline) */ export interface TypeSchemeForPolyline { /** * The unique name of the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPolyline) */ name: string; /** * Tags associated with the scheme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPolyline) */ tags: string[]; /** * The colors of the line symbols comprising the theme. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPolyline) */ colors: Color[]; /** * The color of the line symbol used to indicate features with no data and features that are out of range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPolyline) */ noDataColor: Color; /** * The default width of the line symbol in pixels or points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPolyline) */ width: number; /** * The opacity of the line symbol (0 - 1). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPolyline) */ opacity: number; } /** * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#getSchemes) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemes) */ export interface TypeSchemes { /** * The type scheme best suited for the given basemap and geometry type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemes) */ primaryScheme: TypeScheme; /** * Additional type schemes that may be used to visualize data of the given geometry type overlaid on the given basemap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemes) */ secondarySchemes: TypeScheme[]; /** * The ID of the basemap associated with the given schemes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemes) */ basemapId: string; /** * Indicates whether the average basemap color is `light` or `dark`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemes) */ basemapTheme: string; } export interface TypeSchemeForPointOutline { /** * The outline color of the marker symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPoint) */ color: Color; /** * The width of the marker symbol in pixels or points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPoint) */ width: number; } export interface TypeSchemeForPolygonOutline { /** * The outline color of the fill symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPolygon) */ color: Color; /** * The width of the fill symbol's outline in pixels or points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#TypeSchemeForPolygon) */ width: number; } export interface ActionBase extends Accessor, Identifiable { } export class ActionBase { /** * Set this property to `true` to display a spinner icon. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#active) */ active: boolean; /** * This adds a CSS class to the [ActionButton's](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) node. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#className) */ className: string; /** * Indicates whether this action is disabled. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#disabled) */ disabled: boolean; /** * Calcite icon used for the action. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#icon) */ icon: string; /** * The name of the ID assigned to this action. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#id) */ id: string; /** * The title of the action. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#title) */ title: string; /** * Specifies the type of action. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#type) */ type: "button" | "slider" | "toggle"; /** * Indicates if the action is visible. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#visible) */ visible: boolean; /** * Actions are customizable behavior which can be executed in certain widgets such as [Popups](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html), a [BasemapLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html), or a [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html) */ constructor(properties?: ActionBaseProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#clone) */ clone(): ActionBase; } interface ActionBaseProperties { /** * Set this property to `true` to display a spinner icon. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#active) */ active?: boolean; /** * This adds a CSS class to the [ActionButton's](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) node. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#className) */ className?: string; /** * Indicates whether this action is disabled. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#disabled) */ disabled?: boolean; /** * Calcite icon used for the action. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#icon) */ icon?: string; /** * The name of the ID assigned to this action. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#id) */ id?: string; /** * The title of the action. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#title) */ title?: string; /** * Specifies the type of action. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#type) */ type?: "button" | "slider" | "toggle"; /** * Indicates if the action is visible. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#visible) */ visible?: boolean; } export class ActionButton extends ActionBase { /** * The URL to an image that will be used to represent the action. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html#image) */ image: string; /** * Specifies the type of action. * * @default "button" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html#type) */ readonly type: "button"; /** * A customizable button that performs a specific action(s) used in widgets such as the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html), [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html), and [BasemapLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) */ constructor(properties?: ActionButtonProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html#clone) */ clone(): ActionButton; } interface ActionButtonProperties extends ActionBaseProperties { /** * The URL to an image that will be used to represent the action. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html#image) */ image?: string; } export class ActionToggle extends ActionBase { /** * Specifies the type of action. * * @default "toggle" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html#type) */ readonly type: "toggle"; /** * Indicates the value of whether the action is toggled on/off. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html#value) */ value: boolean; /** * A customizable toggle used in the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widget that performs a specific action(s) which can be toggled on/off. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html) */ constructor(properties?: ActionToggleProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html#clone) */ clone(): ActionToggle; } interface ActionToggleProperties extends ActionBaseProperties { /** * Indicates the value of whether the action is toggled on/off. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html#value) */ value?: boolean; } export class BasemapStyle extends Accessor { /** * The id of the basemap style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-BasemapStyle.html#id) */ id: string; /** * The language of the place labels in the basemap style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-BasemapStyle.html#language) */ language: string; /** * Indicates whether to display [places](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-places.html) with the basemap style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-BasemapStyle.html#places) */ places: "all" | "attributed" | "none"; /** * The [URL](https://developers.arcgis.com/rest/basemap-styles/#service-url) to the basemap styles service. * * @default "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-BasemapStyle.html#serviceUrl) */ serviceUrl: string; /** * Displays country boundaries and labels based on a specific view of a country. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-BasemapStyle.html#worldview) */ worldview: string; /** * The style of the basemap from the [basemap styles service (v2)](https://developers.arcgis.com/rest/basemap-styles/). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-BasemapStyle.html) */ constructor(properties?: BasemapStyleProperties); } interface BasemapStyleProperties { /** * The id of the basemap style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-BasemapStyle.html#id) */ id?: string; /** * The language of the place labels in the basemap style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-BasemapStyle.html#language) */ language?: string; /** * Indicates whether to display [places](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-places.html) with the basemap style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-BasemapStyle.html#places) */ places?: "all" | "attributed" | "none"; /** * The [URL](https://developers.arcgis.com/rest/basemap-styles/#service-url) to the basemap styles service. * * @default "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-BasemapStyle.html#serviceUrl) */ serviceUrl?: string; /** * Displays country boundaries and labels based on a specific view of a country. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-BasemapStyle.html#worldview) */ worldview?: string; } export class LayersMixin { /** * A collection of operational [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#layers) */ layers: Collection; /** * Adds a layer to the [layers collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#layers). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#add) */ add(layer: Layer | Promise, index?: number): void; /** * Adds a layer or an array of layers to the [layers collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#layers). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#addMany) */ addMany(layers: Layer[], index?: number): void; /** * Returns a layer based on the given layer ID. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#findLayerById) */ findLayerById(layerId: string): Layer; /** * Removes the specified layer from the layers collection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#remove) */ remove(layer: Layer): Layer; /** * Removes all layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#removeAll) */ removeAll(): Layer[]; /** * Removes the specified layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#removeMany) */ removeMany(layers: Layer[]): Layer[]; /** * Changes the layer order. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#reorder) */ reorder(layer: Layer, index: number): Layer; } interface LayersMixinProperties { /** * A collection of operational [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#layers) */ layers?: CollectionProperties | LayerProperties[]; } export interface MapFloorInfo extends Accessor, JSONSupport { } export class MapFloorInfo { /** * Contains the facility features of a floor plan, which describe the footprints of managed buildings and other structures. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-MapFloorInfo.html#facilityLayer) */ facilityLayer: FacilityLayerInfo; /** * Contains the level features of a floor plan, which describe the footprint of each occupiable floor contained in a managed facility. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-MapFloorInfo.html#levelLayer) */ levelLayer: LevelLayerInfo; /** * Contains the site features of a floor plan, which describe the boundaries of managed sites and is used for visualization in mapmaking. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-MapFloorInfo.html#siteLayer) */ siteLayer: SiteLayerInfo; /** * Floor-aware maps facilitate visualizing, editing, and analyzing indoor data and they allow for fast navigation of buildings in maps and scenes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-MapFloorInfo.html) */ constructor(properties?: MapFloorInfoProperties); static fromJSON(json: any): MapFloorInfo; } interface MapFloorInfoProperties { /** * Contains the facility features of a floor plan, which describe the footprints of managed buildings and other structures. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-MapFloorInfo.html#facilityLayer) */ facilityLayer?: FacilityLayerInfoProperties; /** * Contains the level features of a floor plan, which describe the footprint of each occupiable floor contained in a managed facility. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-MapFloorInfo.html#levelLayer) */ levelLayer?: LevelLayerInfoProperties; /** * Contains the site features of a floor plan, which describe the boundaries of managed sites and is used for visualization in mapmaking. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-MapFloorInfo.html#siteLayer) */ siteLayer?: SiteLayerInfoProperties; } /** * Various utils for working with [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) widget functionality. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-popupUtils.html) */ interface popupUtils { /** * Creates an array of [fieldInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html) used for populating [FieldsContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-FieldsContent.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-popupUtils.html#createFieldInfos) */ createFieldInfos(config: FieldInfosConfig, options?: CreatePopupTemplateOptions): FieldInfo[]; /** * Creates [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-FieldsContent.html) content used for populating a [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-popupUtils.html#createFieldsContent) */ createFieldsContent(config: FieldInfosConfig, options?: CreatePopupTemplateOptions): FieldsContent; /** * Creates a popup template given the specified [config](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-popupUtils.html#Config) information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-popupUtils.html#createPopupTemplate) */ createPopupTemplate(config: Config, options?: CreatePopupTemplateOptions): PopupTemplate; /** * Creates a default popup template to use for [FeatureReductionBinning](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html) or [FeatureReductionCluster](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html) visualizations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-popupUtils.html#createPopupTemplateForFeatureReduction) */ createPopupTemplateForFeatureReduction(params: popupUtilsCreatePopupTemplateForFeatureReductionParams): PopupTemplate; } export const popupUtils: popupUtils; /** * A configuration object containing properties for creating a [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-popupUtils.html#Config) */ export interface Config { /** * The display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-popupUtils.html#Config) */ displayField?: string; /** * The title for the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-popupUtils.html#Config) */ title: string; /** * The fields that record who adds or edits data in the feature service and when the edit is made. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-popupUtils.html#Config) */ editFieldsInfo?: EditFieldsInfo; /** * The fields displayed within the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-popupUtils.html#Config) */ fields: Field[]; /** * The object id field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-popupUtils.html#Config) */ objectIdField?: string; } /** * Options for creating the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-popupUtils.html#CreatePopupTemplateOptions) */ export interface CreatePopupTemplateOptions { /** * An array of field types to ignore when creating the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-popupUtils.html#CreatePopupTemplateOptions) */ ignoreFieldTypes?: string[]; /** * An array of field names set to be visible within the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-popupUtils.html#CreatePopupTemplateOptions) */ visibleFieldNames?: Set; } /** * A configuration object containing field properties for creating [FieldsContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-FieldsContent.html) for a [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-popupUtils.html#FieldInfosConfig) */ export interface FieldInfosConfig { /** * The fields that record who adds or edits data in the feature service and when the edit is made. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-popupUtils.html#FieldInfosConfig) */ editFieldsInfo?: EditFieldsInfo; /** * The fields displayed within the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-popupUtils.html#FieldInfosConfig) */ fields: Field[]; /** * The object id field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-popupUtils.html#FieldInfosConfig) */ objectIdField?: string; } export interface popupUtilsCreatePopupTemplateForFeatureReductionParams { /** * The FeatureReduction object for which to create a default popup template. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-popupUtils.html#createPopupTemplateForFeatureReduction) */ featureReduction: FeatureReductionBinning | FeatureReductionCluster; /** * The fields of the layer aggregated during the feature reduction process. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-popupUtils.html#createPopupTemplateForFeatureReduction) */ fields?: Field[]; /** * The title to display in the popup template. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-popupUtils.html#createPopupTemplateForFeatureReduction) */ title?: string; } export class TablesMixin { /** * A collection of [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) instances that are tables saved in a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) and/or a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-TablesMixin.html#tables) */ tables: Collection; /** * Returns a table based on the given table ID. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-TablesMixin.html#findTableById) */ findTableById(tableId: string): Layer; } interface TablesMixinProperties { /** * A collection of [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) instances that are tables saved in a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) and/or a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-TablesMixin.html#tables) */ tables?: CollectionProperties | LayerProperties[]; } /** * Provides utility methods for working with [dates](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-timeUtils.html) */ interface timeUtils { /** * Returns the time extent of all layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-timeUtils.html#getTimeExtentFromLayers) */ getTimeExtentFromLayers(layers: Layer[] | Collection, signal?: AbortSignal): Promise; /** * Extracts time slider settings from a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html) if the webmap contains a [time slider widget](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#TimeSlider) definition. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-timeUtils.html#getTimeSliderSettingsFromWebMap) */ getTimeSliderSettingsFromWebMap(webMap: WebMap, signal?: AbortSignal): Promise; } export const timeUtils: timeUtils; /** * A convenience module for importing [Symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol.html) classes when developing with [TypeScript](https://developers.arcgis.com/javascript/latest/typescript-setup/). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html) */ namespace symbols { /** * CIMSymbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#CIMSymbol) */ export type CIMSymbol = __esri.CIMSymbol; export const CIMSymbol: typeof __esri.CIMSymbol; /** * ExtrudeSymbol3DLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#ExtrudeSymbol3DLayer) */ export type ExtrudeSymbol3DLayer = __esri.ExtrudeSymbol3DLayer; export const ExtrudeSymbol3DLayer: typeof __esri.ExtrudeSymbol3DLayer; /** * FillSymbol3DLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#FillSymbol3DLayer) */ export type FillSymbol3DLayer = __esri.FillSymbol3DLayer; export const FillSymbol3DLayer: typeof __esri.FillSymbol3DLayer; /** * WaterSymbol3DLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#WaterSymbol3DLayer) */ export type WaterSymbol3DLayer = __esri.WaterSymbol3DLayer; export const WaterSymbol3DLayer: typeof __esri.WaterSymbol3DLayer; /** * Font. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#Font) */ export type Font = __esri.Font; export const Font: typeof __esri.Font; /** * IconSymbol3DLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#IconSymbol3DLayer) */ export type IconSymbol3DLayer = __esri.IconSymbol3DLayer; export const IconSymbol3DLayer: typeof __esri.IconSymbol3DLayer; /** * LabelSymbol3D. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#LabelSymbol3D) */ export type LabelSymbol3D = __esri.LabelSymbol3D; export const LabelSymbol3D: typeof __esri.LabelSymbol3D; /** * LineSymbol3D. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#LineSymbol3D) */ export type LineSymbol3D = __esri.LineSymbol3D; export const LineSymbol3D: typeof __esri.LineSymbol3D; /** * LineSymbol3DLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#LineSymbol3DLayer) */ export type LineSymbol3DLayer = __esri.LineSymbol3DLayer; export const LineSymbol3DLayer: typeof __esri.LineSymbol3DLayer; /** * MeshSymbol3D. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#MeshSymbol3D) */ export type MeshSymbol3D = __esri.MeshSymbol3D; export const MeshSymbol3D: typeof __esri.MeshSymbol3D; /** * ObjectSymbol3DLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#ObjectSymbol3DLayer) */ export type ObjectSymbol3DLayer = __esri.ObjectSymbol3DLayer; export const ObjectSymbol3DLayer: typeof __esri.ObjectSymbol3DLayer; /** * PathSymbol3DLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#PathSymbol3DLayer) */ export type PathSymbol3DLayer = __esri.PathSymbol3DLayer; export const PathSymbol3DLayer: typeof __esri.PathSymbol3DLayer; /** * PictureFillSymbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#PictureFillSymbol) */ export type PictureFillSymbol = __esri.PictureFillSymbol; export const PictureFillSymbol: typeof __esri.PictureFillSymbol; /** * PictureMarkerSymbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#PictureMarkerSymbol) */ export type PictureMarkerSymbol = __esri.PictureMarkerSymbol; export const PictureMarkerSymbol: typeof __esri.PictureMarkerSymbol; /** * PointSymbol3D. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#PointSymbol3D) */ export type PointSymbol3D = __esri.PointSymbol3D; export const PointSymbol3D: typeof __esri.PointSymbol3D; /** * PolygonSymbol3D. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#PolygonSymbol3D) */ export type PolygonSymbol3D = __esri.PolygonSymbol3D; export const PolygonSymbol3D: typeof __esri.PolygonSymbol3D; /** * SimpleFillSymbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#SimpleFillSymbol) */ export type SimpleFillSymbol = __esri.SimpleFillSymbol; export const SimpleFillSymbol: typeof __esri.SimpleFillSymbol; /** * SimpleLineSymbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#SimpleLineSymbol) */ export type SimpleLineSymbol = __esri.SimpleLineSymbol; export const SimpleLineSymbol: typeof __esri.SimpleLineSymbol; /** * SimpleMarkerSymbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#SimpleMarkerSymbol) */ export type SimpleMarkerSymbol = __esri.SimpleMarkerSymbol; export const SimpleMarkerSymbol: typeof __esri.SimpleMarkerSymbol; /** * TextSymbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#TextSymbol) */ export type TextSymbol = __esri.TextSymbol; export const TextSymbol: typeof __esri.TextSymbol; /** * TextSymbol3DLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#TextSymbol3DLayer) */ export type TextSymbol3DLayer = __esri.TextSymbol3DLayer; export const TextSymbol3DLayer: typeof __esri.TextSymbol3DLayer; /** * WebStyleSymbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#WebStyleSymbol) */ export type WebStyleSymbol = __esri.WebStyleSymbol; export const WebStyleSymbol: typeof __esri.WebStyleSymbol; /** * FillSymbol types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#FillSymbol) */ export type FillSymbol = __esri.PictureFillSymbol | __esri.SimpleFillSymbol; /** * MarkerSymbol types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#MarkerSymbol) */ export type MarkerSymbol = __esri.PictureMarkerSymbol | __esri.SimpleMarkerSymbol; /** * Symbol2D types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#Symbol2D) */ export type Symbol2D = | __esri.PictureFillSymbol | __esri.PictureMarkerSymbol | __esri.SimpleFillSymbol | __esri.SimpleLineSymbol | __esri.SimpleMarkerSymbol | __esri.TextSymbol | __esri.CIMSymbol; /** * Symbol3DLayer types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#Symbol3DLayer) */ export type Symbol3DLayer = | __esri.ExtrudeSymbol3DLayer | __esri.FillSymbol3DLayer | __esri.WaterSymbol3DLayer | __esri.IconSymbol3DLayer | __esri.LineSymbol3DLayer | __esri.ObjectSymbol3DLayer | __esri.PathSymbol3DLayer | __esri.TextSymbol3DLayer | __esri.WaterSymbol3DLayer; /** * Symbol3D types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#Symbol3D) */ export type Symbol3D = | __esri.LabelSymbol3D | __esri.LineSymbol3D | __esri.MeshSymbol3D | __esri.PointSymbol3D | __esri.PolygonSymbol3D; /** * Symbol2D3D types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#Symbol2D3D) */ export type Symbol2D3D = __esri.Symbol2D | __esri.symbolsSymbol3D; /** * Symbol types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#Symbol) */ export type Symbol = __esri.Symbol2D3D | __esri.WebStyleSymbol; } export interface Callout3D extends Accessor, JSONSupport { } export class Callout3D { /** * When symbols have an offset from their position, it's important to still see what the real location is. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-Callout3D.html) */ constructor(properties?: Callout3DProperties); /** * Creates a deep clone of the callout. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-Callout3D.html#clone) */ clone(): Callout3D; static fromJSON(json: any): Callout3D; } interface Callout3DProperties { } export class LineCallout3D extends Callout3D { /** * The border settings of the callout line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html#border) */ border: LineCallout3DBorder; /** * The color of the callout line. * * @default black * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html#color) */ color: Color; /** * The width of the callout line in points. * * @default 1px * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html#size) */ size: number; type: "line"; /** * This type of callout displays a line to connect a symbol or a label with its actual location in the scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html) */ constructor(properties?: LineCallout3DProperties); /** * Creates a deep clone of the callout. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html#clone) */ clone(): LineCallout3D; static fromJSON(json: any): LineCallout3D; } interface LineCallout3DProperties extends Callout3DProperties { /** * The border settings of the callout line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html#border) */ border?: LineCallout3DBorderProperties; /** * The color of the callout line. * * @default black * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html#color) */ color?: Color | number[] | string; /** * The width of the callout line in points. * * @default 1px * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html#size) */ size?: number | string; type?: "line"; } export interface LineCallout3DBorderProperties { /** * The color of the callout line border. * * @default white * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html#border) */ color?: Color | number[] | string; } export interface LineCallout3DBorder extends AnonymousAccessor { /** * The color of the callout line border. * * @default white * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html#border) */ color?: Color; } export class CIMSymbol extends Symbol { /** * The JSON payload of the [CIMSymbolReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSymbolReference). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#data) */ data: CIMSymbolReference; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#type) */ readonly type: "cim"; /** * CIMSymbols are high quality, scalable, multi-layer vector symbols for features and graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html) */ constructor(properties?: CIMSymbolProperties); /** * Creates a deep clone of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#clone) */ clone(): CIMSymbol; static fromJSON(json: any): CIMSymbol; } interface CIMSymbolProperties extends SymbolProperties { /** * The JSON payload of the [CIMSymbolReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSymbolReference). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#data) */ data?: CIMSymbolReference; } /** * Represents animated symbol properties, a collection of symbol properties that apply when the symbol layer has animation data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMAnimatedSymbolProperties) */ export interface CIMAnimatedSymbolProperties { /** * Indicates whether the animated symbol should play its animation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMAnimatedSymbolProperties) */ playAnimation?: boolean; /** * Indicates whether the animated symbol should play back in reverse. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMAnimatedSymbolProperties) */ reverseAnimation?: boolean; /** * Indicates whether to generate a randomized start offset in seconds to apply to the symbol animation of each feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMAnimatedSymbolProperties) */ randomizeStartTime?: boolean; /** * The starting value for generating a random number. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMAnimatedSymbolProperties) */ randomizeStartSeed?: number; /** * The time offset in seconds to use as the starting point of the symbol animation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMAnimatedSymbolProperties) */ startTimeOffset?: number; /** * The time (in seconds) it take to play through the symbol's animation once. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMAnimatedSymbolProperties) */ duration?: number; /** * Determines how to repeat the animation of a symbol when the animation cycle ends. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMAnimatedSymbolProperties) */ repeatType?: "None" | "Loop" | "Oscillate"; /** * The number of seconds to delay before repeating an animation cycle. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMAnimatedSymbolProperties) */ repeatDelay?: number; } /** * Represents a background callout for a [CIMTextSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMTextSymbol). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMBackgroundCallout) */ export interface CIMBackgroundCallout { /** * The callout type. * * [Read more...](global.html#type) */ type: "CIMBackgroundCallout"; /** * The symbol used to draw the background. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMBackgroundCallout) */ backgroundSymbol: CIMPolygonSymbol; } /** * Represents color substitution, an ordered list of color substitutes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMColorSubstitution) */ export interface CIMColorSubstitution { /** * The old color (the color that will be substituted). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMColorSubstitution) */ oldColor: number[]; /** * The new color that will replace the old color. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMColorSubstitution) */ newColor: number[]; } /** * Represents a geometric effect. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffect) */ export type CIMGeometricEffect = | CIMGeometricEffectArrow | CIMGeometricEffectBuffer | CIMGeometricEffectControlMeasureLine | CIMGeometricEffectCut | CIMGeometricEffectDashes | CIMGeometricEffectDonut | CIMGeometricEffectJog | CIMGeometricEffectMove | CIMGeometricEffectOffset | CIMGeometricEffectRotate | CIMGeometricEffectScale | CIMGeometricEffectWave; /** * Represents the arrow geometric effect which creates a dynamic line along a line feature with an arrow of a specified arrow type and width. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectArrow) */ export interface CIMGeometricEffectArrow { type: "CIMGeometricEffectArrow"; /** * The primitive name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectArrow) */ primitiveName?: string; /** * The type of arrow to be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectArrow) */ geometricEffectArrowType: "OpenEnded" | "Block" | "Crossed"; /** * The distance between the lines that construct the body of the arrow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectArrow) */ width: number; } /** * Represents the buffer geometric effect which creates a dynamic polygon with a specified distance around features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectBuffer) */ export interface CIMGeometricEffectBuffer { type: "CIMGeometricEffectBuffer"; /** * The primitive name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectBuffer) */ primitiveName?: string; /** * The distance from the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectBuffer) */ size: number; } /** * Represents the control measure line geometric effect. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectControlMeasureLine) */ export interface CIMGeometricEffectControlMeasureLine { type: "CIMGeometricEffectControlMeasureLine"; /** * The primitive name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectControlMeasureLine) */ primitiveName?: string; /** * The style of effect. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectControlMeasureLine) */ rule: string; } /** * Represents the cut geometric effect which creates a dynamic line that is shorter on one or both ends than the line feature or polygon outline. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectCut) */ export interface CIMGeometricEffectCut { type: "CIMGeometricEffectCut"; /** * The primitive name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectCut) */ primitiveName?: string; /** * The distance from the beginning of a line that the display of the stroke starts. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectCut) */ beginCut?: number; /** * The distance from the end of a line that the display of the stroke ends. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectCut) */ endCut?: number; /** * The distance around the middle of a line that the display of the stroke is interrupted. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectCut) */ middleCut?: number; /** * A value indicating whether the effect should be applied in the opposite manner. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectCut) */ invert?: boolean; } /** * Represents the dashes geometric effect which creates a dynamic multipart line geometry from a line feature or the outline of a polygon based on a template. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectDashes) */ export interface CIMGeometricEffectDashes { type: "CIMGeometricEffectDashes"; /** * The primitive name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectDashes) */ primitiveName?: string; /** * Where the pattern should end relative to the ending point of the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectDashes) */ customEndingOffset?: number; /** * The distance for each dash and gap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectDashes) */ dashTemplate: number[]; /** * The setting which determines how the strokes with dash patterns are handled at the end points of the line geometry's segments. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectDashes) */ lineDashEnding: "NoConstraint" | "HalfPattern" | "HalfGap" | "FullPattern" | "FullGap" | "Custom"; /** * The position where the pattern should begin relative to the starting point of the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectDashes) */ offsetAlongLine: number; } /** * Represents the donut geometric effect which creates a dynamic polygon ring of a specified width in relation to the outline of polygon features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectDonut) */ export interface CIMGeometricEffectDonut { type: "CIMGeometricEffectDonut"; /** * The primitive name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectDonut) */ primitiveName?: string; /** * The option for the way the symbol handles complex geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectDonut) */ option: "Fast" | "Accurate"; /** * The distance from the edge of the polygon that the fill symbol is to be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectDonut) */ width: number; } /** * Represents the jog geometric effect which creates a dynamic line with a jog of a specified angle, position, and width in the line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectJog) */ export interface CIMGeometricEffectJog { type: "CIMGeometricEffectJog"; /** * The primitive name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectJog) */ primitiveName?: string; /** * The angle of the job in the line which is measured in degrees. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectJog) */ angle: number; /** * The length of the segment that forms the jog in the line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectJog) */ length: number; /** * The location of the center of the jog, as a percentage measured from the start of the input geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectJog) */ position: number; } /** * Represents the move geometric effect which creates a point, line or polygon that is offset a specified distance in X and Y. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectMove) */ export interface CIMGeometricEffectMove { type: "CIMGeometricEffectMove"; /** * The primitive name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectMove) */ primitiveName?: string; /** * The distance to move the symbol along the X-axis of the feature geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectMove) */ offsetX?: number; /** * The distance to move the symbol along the Y-axis of the feature geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectMove) */ offsetY?: number; } /** * Represents the offset geometric effect which creates a dynamic line or polygon offset at a specified distance perpendicularly from a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectOffset) */ export interface CIMGeometricEffectOffset { type: "CIMGeometricEffectOffset"; /** * The primitive name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectOffset) */ primitiveName?: string; /** * The way strokes or fills are displayed at corners. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectOffset) */ method: "Mitered" | "Bevelled" | "Rounded" | "Square"; /** * The distance of the symbol perpendicular to the feature geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectOffset) */ offset: number; /** * The way the symbol handles complex geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectOffset) */ option: "Fast" | "Accurate"; } /** * Represents the rotate geometric effect which creates a dynamic line or polygon rotated a specified angle from the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectRotate) */ export interface CIMGeometricEffectRotate { type: "CIMGeometricEffectRotate"; /** * The primitive name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectRotate) */ primitiveName?: string; /** * The amount of rotation for the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectRotate) */ angle: number; } /** * Represents the rotate geometric effect which creates a dynamic line or polygon scaled by a specified factor. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectScale) */ export interface CIMGeometricEffectScale { type: "CIMGeometricEffectScale"; /** * The primitive name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectScale) */ primitiveName?: string; /** * The amount of change in size of a symbol in the x-axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectScale) */ XScaleFactor: number; /** * The amount of change in size of a symbol in the x-axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectScale) */ YScaleFactor: number; } /** * Represents the wave geometric effect which creates a dynamic line or polygon along a feature with a repeating wave pattern. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectWave) */ export interface CIMGeometricEffectWave { type: "CIMGeometricEffectWave"; /** * The primitive name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectWave) */ primitiveName?: string; /** * The distance perpendicular to a feature to display the curves for the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectWave) */ amplitude: number; /** * The distance along the line or polygon to display the curves for the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectWave) */ period: number; /** * The starting value for generating a random number. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectWave) */ seed?: number; /** * The shape of the curves to be displayed along the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMGeometricEffectWave) */ waveform: "Sinus" | "Square" | "Triangle" | "Random"; } /** * Represents a hatch fill which fills polygonal geometry with a uniform series of parallel line symbols. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMHatchFill) */ export interface CIMHatchFill { type: "CIMHatchFill"; /** * The geometric effects applied to the symbol layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMHatchFill) */ effects?: CIMGeometricEffect[]; /** * A value indicating whether the symbol layer is visible. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMHatchFill) */ enable: boolean; /** * A value indicating whether the color can be changed for this symbol layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMHatchFill) */ colorLocked?: boolean; /** * The primitive name of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMHatchFill) */ primitiveName?: string; /** * The line symbol that is used to draw the hatch lines in the fill. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMHatchFill) */ lineSymbol: CIMLineSymbol; /** * How much to move the stroke to a new X-position. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMHatchFill) */ offsetX?: number; /** * How much to move the stroke to a new Y-position. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMHatchFill) */ offsetY?: number; /** * The angle of rotation for all the strokes, in degrees. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMHatchFill) */ rotation?: number; /** * The distance between the line symbols in the hatch pattern. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMHatchFill) */ separation: number; } /** * Represents a line symbol used to draw polyline features and graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMLineSymbol) */ export interface CIMLineSymbol { type: "CIMLineSymbol"; /** * The symbol layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMLineSymbol) */ symbolLayers: CIMSymbolLayer[]; /** * The geometric effects applied to the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMLineSymbol) */ effects?: CIMGeometricEffect[]; /** * A value indicating whether the symbol size properties are rendered using real world units or page units. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMLineSymbol) */ useRealWorldSymbolSizes?: boolean; } /** * Represents a marker graphic which is used to define vector graphics in a vector marker. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerGraphic) */ export interface CIMMarkerGraphic { type: "CIMMarkerGraphic"; /** * The geometry of the marker. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerGraphic) */ geometry: any; /** * The symbol used to draw the marker graphic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerGraphic) */ symbol: CIMPointSymbol | CIMLineSymbol | CIMPolygonSymbol | CIMTextSymbol; /** * The text that is defined within the marker if drawn with a text symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerGraphic) */ textString?: string; /** * The primitive name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerGraphic) */ primitiveName?: string; } /** * Represents marker placement along the line which places markers that are the same size evenly along a line or polygon outline. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAlongLineSameSize) */ export interface CIMMarkerPlacementAlongLineSameSize { type: "CIMMarkerPlacementAlongLineSameSize"; /** * The primitive name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAlongLineSameSize) */ primitiveName?: string; /** * A value indicating whether to consider individual geometry parts or the whole geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAlongLineSameSize) */ placePerPart?: boolean; /** * A value indicating whether to angle the marker to the line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAlongLineSameSize) */ angleToLine?: boolean; /** * The offset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAlongLineSameSize) */ offset?: number; /** * Where the pattern should end relative to the ending point of the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAlongLineSameSize) */ customEndingOffset?: number; /** * How markers are placed at the end points of a line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAlongLineSameSize) */ endings?: "NoConstraint" | "WithMarkers" | "WithFullGap" | "WithHalfGap" | "Custom"; /** * Where the pattern should begin relative to the starting point of the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAlongLineSameSize) */ offsetAlongLine?: number; /** * The numeric pattern that defines the sequence of placed markers and the length of space between them. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAlongLineSameSize) */ placementTemplate: number[]; } /** * Represents marker placement at extremities which places markers at only one or both endpoints of a line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAtExtremities) */ export interface CIMMarkerPlacementAtExtremities { type: "CIMMarkerPlacementAtExtremities"; /** * The primitive name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAtExtremities) */ primitiveName?: string; /** * A value indicating whether to consider individual geometry parts or the whole geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAtExtremities) */ placePerPart?: boolean; /** * A value indicating whether to angle the marker to the line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAtExtremities) */ angleToLine?: boolean; /** * The offset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAtExtremities) */ offset?: number; /** * Which ends of the line a marker will be placed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAtExtremities) */ extremityPlacement?: "Both" | "JustBegin" | "JustEnd" | "None"; /** * The distance from the ends of a line that the marker will be placed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAtExtremities) */ offsetAlongLine?: number; } /** * Represents marker placement at ratio positions which places a set number of markers along the line or the outline of a polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAtRatioPositions) */ export interface CIMMarkerPlacementAtRatioPositions { type: "CIMMarkerPlacementAtRatioPositions"; /** * The primitive name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAtRatioPositions) */ primitiveName?: string; /** * A value indicating whether to consider individual geometry parts or the whole geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAtRatioPositions) */ placePerPart?: boolean; /** * A value indicating whether to angle the marker to the line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAtRatioPositions) */ angleToLine?: boolean; /** * The offset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAtRatioPositions) */ offset?: number; /** * The distance from the beginning of a line that the marker will be placed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAtRatioPositions) */ beginPosition?: number; /** * The distance from the end of a line that the marker will be placed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAtRatioPositions) */ endPosition?: number; /** * A value indicating whether only the first marker will be rotated 180 degrees. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAtRatioPositions) */ flipFirst?: boolean; /** * The array of positions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementAtRatioPositions) */ positionArray: number[]; } /** * Represents marker placement inside a polygon which defines how a polygon is filled with a pattern of markers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementInsidePolygon) */ export interface CIMMarkerPlacementInsidePolygon { type: "CIMMarkerPlacementInsidePolygon"; /** * The primitive name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementInsidePolygon) */ primitiveName?: string; /** * A value indicating whether to consider individual geometry parts or the whole geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementInsidePolygon) */ placePerPart?: boolean; /** * The orientation angle that the markers are placed on within the polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementInsidePolygon) */ gridAngle?: number; /** * The grid type which defines how markers are placed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementInsidePolygon) */ gridType?: "Fixed" | "Random"; /** * The marker row offset horizontally. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementInsidePolygon) */ offsetX?: number; /** * The marker row offset vertically. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementInsidePolygon) */ offsetY?: number; /** * A value indicating whether every other row of markers should be shifted to create an offset grid. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementInsidePolygon) */ shiftOddRows?: boolean; /** * The distance between each marker on the X-axis of the grid. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementInsidePolygon) */ stepX?: number; /** * The distance between each marker on the Y-axis of the grid. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementInsidePolygon) */ stepY?: number; /** * _Since 4.24_ A percentage that determines the randomness of markers within the polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementInsidePolygon) */ randomness?: number; /** * _Since 4.24_ The starting value for generating a random pattern. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementInsidePolygon) */ seed?: number; /** * The clipping option which specifies how markers should be clipped at the polygon boundary. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementInsidePolygon) */ clipping?: "ClipAtBoundary"; } /** * Represents a marker placement on the line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementOnLine) */ export interface CIMMarkerPlacementOnLine { type: "CIMMarkerPlacementOnLine"; /** * The primitive name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementOnLine) */ primitiveName?: string; /** * A value indicating whether to consider individual geometry parts or the whole geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementOnLine) */ placePerPart?: boolean; /** * A value indicating whether to angle the marker to the line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementOnLine) */ angleToLine?: boolean; /** * The offset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementOnLine) */ offset?: number; /** * The location on a line where a marker will be placed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementOnLine) */ relativeTo: "LineMiddle" | "LineBeginning" | "LineEnd" | "SegmentMidpoint"; /** * The distances from a specified location on a line that a marker will be placed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementOnLine) */ startPointOffset?: number; } /** * Represents a marker placement on vertices which places a single marker on a line or polygon outline at a set distance from the middle or one of the endpoints. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementOnVertices) */ export interface CIMMarkerPlacementOnVertices { type: "CIMMarkerPlacementOnVertices"; /** * The primitive name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementOnVertices) */ primitiveName?: string; /** * A value indicating whether to consider individual geometry parts or the whole geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementOnVertices) */ placePerPart?: boolean; /** * A value indicating whether to angle the marker to the line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementOnVertices) */ angleToLine?: boolean; /** * The offset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementOnVertices) */ offset?: number; /** * A value indicating whether a marker will be placed on the control points of the line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementOnVertices) */ placeOnControlPoints?: boolean; /** * A value indicating whether a marker will be placed on the endpoints of the line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementOnVertices) */ placeOnEndPoints?: boolean; /** * A value indicating whether a marker will be placed on the vertices of the line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementOnVertices) */ placeOnRegularVertices?: boolean; } /** * Represents marker placement polygon center which defines how a single marker will be placed within the polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementPolygonCenter) */ export interface CIMMarkerPlacementPolygonCenter { type: "CIMMarkerPlacementPolygonCenter"; /** * The primitive name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementPolygonCenter) */ primitiveName?: string; /** * A value indicating whether to consider individual geometry parts or the whole geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementPolygonCenter) */ placePerPart?: boolean; /** * The method used to determine the polygon center. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementPolygonCenter) */ method?: "OnPolygon" | "CenterOfMass" | "BoundingBoxCenter"; /** * The value which offsets the marker horizontally from the center. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementPolygonCenter) */ offsetX?: number; /** * The value which offsets the marker vertically from the center. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementPolygonCenter) */ offsetY?: number; /** * A value indicating whether the marker should be clipped if it extends pasts the boundary of the polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMMarkerPlacementPolygonCenter) */ clipAtBoundary?: boolean; } /** * Represents a picture fill which fills polygonal geometry with a picture. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureFill) */ export interface CIMPictureFill { type: "CIMPictureFill"; /** * The geometric effects applied to the symbol layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureFill) */ effects?: CIMGeometricEffect[]; /** * A value indicating whether the symbol layer is visible. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureFill) */ enable: boolean; /** * A value indicating whether the color can be changed for this symbol layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureFill) */ colorLocked?: boolean; /** * The primitive name of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureFill) */ primitiveName?: string; /** * The url of the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureFill) */ url: string; /** * The distance that the image is offset in the horizontal direction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureFill) */ offsetX?: number; /** * The distance that the image is offset in the vertical direction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureFill) */ offsetY?: number; /** * The angle of the image within the fill. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureFill) */ rotation?: number; /** * The width of the symbol without changing the height, as a ratio. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureFill) */ scaleX?: number; /** * The height of the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureFill) */ height?: number; /** * The color substitutions which allows colors in the image to be substituted with a different color. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureFill) */ colorSubstitutions?: CIMColorSubstitution[]; /** * The color that is applied as a tint to the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureFill) */ tintColor?: number[]; } /** * Represents a picture marker created from a raster (bitmapped) image file. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureMarker) */ export interface CIMPictureMarker { type: "CIMPictureMarker"; /** * A value indicating whether the symbol layer is visible. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureMarker) */ enable: boolean; /** * The url of the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureMarker) */ url: string; /** * The height of the marker. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureMarker) */ size: number; /** * A value indicating whether the color can be changed for this symbol layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureMarker) */ colorLocked?: boolean; /** * The geometric effects applied to the symbol layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureMarker) */ effects?: CIMGeometricEffect[]; /** * The primitive name of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureMarker) */ primitiveName?: string; /** * The specified location where all transformation property operations originate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureMarker) */ anchorPoint?: CIMPictureMarkerAnchorPoint; /** * A value which specifies if the anchor point location is considered a percentage of the size or as an absolute distance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureMarker) */ anchorPointUnits?: "Relative" | "Absolute"; /** * The distance that the image is offset in the horizontal direction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureMarker) */ offsetX?: number; /** * The distance that the image is offset in the vertical direction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureMarker) */ offsetY?: number; /** * A value indicating whether the rotation is applied clockwise or counterclockwise to the marker layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureMarker) */ rotateClockwise?: boolean; /** * The angle of the image within the fill. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureMarker) */ rotation?: number; /** * Determines how markers are placed along a line or within a polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureMarker) */ markerPlacement?: MarkerPlacement; /** * The width of the symbol without changing the height, as a ratio. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureMarker) */ scaleX?: number; /** * The height of the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureMarker) */ height?: number; /** * The color substitutions which allows colors in the image to be substituted with a different color. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureMarker) */ colorSubstitutions?: CIMColorSubstitution[]; /** * The color that is applied as a tint to the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureMarker) */ tintColor?: number[]; /** * _Since 4.24_ The collection of symbol properties that apply when the symbol layer has animation data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureMarker) */ animatedSymbolProperties?: CIMAnimatedSymbolProperties; } /** * Represents a picture stroke which draws linear geometry with a repeating image file. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureStroke) */ export interface CIMPictureStroke { type: "CIMPictureStroke"; /** * The geometric effects applied to the symbol layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureStroke) */ effects?: CIMGeometricEffect[]; /** * A value indicating whether the symbol layer is visible. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureStroke) */ enable: boolean; /** * A value indicating whether the color can be changed for this symbol layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureStroke) */ colorLocked?: boolean; /** * The primitive name of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureStroke) */ primitiveName?: string; /** * The url of the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureStroke) */ url: string; /** * The color substitutions which allows colors in the image to be substituted with a different color. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureStroke) */ colorSubstitutions?: CIMColorSubstitution[]; /** * The color that is applied as a tint to the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureStroke) */ tintColor?: number[]; /** * The width of the stroke. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureStroke) */ width: number; /** * Determines how the stroke should draw at the ends of the geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureStroke) */ capStyle?: "Butt" | "Round" | "Square"; /** * Determines how the symbol is drawn at the stroke segment connections. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureStroke) */ joinStyle?: "Bevel" | "Round" | "Miter"; /** * The maximum 'sharpness' that is allowed for miter joins. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureStroke) */ miterLimit?: number; } /** * Represents a point symbol used to draw point features and graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPointSymbol) */ export interface CIMPointSymbol { type: "CIMPointSymbol"; /** * The symbol layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPointSymbol) */ symbolLayers: CIMSymbolLayer[]; /** * The amount of variation applied to the symbol, measured in degrees, propagated cumulatively to all marker symbols. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPointSymbol) */ angle?: number; /** * Indicates whether point symbols align to the map or to the display when a rotation is applied to the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPointSymbol) */ angleAlignment?: "Display" | "Map"; /** * The geometric effects applied to the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPointSymbol) */ effects?: CIMGeometricEffect[]; /** * The primitive name of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPointSymbol) */ primitiveName?: string; /** * The X scale which changes the width of the symbol without changing the height, as a ratio. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPointSymbol) */ scaleX?: number; /** * A value indicating whether the symbol size properties are rendered using real world units or page units. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPointSymbol) */ useRealWorldSymbolSizes?: boolean; } /** * Represents a polygon symbol used to draw polygon features and graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPolygonSymbol) */ export interface CIMPolygonSymbol { type: "CIMPolygonSymbol"; /** * The symbol layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPolygonSymbol) */ symbolLayers: CIMSymbolLayer[]; /** * The geometric effects applied to the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPolygonSymbol) */ effects?: CIMGeometricEffect[]; /** * A value indicating whether the symbol size properties are rendered using real world units or page units. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPolygonSymbol) */ useRealWorldSymbolSizes?: boolean; } /** * Represents a solid fill which fills polygonal geometry with a single solid color. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSolidFill) */ export interface CIMSolidFill { type: "CIMSolidFill"; /** * The geometric effects applied to the symbol layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSolidFill) */ effects?: CIMGeometricEffect[]; /** * A value indicating whether the symbol layer is visible. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSolidFill) */ enable: boolean; /** * A value indicating whether the color can be changed for this symbol layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSolidFill) */ colorLocked?: boolean; /** * The primitive name of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSolidFill) */ primitiveName?: string; /** * The color that is applied to the fill. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSolidFill) */ color: number[]; } /** * Represents a solid stroke which draws linear geometry with a single solid color. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSolidStroke) */ export interface CIMSolidStroke { type: "CIMSolidStroke"; /** * The geometric effects applied to the symbol layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSolidStroke) */ effects?: CIMGeometricEffect[]; /** * A value indicating whether the symbol layer is visible. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSolidStroke) */ enable: boolean; /** * A value indicating whether the color can be changed for this symbol layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSolidStroke) */ colorLocked?: boolean; /** * The primitive name of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSolidStroke) */ primitiveName?: string; /** * The color that is applied to the fill. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSolidStroke) */ color: number[]; /** * The width of the stroke. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSolidStroke) */ width: number; /** * Determines how the stroke should draw at the ends of the geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSolidStroke) */ capStyle?: "Butt" | "Round" | "Square"; /** * Determines how the symbol is drawn at the stroke segment connections. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSolidStroke) */ joinStyle?: "Bevel" | "Round" | "Miter"; /** * The maximum 'sharpness' that is allowed for miter joins. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSolidStroke) */ miterLimit?: number; } /** * Represents a symbol layer, the component that makes up a symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSymbolLayer) */ export type CIMSymbolLayer = | CIMHatchFill | CIMPictureFill | CIMPictureMarker | CIMPictureStroke | CIMSolidFill | CIMSolidStroke | CIMVectorMarker; /** * Represents a symbol reference from the [data](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#data) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSymbolReference) */ export interface CIMSymbolReference { type: "CIMSymbolReference"; /** * The primitive overrides. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSymbolReference) */ primitiveOverrides?: PrimitiveOverride[]; /** * The symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSymbolReference) */ symbol: CIMPointSymbol | CIMLineSymbol | CIMPolygonSymbol; /** * _Since 4.20_ The minimum scale the symbol reference should be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSymbolReference) */ minScale?: number; /** * _Since 4.20_ The maximum scale the symbol reference should be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMSymbolReference) */ maxScale?: number; } /** * Represents a text symbol which is used to draw text graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMTextSymbol) */ export interface CIMTextSymbol { type: "CIMTextSymbol"; /** * The amount of rotation applied to the text symbol, measured in degrees, around the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMTextSymbol) */ angle?: number; /** * The font family name of the font (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMTextSymbol) */ fontFamilyName: string; /** * The style name for the font family. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMTextSymbol) */ fontStyleName?: "Regular" | "Bold" | "Italic"; /** * The size of the halo that extends beyond the symbol shape. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMTextSymbol) */ haloSize?: number; /** * The polygon symbol that is used to draw the halo for a text symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMTextSymbol) */ haloSymbol?: CIMPolygonSymbol; /** * The size of the text in points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMTextSymbol) */ height: number; /** * The alignment type used to align the text to the geometry horizontally. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMTextSymbol) */ horizontalAlignment?: "Left" | "Right" | "Center"; /** * The X offset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMTextSymbol) */ offsetX?: number; /** * The Y offset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMTextSymbol) */ offsetY?: number; /** * A value indicating whether to draw the text with a strike through it. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMTextSymbol) */ strikethrough?: boolean; /** * The polygon symbol that is used to draw the glyphs of the text. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMTextSymbol) */ symbol: CIMPolygonSymbol; /** * A value indicating whether to draw the text with an underline. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMTextSymbol) */ underline?: boolean; /** * The vertical alignment of the text. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMTextSymbol) */ verticalAlignment?: "Top" | "Center" | "Baseline" | "Bottom"; /** * _Since 4.26_ The background of the text. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMTextSymbol) */ callout?: CIMBackgroundCallout; } /** * Represents a vector marker which can represent vector graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMVectorMarker) */ export interface CIMVectorMarker { type: "CIMVectorMarker"; /** * The geometric effects applied to the symbol layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMVectorMarker) */ effects?: CIMGeometricEffect[]; /** * A value indicating whether the symbol layer is visible. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMVectorMarker) */ enable: boolean; /** * A value indicating whether the color can be changed for this symbol layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMVectorMarker) */ colorLocked?: boolean; /** * The primitive name of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMVectorMarker) */ primitiveName?: string; /** * The height of the marker. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMVectorMarker) */ size: number; /** * The specified location where all transformation property operations originate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMVectorMarker) */ anchorPoint?: CIMVectorMarkerAnchorPoint; /** * A value which specifies if the anchor point location is considered a percentage of the size or as an absolute distance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMVectorMarker) */ anchorPointUnits?: "Relative" | "Absolute"; /** * The distance that the image is offset in the horizontal direction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMVectorMarker) */ offsetX?: number; /** * The distance that the image is offset in the vertical direction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMVectorMarker) */ offsetY?: number; /** * A value indicating whether the rotation is applied clockwise or counterclockwise to the marker layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMVectorMarker) */ rotateClockwise?: boolean; /** * The angle of the image within the fill. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMVectorMarker) */ rotation?: number; /** * Determines how markers are placed along a line or within a polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMVectorMarker) */ markerPlacement?: MarkerPlacement; /** * The outer boundary of the entire vector marker. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMVectorMarker) */ frame: Envelope; /** * The vector graphics that define the shape of the marker. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMVectorMarker) */ markerGraphics: CIMMarkerGraphic[]; /** * A value indicating whether the strokes and or fills of a marker are scaled proportionally when the symbol size is changed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMVectorMarker) */ scaleSymbolsProportionally?: boolean; /** * A value indicating whether the frame of the vector marker should be honored when drawing the marker. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMVectorMarker) */ respectFrame?: boolean; } /** * An envelope is a rectangle defined by a range of values for each coordinate and attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#Envelope) */ export interface Envelope { /** * The minimum X value in the area of the envelope. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#Envelope) */ xmin: number; /** * The maximum X value in the area of the envelope. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#Envelope) */ xmax: number; /** * The minimum Y value in the area of the envelope. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#Envelope) */ ymin: number; /** * The maximum Y value in the area of the envelope. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#Envelope) */ ymax: number; } /** * Represents a marker placement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#MarkerPlacement) */ export type MarkerPlacement = | CIMMarkerPlacementAlongLineSameSize | CIMMarkerPlacementAtExtremities | CIMMarkerPlacementAtRatioPositions | CIMMarkerPlacementInsidePolygon | CIMMarkerPlacementOnLine | CIMMarkerPlacementOnVertices | CIMMarkerPlacementPolygonCenter; /** * Represents a primitive override. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#PrimitiveOverride) */ export interface PrimitiveOverride { type: "CIMPrimitiveOverride"; /** * The primitive name this override applies to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#PrimitiveOverride) */ primitiveName: string; /** * The name of the property in the primitive this override applies to (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#PrimitiveOverride) */ propertyName: string; /** * Contains the Arcade expression that returns a value to be applied to the property on the primitive. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#PrimitiveOverride) */ valueExpressionInfo: PrimitiveOverrideValueExpressionInfo; } export interface CIMPictureMarkerAnchorPoint { /** * The x coordinate of the anchor point, measured along the east/west axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureMarker) */ x?: any; /** * The y coordinate of the anchor point, measured along the north/south axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMPictureMarker) */ y?: any; } export interface CIMVectorMarkerAnchorPoint { /** * The x coordinate of the anchor point, measured along the east/west axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMVectorMarker) */ x?: any; /** * The y coordinate of the anchor point, measured along the north/south axis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#CIMVectorMarker) */ y?: any; } export interface PrimitiveOverrideValueExpressionInfo { type: "CIMExpressionInfo"; /** * The human readable text that describes the expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#PrimitiveOverride) */ title?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#PrimitiveOverride) */ expression: string; /** * The name of the expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#PrimitiveOverride) */ name?: string; /** * The return type of the expression. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#PrimitiveOverride) */ returnType?: "Default" | "String" | "Numeric"; } export interface Edges3D extends Accessor, JSONSupport { } export class Edges3D { /** * The color of the edges. * * @default black * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-Edges3D.html#color) */ color: Color; /** * A size in points by which to extend edges beyond their original end points. * * @default "0" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-Edges3D.html#extensionLength) */ extensionLength: number; /** * The size of the edges in points. * * @default 1px * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-Edges3D.html#size) */ size: number; /** * Edges3D is the base class for symbol classes that add edge rendering visualization to existing symbols. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-Edges3D.html) */ constructor(properties?: Edges3DProperties); /** * Creates a deep clone of the edges. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-Edges3D.html#clone) */ clone(): Edges3D; static fromJSON(json: any): Edges3D; } interface Edges3DProperties { /** * The color of the edges. * * @default black * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-Edges3D.html#color) */ color?: Color | number[] | string; /** * A size in points by which to extend edges beyond their original end points. * * @default "0" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-Edges3D.html#extensionLength) */ extensionLength?: number | string; /** * The size of the edges in points. * * @default 1px * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-Edges3D.html#size) */ size?: number | string; } export class SketchEdges3D extends Edges3D { /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-SketchEdges3D.html#type) */ type: "sketch"; /** * SketchEdges3D is a symbol type that visualizes edges of [3D Object SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html), extruded polygons or mesh geometries with a sketched line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-SketchEdges3D.html) */ constructor(properties?: SketchEdges3DProperties); /** * Creates a deep clone of the object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-SketchEdges3D.html#clone) */ clone(): SketchEdges3D; static fromJSON(json: any): SketchEdges3D; } interface SketchEdges3DProperties extends Edges3DProperties { /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-SketchEdges3D.html#type) */ type?: "sketch"; } export class SolidEdges3D extends Edges3D { /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-SolidEdges3D.html#type) */ type: "solid"; /** * SolidEdges3D is a symbol type that visualizes edges of [3D Object SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html), extruded polygons or mesh geometries with a solid line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-SolidEdges3D.html) */ constructor(properties?: SolidEdges3DProperties); /** * Creates a deep clone of the object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-SolidEdges3D.html#clone) */ clone(): SolidEdges3D; static fromJSON(json: any): SolidEdges3D; } interface SolidEdges3DProperties extends Edges3DProperties { /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-SolidEdges3D.html#type) */ type?: "solid"; } export class ExtrudeSymbol3DLayer extends Symbol3DLayer { /** * Indicates whether the symbol layer geometry casts shadows in the scene. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html#castShadows) */ castShadows: boolean; /** * Sets the contour edges on polygons symbolized with ExtrudeSymbol3DLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html#edges) */ edges: Edges3D; /** * The material used to shade the extrusion. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html#material) */ material: ExtrudeSymbol3DLayerMaterial; /** * The height of the extrusion in meters. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html#size) */ size: number; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html#type) */ readonly type: "extrude"; /** * ExtrudeSymbol3DLayer is used to render [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) geometries by extruding them upward from the ground, creating a 3D volumetric object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html) */ constructor(properties?: ExtrudeSymbol3DLayerProperties); /** * Creates a deep clone of the symbol layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html#clone) */ clone(): ExtrudeSymbol3DLayer; static fromJSON(json: any): ExtrudeSymbol3DLayer; } interface ExtrudeSymbol3DLayerProperties extends Symbol3DLayerProperties { /** * Indicates whether the symbol layer geometry casts shadows in the scene. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html#castShadows) */ castShadows?: boolean; /** * Sets the contour edges on polygons symbolized with ExtrudeSymbol3DLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html#edges) */ edges?: Edges3DProperties; /** * The material used to shade the extrusion. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html#material) */ material?: ExtrudeSymbol3DLayerMaterialProperties; /** * The height of the extrusion in meters. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html#size) */ size?: number; } export interface ExtrudeSymbol3DLayerMaterialProperties { /** * The fill color of the extrusion. * * @default white * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html#material) */ color?: Color | number[] | string; } export interface ExtrudeSymbol3DLayerMaterial extends AnonymousAccessor { /** * The fill color of the extrusion. * * @default white * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html#material) */ color?: Color; } export class FillSymbol extends Symbol { /** * The outline of the polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol.html#outline) */ outline: SimpleLineSymbol; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol.html#type) */ type: "simple-fill" | "picture-fill"; /** * Fill symbols are used to draw [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) graphics in a [GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) or a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) in a 2D [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol.html) */ constructor(properties?: FillSymbolProperties); static fromJSON(json: any): FillSymbol; } interface FillSymbolProperties extends SymbolProperties { /** * The outline of the polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol.html#outline) */ outline?: SimpleLineSymbolProperties; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol.html#type) */ type?: "simple-fill" | "picture-fill"; } export class FillSymbol3DLayer extends Symbol3DLayer { /** * Indicates whether the symbol layer geometry casts shadows in the scene. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#castShadows) */ castShadows: boolean; /** * Sets the contour edges on 3D Objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#edges) */ edges: Edges3D; /** * The material defines the final color of the graphic, by blending the `color` property set in the material with the feature's geometry color/texture information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) */ material: FillSymbol3DLayerMaterial; /** * The outline used to draw a line around the filled geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#outline) */ outline: FillSymbol3DLayerOutline; /** * The pattern used to render the polygon fill. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#pattern) */ pattern: StylePattern3D; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#type) */ readonly type: "fill"; /** * FillSymbol3DLayer is used to render the surfaces of flat 2D [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) geometries and 3D volumetric meshes in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html) */ constructor(properties?: FillSymbol3DLayerProperties); /** * Creates a deep clone of the symbol layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#clone) */ clone(): FillSymbol3DLayer; static fromJSON(json: any): FillSymbol3DLayer; } interface FillSymbol3DLayerProperties extends Symbol3DLayerProperties { /** * Indicates whether the symbol layer geometry casts shadows in the scene. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#castShadows) */ castShadows?: boolean; /** * Sets the contour edges on 3D Objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#edges) */ edges?: Edges3DProperties; /** * The material defines the final color of the graphic, by blending the `color` property set in the material with the feature's geometry color/texture information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) */ material?: FillSymbol3DLayerMaterialProperties; /** * The outline used to draw a line around the filled geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#outline) */ outline?: FillSymbol3DLayerOutlineProperties; /** * The pattern used to render the polygon fill. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#pattern) */ pattern?: StylePattern3DProperties; } export interface FillSymbol3DLayerMaterialProperties { /** * The color of the fill. * * @default white * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) */ color?: Color | number[] | string; /** * Specifies how the material `color` is applied to the geometry color/texture information. * * @default multiply * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) */ colorMixMode?: "tint" | "replace" | "multiply"; } export interface FillSymbol3DLayerMaterial extends AnonymousAccessor { /** * The color of the fill. * * @default white * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) */ color?: Color; /** * Specifies how the material `color` is applied to the geometry color/texture information. * * @default multiply * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) */ colorMixMode?: "tint" | "replace" | "multiply"; } export interface FillSymbol3DLayerOutlineProperties { /** * The color of the outline. * * @default black * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#outline) */ color?: Color | number[] | string; /** * The width of the outline in points. * * @default 1px * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#outline) */ size?: number | string; /** * The stroke pattern used to render the outline. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#outline) */ pattern?: LineStylePattern3DProperties; /** * The style applied to the tips of each pattern segment along the line. * * @default butt * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#outline) */ patternCap?: "butt" | "round" | "square"; } export interface FillSymbol3DLayerOutline extends AnonymousAccessor { /** * The color of the outline. * * @default black * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#outline) */ color?: Color; /** * The width of the outline in points. * * @default 1px * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#outline) */ size?: number; /** * The stroke pattern used to render the outline. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#outline) */ pattern?: LineStylePattern3D; /** * The style applied to the tips of each pattern segment along the line. * * @default butt * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#outline) */ patternCap?: "butt" | "round" | "square"; } export interface Font extends Accessor, JSONSupport { } export class Font { /** * The text decoration. * * @default none * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#decoration) */ decoration: "underline" | "line-through" | "none"; /** * The font family of the text. * * @default sans-serif * * The font family of the text. The possible values are dependent upon the layer type, and if you are working with a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). See the [Labeling guide page](https://developers.arcgis.com/javascript/latest/labeling/) for detailed explanation, or click the `Read more` below. >>> esri-read-more **Font families for 3D SceneViews** The supported font families for 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) are dependent upon the fonts installed on the user's computer and web browser. If an app uses a font that is not installed, the Font class implements a fallback mechanism that will use the default font family value, which is `sans-serif`. See these references for instructions on how to install a new font on [Windows](https://support.microsoft.com/en-us/help/314960/how-to-install-or-remove-a-font-in-windows) or [Mac](https://support.apple.com/en-us/ht201749). Fonts that are not installed locally can also be loaded from a url by defining a [@font-face](https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face) in a css file and referencing it from the `family` property in a symbol layer. **Font families for 2D MapImageLayer** The supported font families for [MapImageLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html) in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) are dependent upon the fonts installed on the [ArcGIS Server](https://enterprise.arcgis.com/en/server/latest/get-started/windows/what-is-arcgis-for-server-.htm) that published the layer. If an app uses a font that is not installed, the Font class implements a fallback mechanism that will use the default font family value, which is `sans-serif`. **Font families for 2D FeatureLayer**, CSVLayer, StreamLayer, and TextSymbol The supported font families are based on hosted fonts files in `.pbf` format. By default, the fonts available are mostly the same ones used by the Esri Vector Basemaps. These fonts are available via `https://static.arcgis.com/fonts`. The URL can be configured to point to your own font resources by setting the [esriConfig.fontsUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#fontsUrl) property. If an app uses a font that is not installed, the Font class implements a fallback mechanism that will use the default font family value, which is `sans-serif`. This uses the `Arial Unicode MS` font file. > A preview of the fonts listed in the following table are available in the [Labeling](https://developers.arcgis.com/javascript/latest/labeling/) overview page. List of fonts currently supported in a 2D MapView: [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#family) */ family: string; /** * The font size in points. * * @default 9 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#size) */ size: number; /** * The text style. * * @default normal * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#style) */ style: "normal" | "italic" | "oblique"; /** * The text weight. * * @default normal * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#weight) */ weight: "normal" | "bold" | "bolder" | "lighter"; /** * The font used to display [2D text symbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html) and [3D text symbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html) */ constructor(properties?: FontProperties); /** * Creates a deep clone of the font object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#clone) */ clone(): Font; static fromJSON(json: any): Font; } interface FontProperties { /** * The text decoration. * * @default none * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#decoration) */ decoration?: "underline" | "line-through" | "none"; /** * The font family of the text. * * @default sans-serif * * The font family of the text. The possible values are dependent upon the layer type, and if you are working with a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). See the [Labeling guide page](https://developers.arcgis.com/javascript/latest/labeling/) for detailed explanation, or click the `Read more` below. >>> esri-read-more **Font families for 3D SceneViews** The supported font families for 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) are dependent upon the fonts installed on the user's computer and web browser. If an app uses a font that is not installed, the Font class implements a fallback mechanism that will use the default font family value, which is `sans-serif`. See these references for instructions on how to install a new font on [Windows](https://support.microsoft.com/en-us/help/314960/how-to-install-or-remove-a-font-in-windows) or [Mac](https://support.apple.com/en-us/ht201749). Fonts that are not installed locally can also be loaded from a url by defining a [@font-face](https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face) in a css file and referencing it from the `family` property in a symbol layer. **Font families for 2D MapImageLayer** The supported font families for [MapImageLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html) in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) are dependent upon the fonts installed on the [ArcGIS Server](https://enterprise.arcgis.com/en/server/latest/get-started/windows/what-is-arcgis-for-server-.htm) that published the layer. If an app uses a font that is not installed, the Font class implements a fallback mechanism that will use the default font family value, which is `sans-serif`. **Font families for 2D FeatureLayer**, CSVLayer, StreamLayer, and TextSymbol The supported font families are based on hosted fonts files in `.pbf` format. By default, the fonts available are mostly the same ones used by the Esri Vector Basemaps. These fonts are available via `https://static.arcgis.com/fonts`. The URL can be configured to point to your own font resources by setting the [esriConfig.fontsUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#fontsUrl) property. If an app uses a font that is not installed, the Font class implements a fallback mechanism that will use the default font family value, which is `sans-serif`. This uses the `Arial Unicode MS` font file. > A preview of the fonts listed in the following table are available in the [Labeling](https://developers.arcgis.com/javascript/latest/labeling/) overview page. List of fonts currently supported in a 2D MapView: [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#family) */ family?: string; /** * The font size in points. * * @default 9 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#size) */ size?: number | string; /** * The text style. * * @default normal * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#style) */ style?: "normal" | "italic" | "oblique"; /** * The text weight. * * @default normal * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#weight) */ weight?: "normal" | "bold" | "bolder" | "lighter"; } export class IconSymbol3DLayer extends Symbol3DLayer { /** * The positioning of the icon relative to the geometry. * * @default center * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#anchor) */ anchor: | "center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "relative"; /** * Defines the [anchor](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#anchor) relative to the center of the icon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#anchorPosition) */ anchorPosition: IconSymbol3DLayerAnchorPosition; /** * The material used to shade the icon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#material) */ material: IconSymbol3DLayerMaterial; /** * The outline of the icon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#outline) */ outline: IconSymbol3DLayerOutline; /** * The shape (`primitive`) or image URL (`href`) used to visualize the features. * * @default { primitive: "circle" } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#resource) */ resource: IconSymbol3DLayerResource; /** * The size of the icon in points. * * @default 12 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#size) */ size: number; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#type) */ readonly type: "icon"; /** * IconSymbol3DLayer is used to render [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometries using a flat 2D icon (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html) */ constructor(properties?: IconSymbol3DLayerProperties); /** * Creates a deep clone of the symbol layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#clone) */ clone(): IconSymbol3DLayer; static fromJSON(json: any): IconSymbol3DLayer; } interface IconSymbol3DLayerProperties extends Symbol3DLayerProperties { /** * The positioning of the icon relative to the geometry. * * @default center * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#anchor) */ anchor?: | "center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "relative"; /** * Defines the [anchor](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#anchor) relative to the center of the icon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#anchorPosition) */ anchorPosition?: IconSymbol3DLayerAnchorPosition; /** * The material used to shade the icon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#material) */ material?: IconSymbol3DLayerMaterialProperties; /** * The outline of the icon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#outline) */ outline?: IconSymbol3DLayerOutlineProperties; /** * The shape (`primitive`) or image URL (`href`) used to visualize the features. * * @default { primitive: "circle" } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#resource) */ resource?: IconSymbol3DLayerResource; /** * The size of the icon in points. * * @default 12 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#size) */ size?: number | string; } export interface IconSymbol3DLayerAnchorPosition { /** * Value defining the position relative to the icon's width. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#anchorPosition) */ x: number; /** * Value defining the position relative to the icon's height. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#anchorPosition) */ y: number; } export interface IconSymbol3DLayerMaterialProperties { /** * The fill color of the icon. * * @default white * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#material) */ color?: Color | number[] | string; } export interface IconSymbol3DLayerMaterial extends AnonymousAccessor { /** * The fill color of the icon. * * @default white * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#material) */ color?: Color; } export interface IconSymbol3DLayerOutlineProperties { /** * The color of the outline. * * @default black * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#outline) */ color?: Color | number[] | string; /** * The width of the outline in points. * * @default 1.125 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#outline) */ size?: number | string; } export interface IconSymbol3DLayerOutline extends AnonymousAccessor { /** * The color of the outline. * * @default black * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#outline) */ color?: Color; /** * The width of the outline in points. * * @default 1.125 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#outline) */ size?: number; } export interface IconSymbol3DLayerResource { /** * Uses a built-in shape. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#resource) */ primitive?: string; /** * The URL or data URI for the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#resource) */ href?: string; } export class LabelSymbol3D extends Symbol3D { /** * Settings for adding a callout visualization to the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#callout) */ callout: Callout3D; /** * A Collection of [Symbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html) objects used to visualize the graphic or feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#symbolLayers) */ symbolLayers: Collection; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#type) */ readonly type: "label-3d"; /** * Shifts the symbol along the vertical world axis by a given height. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#verticalOffset) */ verticalOffset: Symbol3DVerticalOffset; /** * LabelSymbol3D is used to render labels for features from a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html) */ constructor(properties?: LabelSymbol3DProperties); /** * Creates a deep clone of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#clone) */ clone(): LabelSymbol3D; static fromJSON(json: any): LabelSymbol3D; } interface LabelSymbol3DProperties extends Symbol3DProperties { /** * Settings for adding a callout visualization to the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#callout) */ callout?: Callout3DProperties; /** * A Collection of [Symbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html) objects used to visualize the graphic or feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#symbolLayers) */ symbolLayers?: CollectionProperties; /** * Shifts the symbol along the vertical world axis by a given height. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#verticalOffset) */ verticalOffset?: Symbol3DVerticalOffsetProperties; } export interface LineStyleMarker3D extends Accessor, Clonable { } export class LineStyleMarker3D { /** * The color of the marker. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineStyleMarker3D.html#color) */ color: Color; /** * Indicates where the marker is placed. * * @default "begin-end" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineStyleMarker3D.html#placement) */ placement: "begin" | "end" | "begin-end"; /** * Style of the marker. * * @default "arrow" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineStyleMarker3D.html#style) */ style: "arrow" | "circle" | "square" | "diamond" | "cross" | "x"; /** * The type of marker applied to a line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineStyleMarker3D.html#type) */ readonly type: "style"; /** * LineStyleMarker3D is used for rendering a simple marker graphic on a [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineStyleMarker3D.html) */ constructor(properties?: LineStyleMarker3DProperties); } interface LineStyleMarker3DProperties { /** * The color of the marker. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineStyleMarker3D.html#color) */ color?: Color | number[] | string; /** * Indicates where the marker is placed. * * @default "begin-end" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineStyleMarker3D.html#placement) */ placement?: "begin" | "end" | "begin-end"; /** * Style of the marker. * * @default "arrow" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineStyleMarker3D.html#style) */ style?: "arrow" | "circle" | "square" | "diamond" | "cross" | "x"; /** * The type of marker applied to a line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineStyleMarker3D.html#type) */ type?: "style"; } export class LineSymbol extends Symbol { /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol.html#type) */ type: "simple-line"; /** * The width of the symbol in points. * * @default 0.75 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol.html#width) */ width: number; /** * Line symbols are used to draw [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) features in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) in a 2D [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol.html) */ constructor(properties?: LineSymbolProperties); static fromJSON(json: any): LineSymbol; } interface LineSymbolProperties extends SymbolProperties { /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol.html#type) */ type?: "simple-line"; /** * The width of the symbol in points. * * @default 0.75 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol.html#width) */ width?: number | string; } export class LineSymbol3D extends Symbol3D { /** * A Collection of [Symbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html) objects used to visualize the graphic or feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3D.html#symbolLayers) */ symbolLayers: Collection; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3D.html#type) */ readonly type: "line-3d"; /** * LineSymbol3D is used to render features with [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) geometry in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3D.html) */ constructor(properties?: LineSymbol3DProperties); /** * Creates a deep clone of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3D.html#clone) */ clone(): LineSymbol3D; static fromJSON(json: any): LineSymbol3D; } interface LineSymbol3DProperties extends Symbol3DProperties { /** * A Collection of [Symbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html) objects used to visualize the graphic or feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3D.html#symbolLayers) */ symbolLayers?: CollectionProperties< (LineSymbol3DLayerProperties & { type: "line" }) | (PathSymbol3DLayerProperties & { type: "path" }) >; } export class LineSymbol3DLayer extends Symbol3DLayer { /** * The style used to draw the endpoint of a line. * * @default butt * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html#cap) */ cap: "butt" | "round" | "square"; /** * The style used to draw the intersection of two line segments within a line geometry. * * @default miter * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html#join) */ join: "miter" | "round" | "bevel"; /** * Optional markers to be placed at the start and/or end of each line geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html#marker) */ marker: LineStyleMarker3D; /** * The material used to shade the line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html#material) */ material: LineSymbol3DLayerMaterial; /** * The pattern used to render the line stroke. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html#pattern) */ pattern: LineStylePattern3D; /** * The width of the line in points. * * @default "1px" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html#size) */ size: number; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html#type) */ readonly type: "line"; /** * LineSymbol3DLayer renders [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) geometries using a flat 2D line with a [LineSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3D.html) in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html) */ constructor(properties?: LineSymbol3DLayerProperties); /** * Creates a deep clone of the symbol layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html#clone) */ clone(): LineSymbol3DLayer; static fromJSON(json: any): LineSymbol3DLayer; } interface LineSymbol3DLayerProperties extends Symbol3DLayerProperties { /** * The style used to draw the endpoint of a line. * * @default butt * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html#cap) */ cap?: "butt" | "round" | "square"; /** * The style used to draw the intersection of two line segments within a line geometry. * * @default miter * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html#join) */ join?: "miter" | "round" | "bevel"; /** * Optional markers to be placed at the start and/or end of each line geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html#marker) */ marker?: LineStyleMarker3DProperties; /** * The material used to shade the line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html#material) */ material?: LineSymbol3DLayerMaterialProperties; /** * The pattern used to render the line stroke. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html#pattern) */ pattern?: LineStylePattern3DProperties; /** * The width of the line in points. * * @default "1px" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html#size) */ size?: number | string; } export interface LineSymbol3DLayerMaterialProperties { /** * The color of the line. * * @default white * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html#material) */ color?: Color | number[] | string; } export interface LineSymbol3DLayerMaterial extends AnonymousAccessor { /** * The color of the line. * * @default white * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html#material) */ color?: Color; } export class LineSymbolMarker extends Accessor { /** * The color of the marker. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbolMarker.html#color) */ color: Color; /** * The placement of the marker(s) on the line. * * @default "begin-end" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbolMarker.html#placement) */ placement: "begin" | "end" | "begin-end"; /** * The marker style. * * @default "arrow" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbolMarker.html#style) */ style: "arrow" | "circle" | "square" | "diamond" | "cross" | "x"; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbolMarker.html#type) */ readonly type: "line-marker"; /** * LineSymbolMarker is used for rendering a simple marker graphic on a [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbolMarker.html) */ constructor(properties?: LineSymbolMarkerProperties); } interface LineSymbolMarkerProperties { /** * The color of the marker. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbolMarker.html#color) */ color?: Color | number[] | string; /** * The placement of the marker(s) on the line. * * @default "begin-end" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbolMarker.html#placement) */ placement?: "begin" | "end" | "begin-end"; /** * The marker style. * * @default "arrow" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbolMarker.html#style) */ style?: "arrow" | "circle" | "square" | "diamond" | "cross" | "x"; } export class MarkerSymbol extends Symbol { /** * The angle of the marker relative to the screen in degrees. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MarkerSymbol.html#angle) */ angle: number; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MarkerSymbol.html#type) */ type: "simple-marker" | "picture-marker"; /** * The offset on the x-axis in points. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MarkerSymbol.html#xoffset) */ xoffset: number; /** * The offset on the y-axis in points. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MarkerSymbol.html#yoffset) */ yoffset: number; /** * Marker symbols are used to draw [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) graphics in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or individual [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) in a 2D [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MarkerSymbol.html) */ constructor(properties?: MarkerSymbolProperties); static fromJSON(json: any): MarkerSymbol; } interface MarkerSymbolProperties extends SymbolProperties { /** * The angle of the marker relative to the screen in degrees. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MarkerSymbol.html#angle) */ angle?: number; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MarkerSymbol.html#type) */ type?: "simple-marker" | "picture-marker"; /** * The offset on the x-axis in points. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MarkerSymbol.html#xoffset) */ xoffset?: number | string; /** * The offset on the y-axis in points. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MarkerSymbol.html#yoffset) */ yoffset?: number | string; } export class MeshSymbol3D extends Symbol3D { /** * A Collection of [Symbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html) objects used to visualize the graphic or feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MeshSymbol3D.html#symbolLayers) */ symbolLayers: Collection; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MeshSymbol3D.html#type) */ readonly type: "mesh-3d"; /** * MeshSymbol3D is used to render 3D mesh features in a [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MeshSymbol3D.html) */ constructor(properties?: MeshSymbol3DProperties); /** * Creates a deep clone of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MeshSymbol3D.html#clone) */ clone(): MeshSymbol3D; static fromJSON(json: any): MeshSymbol3D; } interface MeshSymbol3DProperties extends Symbol3DProperties { /** * A Collection of [Symbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html) objects used to visualize the graphic or feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MeshSymbol3D.html#symbolLayers) */ symbolLayers?: CollectionProperties; } export class ObjectSymbol3DLayer extends Symbol3DLayer { /** * The positioning of the symbol relative to the geometry. * * @default origin * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#anchor) */ anchor: "center" | "top" | "bottom" | "origin" | "relative"; /** * Defines the [anchor](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#anchor) relative to the center of the [symbol layer resource](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#resource). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#anchorPosition) */ anchorPosition: ObjectSymbol3DLayerAnchorPosition; /** * Indicates whether the symbol layer geometry casts shadows in the scene. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#castShadows) */ castShadows: boolean; /** * The depth, or diameter from north to south, of the object in meters. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#depth) */ depth: number; /** * The clockwise rotation of the symbol in the horizontal plane (i.e., around the z axis). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#heading) */ heading: number; /** * The height of the object in meters. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#height) */ height: number; /** * The material used to shade the object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#material) */ material: ObjectSymbol3DLayerMaterial; /** * The primitive shape (`primitive`) or external 3D model (`href`) used to visualize the points. * * @default { primitive: "sphere" } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#resource) */ resource: ObjectSymbol3DLayerResource; /** * The rotation of the symbol in the lateral vertical plane (i.e., around the y axis). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#roll) */ roll: number; /** * The rotation of the symbol in the longitudinal vertical plane (i.e., around the x axis). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#tilt) */ tilt: number; /** * The object type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#type) */ readonly type: "object"; /** * The width, or diameter from east to west, of the object in meters. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#width) */ width: number; /** * ObjectSymbol3DLayer is used to render [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometries using a volumetric 3D shape (e.g., a sphere or cylinder) with a [PointSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html) in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html) */ constructor(properties?: ObjectSymbol3DLayerProperties); /** * Creates a deep clone of the symbol layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#clone) */ clone(): ObjectSymbol3DLayer; static fromJSON(json: any): ObjectSymbol3DLayer; } interface ObjectSymbol3DLayerProperties extends Symbol3DLayerProperties { /** * The positioning of the symbol relative to the geometry. * * @default origin * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#anchor) */ anchor?: "center" | "top" | "bottom" | "origin" | "relative"; /** * Defines the [anchor](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#anchor) relative to the center of the [symbol layer resource](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#resource). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#anchorPosition) */ anchorPosition?: ObjectSymbol3DLayerAnchorPosition; /** * Indicates whether the symbol layer geometry casts shadows in the scene. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#castShadows) */ castShadows?: boolean; /** * The depth, or diameter from north to south, of the object in meters. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#depth) */ depth?: number; /** * The clockwise rotation of the symbol in the horizontal plane (i.e., around the z axis). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#heading) */ heading?: number; /** * The height of the object in meters. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#height) */ height?: number; /** * The material used to shade the object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#material) */ material?: ObjectSymbol3DLayerMaterialProperties; /** * The primitive shape (`primitive`) or external 3D model (`href`) used to visualize the points. * * @default { primitive: "sphere" } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#resource) */ resource?: ObjectSymbol3DLayerResource; /** * The rotation of the symbol in the lateral vertical plane (i.e., around the y axis). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#roll) */ roll?: number; /** * The rotation of the symbol in the longitudinal vertical plane (i.e., around the x axis). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#tilt) */ tilt?: number; /** * The width, or diameter from east to west, of the object in meters. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#width) */ width?: number; } export interface ObjectSymbol3DLayerAnchorPosition { /** * Value defining the position relative to the x axis of the bounding box. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#anchorPosition) */ x: number; /** * Value defining the position relative to the y axis of the bounding box. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#anchorPosition) */ y: number; /** * Value defining the position relative to the z axis of the bounding box. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#anchorPosition) */ z: number; } export interface ObjectSymbol3DLayerMaterialProperties { /** * The fill color of the object. * * @default white * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#material) */ color?: Color | number[] | string; } export interface ObjectSymbol3DLayerMaterial extends AnonymousAccessor { /** * The fill color of the object. * * @default white * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#material) */ color?: Color; } export interface ObjectSymbol3DLayerResource { /** * Uses a built-in shape. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#resource) */ primitive?: string; /** * The URL to the 3D model in [glTF format](https://www.khronos.org/gltf/). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#resource) */ href?: string; } export class PathSymbol3DLayer extends Symbol3DLayer { /** * Defines offset of the path cross section relative to the [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) geometry. * * @default "center" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#anchor) */ anchor: "center" | "bottom" | "top"; /** * Controls the shape at the start and end point of the path. * * @default "butt" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#cap) */ cap: "none" | "butt" | "square" | "round"; /** * Indicates whether the symbol layer geometry casts shadows in the scene. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#castShadows) */ castShadows: boolean; /** * The vertical dimension of the cross-section of the path in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#height) */ height: number; /** * Controls the shape of the connection between two segments of the path. * * @default "miter" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#join) */ join: "miter" | "bevel" | "round"; /** * The material used to shade the path. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#material) */ material: PathSymbol3DLayerMaterial; /** * Cross-section profile of the path geometry. * * @default "circle" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#profile) */ profile: "circle" | "quad"; /** * Defines how the [profile](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#profile) is rotated as it is extruded along the [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) geometry. * * @default "all" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#profileRotation) */ profileRotation: "heading" | "all"; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#type) */ readonly type: "path"; /** * The horizontal dimension of the cross-section of the path in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#width) */ width: number; /** * PathSymbol3DLayer renders [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) geometries by extruding a 2D profile along the line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html) */ constructor(properties?: PathSymbol3DLayerProperties); /** * Creates a deep clone of the symbol layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#clone) */ clone(): PathSymbol3DLayer; static fromJSON(json: any): PathSymbol3DLayer; } interface PathSymbol3DLayerProperties extends Symbol3DLayerProperties { /** * Defines offset of the path cross section relative to the [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) geometry. * * @default "center" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#anchor) */ anchor?: "center" | "bottom" | "top"; /** * Controls the shape at the start and end point of the path. * * @default "butt" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#cap) */ cap?: "none" | "butt" | "square" | "round"; /** * Indicates whether the symbol layer geometry casts shadows in the scene. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#castShadows) */ castShadows?: boolean; /** * The vertical dimension of the cross-section of the path in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#height) */ height?: number; /** * Controls the shape of the connection between two segments of the path. * * @default "miter" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#join) */ join?: "miter" | "bevel" | "round"; /** * The material used to shade the path. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#material) */ material?: PathSymbol3DLayerMaterialProperties; /** * Cross-section profile of the path geometry. * * @default "circle" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#profile) */ profile?: "circle" | "quad"; /** * Defines how the [profile](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#profile) is rotated as it is extruded along the [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) geometry. * * @default "all" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#profileRotation) */ profileRotation?: "heading" | "all"; /** * The horizontal dimension of the cross-section of the path in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#width) */ width?: number; } export interface PathSymbol3DLayerMaterialProperties { /** * The color of the path. * * @default white * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#material) */ color?: Color | number[] | string; } export interface PathSymbol3DLayerMaterial extends AnonymousAccessor { /** * The color of the path. * * @default white * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#material) */ color?: Color; } export interface LineStylePattern3D extends Accessor, JSONSupport { } export class LineStylePattern3D { /** * The pattern style. * * @default solid * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-patterns-LineStylePattern3D.html#style) */ style: | "dash" | "dash-dot" | "dot" | "long-dash" | "long-dash-dot" | "long-dash-dot-dot" | "none" | "short-dash" | "short-dash-dot" | "short-dash-dot-dot" | "short-dot" | "solid"; /** * The pattern type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-patterns-LineStylePattern3D.html#type) */ readonly type: "style"; /** * Renders lines with predefined style patterns. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-patterns-LineStylePattern3D.html) */ constructor(properties?: LineStylePattern3DProperties); /** * Creates a deep clone of the pattern. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-patterns-LineStylePattern3D.html#clone) */ clone(): LineStylePattern3D; static fromJSON(json: any): LineStylePattern3D; } interface LineStylePattern3DProperties { /** * The pattern style. * * @default solid * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-patterns-LineStylePattern3D.html#style) */ style?: | "dash" | "dash-dot" | "dot" | "long-dash" | "long-dash-dot" | "long-dash-dot-dot" | "none" | "short-dash" | "short-dash-dot" | "short-dash-dot-dot" | "short-dot" | "solid"; } export interface StylePattern3D extends Accessor, JSONSupport { } export class StylePattern3D { /** * The fill style. * * @default solid * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-patterns-StylePattern3D.html#style) */ style: | "backward-diagonal" | "cross" | "diagonal-cross" | "forward-diagonal" | "horizontal" | "none" | "solid" | "vertical"; /** * The pattern type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-patterns-StylePattern3D.html#type) */ readonly type: "style"; /** * Renders polygons with predefined style pattern fills. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-patterns-StylePattern3D.html) */ constructor(properties?: StylePattern3DProperties); /** * Creates a deep clone of the pattern. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-patterns-StylePattern3D.html#clone) */ clone(): StylePattern3D; static fromJSON(json: any): StylePattern3D; } interface StylePattern3DProperties { /** * The fill style. * * @default solid * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-patterns-StylePattern3D.html#style) */ style?: | "backward-diagonal" | "cross" | "diagonal-cross" | "forward-diagonal" | "horizontal" | "none" | "solid" | "vertical"; } export class PictureFillSymbol extends FillSymbol { /** * The height of the image in points. * * @default 12 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#height) */ height: number; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#type) */ readonly type: "picture-fill"; /** * The URL to the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#url) */ url: string; /** * The width of the image in points. * * @default 12 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#width) */ width: number; /** * The offset on the x-axis in points. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#xoffset) */ xoffset: number; /** * The scale factor on the x axis of the symbol. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#xscale) */ xscale: number; /** * The offset on the y-axis in pixels or points. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#yoffset) */ yoffset: number; /** * The scale factor on the y axis of the symbol. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#yscale) */ yscale: number; /** * PictureFillSymbol uses an image in a repeating pattern to symbolize polygon features in a 2D [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html) */ constructor(properties?: PictureFillSymbolProperties); /** * Creates a deep clone of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#clone) */ clone(): PictureFillSymbol; static fromJSON(json: any): PictureFillSymbol; } interface PictureFillSymbolProperties extends FillSymbolProperties { /** * The height of the image in points. * * @default 12 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#height) */ height?: number | string; /** * The URL to the image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#url) */ url?: string; /** * The width of the image in points. * * @default 12 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#width) */ width?: number | string; /** * The offset on the x-axis in points. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#xoffset) */ xoffset?: number | string; /** * The scale factor on the x axis of the symbol. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#xscale) */ xscale?: number; /** * The offset on the y-axis in pixels or points. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#yoffset) */ yoffset?: number | string; /** * The scale factor on the y axis of the symbol. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#yscale) */ yscale?: number; } export class PictureMarkerSymbol extends MarkerSymbol { /** * The height of the image in points. * * @default 12 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html#height) */ height: number; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html#type) */ readonly type: "picture-marker"; /** * The URL to an image or SVG document. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html#url) */ url: string; /** * The width of the image in points. * * @default 12 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html#width) */ width: number; /** * PictureMarkerSymbol renders [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) graphics in either a 2D [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) using an image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html) */ constructor(properties?: PictureMarkerSymbolProperties); /** * Creates a deep clone of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html#clone) */ clone(): PictureMarkerSymbol; static fromJSON(json: any): PictureMarkerSymbol; } interface PictureMarkerSymbolProperties extends MarkerSymbolProperties { /** * The height of the image in points. * * @default 12 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html#height) */ height?: number | string; /** * The URL to an image or SVG document. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html#url) */ url?: string; /** * The width of the image in points. * * @default 12 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html#width) */ width?: number | string; } export class PointSymbol3D extends Symbol3D { /** * Settings for adding a callout visualization to the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#callout) */ callout: LineCallout3D; /** * A Collection of [Symbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html) objects used to visualize the graphic or feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#symbolLayers) */ symbolLayers: Collection; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#type) */ readonly type: "point-3d"; /** * Shifts the symbol along the vertical world axis by a given height. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#verticalOffset) */ verticalOffset: Symbol3DVerticalOffset; /** * PointSymbol3D is used to render features with [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometry in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html) */ constructor(properties?: PointSymbol3DProperties); /** * Creates a deep clone of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#clone) */ clone(): PointSymbol3D; static fromJSON(json: any): PointSymbol3D; } interface PointSymbol3DProperties extends Symbol3DProperties { /** * Settings for adding a callout visualization to the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#callout) */ callout?: LineCallout3DProperties; /** * A Collection of [Symbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html) objects used to visualize the graphic or feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#symbolLayers) */ symbolLayers?: CollectionProperties< | (IconSymbol3DLayerProperties & { type: "icon" }) | (ObjectSymbol3DLayerProperties & { type: "object" }) | (TextSymbol3DLayerProperties & { type: "text" }) >; /** * Shifts the symbol along the vertical world axis by a given height. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#verticalOffset) */ verticalOffset?: Symbol3DVerticalOffsetProperties; } export class PolygonSymbol3D extends Symbol3D { /** * A Collection of [Symbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html) objects used to visualize the graphic or feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PolygonSymbol3D.html#symbolLayers) */ symbolLayers: Collection< | ExtrudeSymbol3DLayer | FillSymbol3DLayer | IconSymbol3DLayer | LineSymbol3DLayer | ObjectSymbol3DLayer | TextSymbol3DLayer | WaterSymbol3DLayer >; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PolygonSymbol3D.html#type) */ readonly type: "polygon-3d"; /** * PolygonSymbol3D is used to render features with [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) geometry in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PolygonSymbol3D.html) */ constructor(properties?: PolygonSymbol3DProperties); /** * Creates a deep clone of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PolygonSymbol3D.html#clone) */ clone(): PolygonSymbol3D; static fromJSON(json: any): PolygonSymbol3D; } interface PolygonSymbol3DProperties extends Symbol3DProperties { /** * A Collection of [Symbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html) objects used to visualize the graphic or feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PolygonSymbol3D.html#symbolLayers) */ symbolLayers?: CollectionProperties< | (ExtrudeSymbol3DLayerProperties & { type: "extrude" }) | (FillSymbol3DLayerProperties & { type: "fill" }) | (IconSymbol3DLayerProperties & { type: "icon" }) | (LineSymbol3DLayerProperties & { type: "line" }) | (ObjectSymbol3DLayerProperties & { type: "object" }) | (TextSymbol3DLayerProperties & { type: "text" }) | (WaterSymbol3DLayerProperties & { type: "water" }) >; } export class SimpleFillSymbol extends FillSymbol { /** * The fill style. * * @default solid * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html#style) */ style: | "backward-diagonal" | "cross" | "diagonal-cross" | "forward-diagonal" | "horizontal" | "none" | "solid" | "vertical"; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html#type) */ readonly type: "simple-fill"; /** * SimpleFillSymbol is used for rendering 2D polygons in either a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html) */ constructor(properties?: SimpleFillSymbolProperties); /** * Creates a deep clone of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html#clone) */ clone(): SimpleFillSymbol; static fromJSON(json: any): SimpleFillSymbol; } interface SimpleFillSymbolProperties extends FillSymbolProperties { /** * The fill style. * * @default solid * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html#style) */ style?: | "backward-diagonal" | "cross" | "diagonal-cross" | "forward-diagonal" | "horizontal" | "none" | "solid" | "vertical"; } export class SimpleLineSymbol extends LineSymbol { /** * Specifies the cap style. * * @default round * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#cap) */ cap: "butt" | "round" | "square"; /** * Specifies the join style. * * @default round * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#join) */ join: "miter" | "round" | "bevel"; /** * Specifies the color, style, and placement of a symbol marker on the line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#marker) */ marker: LineSymbolMarker | null; /** * Maximum allowed ratio of the width of a miter join to the line width. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#miterLimit) */ miterLimit: number; /** * Specifies the line style. * * @default solid * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#style) */ style: | "dash" | "dash-dot" | "dot" | "long-dash" | "long-dash-dot" | "long-dash-dot-dot" | "none" | "short-dash" | "short-dash-dot" | "short-dash-dot-dot" | "short-dot" | "solid"; /** * SimpleLineSymbol is used for rendering 2D [polyline geometries](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) in a 2D [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html) */ constructor(properties?: SimpleLineSymbolProperties); /** * Creates a deep clone of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#clone) */ clone(): SimpleLineSymbol; static fromJSON(json: any): SimpleLineSymbol; } interface SimpleLineSymbolProperties extends LineSymbolProperties { /** * Specifies the cap style. * * @default round * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#cap) */ cap?: "butt" | "round" | "square"; /** * Specifies the join style. * * @default round * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#join) */ join?: "miter" | "round" | "bevel"; /** * Specifies the color, style, and placement of a symbol marker on the line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#marker) */ marker?: (LineSymbolMarkerProperties & { type: "line-marker" }) | null; /** * Maximum allowed ratio of the width of a miter join to the line width. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#miterLimit) */ miterLimit?: number; /** * Specifies the line style. * * @default solid * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#style) */ style?: | "dash" | "dash-dot" | "dot" | "long-dash" | "long-dash-dot" | "long-dash-dot-dot" | "none" | "short-dash" | "short-dash-dot" | "short-dash-dot-dot" | "short-dot" | "solid"; } export class SimpleMarkerSymbol extends MarkerSymbol { /** * The outline of the marker symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#outline) */ outline: SimpleLineSymbol; /** * The SVG path of the icon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#path) */ path: string; /** * The size of the marker in points. * * @default 12 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#size) */ size: number; /** * The marker style. * * @default circle * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#style) */ style: "circle" | "square" | "cross" | "x" | "diamond" | "triangle" | "path"; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#type) */ readonly type: "simple-marker"; /** * SimpleMarkerSymbol is used for rendering 2D [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometries with a simple shape and [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#color) in either a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html) */ constructor(properties?: SimpleMarkerSymbolProperties); /** * Creates a deep clone of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#clone) */ clone(): SimpleMarkerSymbol; static fromJSON(json: any): SimpleMarkerSymbol; } interface SimpleMarkerSymbolProperties extends MarkerSymbolProperties { /** * The outline of the marker symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#outline) */ outline?: SimpleLineSymbolProperties; /** * The SVG path of the icon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#path) */ path?: string; /** * The size of the marker in points. * * @default 12 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#size) */ size?: number | string; /** * The marker style. * * @default circle * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#style) */ style?: "circle" | "square" | "cross" | "x" | "diamond" | "triangle" | "path"; } /** * Provides utility functions for converting simple symbols and picture symbols to [CIMSymbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-cimConversionUtils.html) */ interface cimConversionUtils { /** * Converts a given symbol to a CIMSymbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-cimConversionUtils.html#convertToCIMSymbol) */ convertToCIMSymbol(symbol: SimpleMarkerSymbol | SimpleLineSymbol | SimpleFillSymbol | PictureMarkerSymbol | PictureFillSymbol): CIMSymbol; } export const cimConversionUtils: cimConversionUtils; /** * Provides utility functions for [CIMSymbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-cimSymbolUtils.html) */ interface cimSymbolUtils { /** * Sets the color of the symbol layers of a CIMSymbol to a given value if the symbol layer is not color locked. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-cimSymbolUtils.html#applyCIMSymbolColor) */ applyCIMSymbolColor(symbol: CIMSymbol, color: Color, options?: cimSymbolUtilsApplyCIMSymbolColorOptions): void; /** * Sets the rotation value of a CIMSymbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-cimSymbolUtils.html#applyCIMSymbolRotation) */ applyCIMSymbolRotation(symbol: CIMSymbol, rotation: number, clockwise?: boolean): void; /** * Returns the first color of the symbol layers in a CIMSymbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-cimSymbolUtils.html#getCIMSymbolColor) */ getCIMSymbolColor(symbol: CIMSymbol): Color; /** * Returns the rotation value of a CIMSymbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-cimSymbolUtils.html#getCIMSymbolRotation) */ getCIMSymbolRotation(symbol: CIMSymbol, clockwise?: boolean): number; /** * Returns the size of a given CIMSymbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-cimSymbolUtils.html#getCIMSymbolSize) */ getCIMSymbolSize(symbol: CIMSymbol): number; /** * Scales the largest layer of a CIMSymbol to a given size. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-cimSymbolUtils.html#scaleCIMSymbolTo) */ scaleCIMSymbolTo(symbol: CIMSymbol, size: number, options?: cimSymbolUtilsScaleCIMSymbolToOptions): void; } export const cimSymbolUtils: cimSymbolUtils; export interface cimSymbolUtilsApplyCIMSymbolColorOptions { /** * The symbol layers to apply the color to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-cimSymbolUtils.html#applyCIMSymbolColor) */ layersToColor?: "fill" | "outline" | "fill-and-outline"; } export interface cimSymbolUtilsScaleCIMSymbolToOptions { /** * When `true`, this property will preserve the outline width of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-cimSymbolUtils.html#scaleCIMSymbolTo) */ preserveOutlineWidth?: boolean; } /** * Provides a utility method used to deserialize a JSON symbol object returned by the REST API. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-jsonUtils.html) */ interface symbolsSupportJsonUtils { /** * Creates a new instance of an appropriate [Symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol.html) class and initializes it with values from a JSON object generated from an ArcGIS product. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-jsonUtils.html#fromJSON) */ fromJSON(json: any): Symbol; } export const symbolsSupportJsonUtils: symbolsSupportJsonUtils; export class StyleOrigin extends Accessor { /** * Name of the symbol in the style referenced by styleName or styleUrl. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-StyleOrigin.html#name) */ name: string; /** * The portal of the style origin. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-StyleOrigin.html#portal) */ portal: Portal; /** * The well-known esri-provided style, such as `EsriThematicShapesStyle`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-StyleOrigin.html#styleName) */ styleName: string; /** * A url to a style definition. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-StyleOrigin.html#styleUrl) */ styleUrl: string; /** * The style origin. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-StyleOrigin.html) */ constructor(properties?: StyleOriginProperties); /** * Creates a deep clone of the style origin. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-StyleOrigin.html#clone) */ clone(): StyleOrigin; } interface StyleOriginProperties { /** * Name of the symbol in the style referenced by styleName or styleUrl. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-StyleOrigin.html#name) */ name?: string; /** * The portal of the style origin. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-StyleOrigin.html#portal) */ portal?: PortalProperties; /** * The well-known esri-provided style, such as `EsriThematicShapesStyle`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-StyleOrigin.html#styleName) */ styleName?: string; /** * A url to a style definition. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-StyleOrigin.html#styleUrl) */ styleUrl?: string; } export class Symbol3DVerticalOffset extends Accessor { /** * The maximum vertical symbol offset in world units. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-Symbol3DVerticalOffset.html#maxWorldLength) */ maxWorldLength: number; /** * The minimum vertical symbol offset in world units. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-Symbol3DVerticalOffset.html#minWorldLength) */ minWorldLength: number; /** * Vertical symbol offset in screen size. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-Symbol3DVerticalOffset.html#screenLength) */ screenLength: number; /** * Shifts a symbol along the vertical world axis by a given height. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-Symbol3DVerticalOffset.html) */ constructor(properties?: Symbol3DVerticalOffsetProperties); /** * Creates a deep clone of the vertical offset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-Symbol3DVerticalOffset.html#clone) */ clone(): Symbol3DVerticalOffset; } interface Symbol3DVerticalOffsetProperties { /** * The maximum vertical symbol offset in world units. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-Symbol3DVerticalOffset.html#maxWorldLength) */ maxWorldLength?: number; /** * The minimum vertical symbol offset in world units. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-Symbol3DVerticalOffset.html#minWorldLength) */ minWorldLength?: number; /** * Vertical symbol offset in screen size. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-Symbol3DVerticalOffset.html#screenLength) */ screenLength?: number | string; } /** * Generates small preview images of symbols. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html) */ interface symbolUtils { /** * Returns a color representing the input [graphic's](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#getDisplayedColor) */ getDisplayedColor(graphic: Graphic, options?: symbolUtilsGetDisplayedColorOptions): Promise; /** * Returns a symbol representing the input [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#getDisplayedSymbol) */ getDisplayedSymbol(graphic: Graphic, options?: symbolUtilsGetDisplayedSymbolOptions): Promise; /** * Returns a label corresponding to the symbol of the input [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) as displayed in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#getLegendLabel) */ getLegendLabel(graphic: Graphic, view?: MapView | SceneView, options?: symbolUtilsGetLegendLabelOptions): Promise; /** * Generates a preview image of a color ramp to display in a custom widget or other DOM element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderColorRampPreviewHTML) */ renderColorRampPreviewHTML(colors: Color[], options?: symbolUtilsRenderColorRampPreviewHTMLOptions): HTMLElement; /** * Generates an HTML element representing the legend of a [PieChartRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderPieChartPreviewHTML) */ renderPieChartPreviewHTML(colors: Color[], options?: symbolUtilsRenderPieChartPreviewHTMLOptions): HTMLElement; /** * Generates a preview image of a given symbol that can be displayed in a custom widget or other DOM element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderPreviewHTML) */ renderPreviewHTML(symbol: Symbol, options?: symbolUtilsRenderPreviewHTMLOptions): Promise; /** * Generates an HTML element representing the square or diamond legend element of a relationship renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderRelationshipRampPreviewHTML) */ renderRelationshipRampPreviewHTML(renderer: UniqueValueRenderer, options?: symbolUtilsRenderRelationshipRampPreviewHTMLOptions): HTMLElement; } export const symbolUtils: symbolUtils; export interface symbolUtilsGetDisplayedColorOptions { /** * The [view scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) at which the graphic is displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#getDisplayedColor) */ scale?: number; /** * The [viewingMode](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewingMode) of the view, if the graphic is displayed in a SceneView. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#getDisplayedColor) */ viewingMode?: string; /** * The spatial reference of the view in which the graphic is displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#getDisplayedColor) */ spatialReference?: SpatialReference; /** * The renderer of the layer associated with the `graphic`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#getDisplayedColor) */ renderer?: Renderer; /** * The [resolution](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#resolution) of the view at which the graphic is displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#getDisplayedColor) */ resolution?: number; } export interface symbolUtilsGetDisplayedSymbolOptions { /** * The [view scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) at which the symbol is displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#getDisplayedSymbol) */ scale?: number; /** * The [viewingMode](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewingMode) of the view, if the symbol is displayed in a SceneView. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#getDisplayedSymbol) */ viewingMode?: string; /** * The spatial reference of the view in which the symbol is displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#getDisplayedSymbol) */ spatialReference?: SpatialReference; /** * The renderer of the layer associated with the `graphic`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#getDisplayedSymbol) */ renderer?: Renderer; /** * The [resolution](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#resolution) of the view at which the symbol is displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#getDisplayedSymbol) */ resolution?: number; } export interface symbolUtilsGetLegendLabelOptions { /** * The [view scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) at which the symbol is displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#getLegendLabel) */ scale?: number; /** * The [viewingMode](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewingMode) of the view, if the symbol is displayed in a SceneView. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#getLegendLabel) */ viewingMode?: string; /** * The spatial reference of the view in which the symbol is displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#getLegendLabel) */ spatialReference?: SpatialReference; /** * The renderer of the layer associated with the `graphic`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#getLegendLabel) */ renderer?: Renderer; /** * The [resolution](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#resolution) of the view at which the symbol is displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#getLegendLabel) */ resolution?: number; } export interface symbolUtilsRenderColorRampPreviewHTMLOptions { /** * Specifies the alignment of the color ramp. * * @default vertical * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderColorRampPreviewHTML) */ align?: "horizontal" | "vertical"; /** * Indicates whether to render the color ramp with a continuous gradient. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderColorRampPreviewHTML) */ gradient?: boolean; /** * The width of the ramp in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderColorRampPreviewHTML) */ width?: number; /** * The height of the ramp in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderColorRampPreviewHTML) */ height?: number; } export interface symbolUtilsRenderPieChartPreviewHTMLOptions { /** * The radius of the pie chart in pixels. * * @default 40 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderPieChartPreviewHTML) */ radius?: number; /** * The hole percentage of the chart on a scale of 0-1. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderPieChartPreviewHTML) */ holePercentage?: number; /** * The values used to indicate the area each color should represent as a percentage when creating the pie chart. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderPieChartPreviewHTML) */ values?: number[]; /** * The outline of the pie chart. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderPieChartPreviewHTML) */ outline?: SimpleLineSymbol; } export interface symbolUtilsRenderPreviewHTMLOptions { /** * The parent node to append to the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderPreviewHTML) */ node?: HTMLElement; /** * Use a number to set the size (in points) of the symbol preview for any symbol representing a point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderPreviewHTML) */ size?: number | symbolUtilsRenderPreviewHTMLOptionsSize; /** * The maximum size of the symbol preview in points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderPreviewHTML) */ maxSize?: number; /** * The opacity of the layer represented by the `symbol`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderPreviewHTML) */ opacity?: number; /** * When `true` the size of the symbol preview will include the outline in the measurement of the entire symbol. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderPreviewHTML) */ scale?: boolean; /** * Indicates whether to disable upsampling for raster images. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderPreviewHTML) */ disableUpsampling?: boolean; /** * Options for setting the shape of a fill symbol preview. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderPreviewHTML) */ symbolConfig?: "tall" | symbolUtilsRenderPreviewHTMLOptionsSymbolConfig; /** * The rotation of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderPreviewHTML) */ rotation?: number; /** * _Since 4.25_ The text that will be displayed in the symbol preview of a TextSymbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderPreviewHTML) */ overrideText?: string; } export interface symbolUtilsRenderPreviewHTMLOptionsSize { /** * The width of the symbol preview in points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderPreviewHTML) */ width?: number; /** * The height of the symbol preview in points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderPreviewHTML) */ height?: number; } export interface symbolUtilsRenderPreviewHTMLOptionsSymbolConfig { /** * Set to `true` for "tall" symbols in portrait view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderPreviewHTML) */ isTall?: boolean; /** * Set to `true` to render the preview as a square instead of a generic polygon shape. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderPreviewHTML) */ isSquareFill?: boolean; } export interface symbolUtilsRenderRelationshipRampPreviewHTMLOptions { /** * The container node in which to place the generated relationship element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderRelationshipRampPreviewHTML) */ node?: HTMLElement; /** * The opacity of the legend element. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolUtils.html#renderRelationshipRampPreviewHTML) */ opacity?: number; } export interface Symbol extends Accessor, JSONSupport { } export class Symbol { /** * The color of the symbol. * * @default black * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol.html#color) */ color: Color; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol.html#type) */ readonly type: | "simple-marker" | "picture-marker" | "simple-line" | "simple-fill" | "picture-fill" | "text" | "shield-label-symbol" | "point-3d" | "line-3d" | "polygon-3d" | "web-style" | "mesh-3d" | "label-3d" | "cim"; /** * Symbol is the base class for all symbols. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol.html) */ constructor(properties?: SymbolProperties); static fromJSON(json: any): Symbol; } interface SymbolProperties { /** * The color of the symbol. * * @default black * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol.html#color) */ color?: Color | number[] | string; } export class Symbol3D extends Symbol { /** * The origin of the style from which the symbol was originally referenced. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html#styleOrigin) */ styleOrigin: StyleOrigin; /** * A Collection of [Symbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html) objects used to visualize the graphic or feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html#symbolLayers) */ symbolLayers: Collection; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html#type) */ readonly type: "point-3d" | "line-3d" | "polygon-3d" | "mesh-3d" | "label-3d"; /** * Symbol3D is the base class for all 3D symbols. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html) */ constructor(properties?: Symbol3DProperties); static fromJSON(json: any): Symbol3D; } interface Symbol3DProperties extends SymbolProperties { /** * The origin of the style from which the symbol was originally referenced. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html#styleOrigin) */ styleOrigin?: StyleOriginProperties; /** * A Collection of [Symbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html) objects used to visualize the graphic or feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html#symbolLayers) */ symbolLayers?: CollectionProperties; } export interface Symbol3DLayer extends Accessor, JSONSupport { } export class Symbol3DLayer { /** * The 3D symbol layer type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html#type) */ readonly type: "icon" | "object" | "line" | "path" | "fill" | "water" | "extrude" | "text"; /** * Symbol layers are used to define the visualization of [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html), [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html), [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html), and mesh geometries rendered with [3D symbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html) */ constructor(properties?: Symbol3DLayerProperties); static fromJSON(json: any): Symbol3DLayer; } interface Symbol3DLayerProperties { } export class TextSymbol extends Symbol { /** * The angle of the text. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#angle) */ angle: number; /** * The background color of the label's bounding box. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#backgroundColor) */ backgroundColor: Color; /** * The border color of the label's bounding box. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#borderLineColor) */ borderLineColor: Color; /** * The border size or width of the label's bounding box. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#borderLineSize) */ borderLineSize: number; /** * The [Font](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html) used to style the text. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#font) */ font: Font; /** * The color of the text symbol's halo. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#haloColor) */ haloColor: Color; /** * The size in points of the text symbol's halo. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#haloSize) */ haloSize: number; /** * Adjusts the horizontal alignment of the text in multi-lines. * * @default "center" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#horizontalAlignment) */ horizontalAlignment: "left" | "right" | "center"; /** * Determines whether to adjust the spacing between characters in the text string. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#kerning) */ kerning: boolean; /** * The height of the space between each line of text. * * @default 1.0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#lineHeight) */ lineHeight: number; /** * The maximum length in points for each line of text. * * @default 192 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#lineWidth) */ lineWidth: number; /** * Determines whether every character in the text string is rotated. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#rotated) */ rotated: boolean; /** * The text string to display in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#text) */ text: string; readonly type: "text"; /** * Adjusts the vertical alignment of the text. * * @default "baseline" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#verticalAlignment) */ verticalAlignment: "baseline" | "top" | "middle" | "bottom"; /** * The offset on the x-axis in points. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#xoffset) */ xoffset: number; /** * The offset on the y-axis in points. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#yoffset) */ yoffset: number; /** * Text symbols are used to define the graphic for displaying labels on a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html), [Sublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html), and [StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html) in a 2D [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html) */ constructor(properties?: TextSymbolProperties); /** * Creates a deep clone of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#clone) */ clone(): TextSymbol; static fromJSON(json: any): TextSymbol; } interface TextSymbolProperties extends SymbolProperties { /** * The angle of the text. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#angle) */ angle?: number; /** * The background color of the label's bounding box. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#backgroundColor) */ backgroundColor?: Color | number[] | string; /** * The border color of the label's bounding box. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#borderLineColor) */ borderLineColor?: Color | number[] | string; /** * The border size or width of the label's bounding box. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#borderLineSize) */ borderLineSize?: number; /** * The [Font](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html) used to style the text. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#font) */ font?: FontProperties; /** * The color of the text symbol's halo. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#haloColor) */ haloColor?: Color | number[] | string; /** * The size in points of the text symbol's halo. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#haloSize) */ haloSize?: number | string; /** * Adjusts the horizontal alignment of the text in multi-lines. * * @default "center" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#horizontalAlignment) */ horizontalAlignment?: "left" | "right" | "center"; /** * Determines whether to adjust the spacing between characters in the text string. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#kerning) */ kerning?: boolean; /** * The height of the space between each line of text. * * @default 1.0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#lineHeight) */ lineHeight?: number; /** * The maximum length in points for each line of text. * * @default 192 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#lineWidth) */ lineWidth?: number | string; /** * Determines whether every character in the text string is rotated. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#rotated) */ rotated?: boolean; /** * The text string to display in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#text) */ text?: string; /** * Adjusts the vertical alignment of the text. * * @default "baseline" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#verticalAlignment) */ verticalAlignment?: "baseline" | "top" | "middle" | "bottom"; /** * The offset on the x-axis in points. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#xoffset) */ xoffset?: number | string; /** * The offset on the y-axis in points. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#yoffset) */ yoffset?: number | string; } export class TextSymbol3DLayer extends Symbol3DLayer { /** * The background of the text. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#background) */ background: TextSymbol3DLayerBackground; /** * The font of the text label. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#font) */ font: Font; /** * The halo surrounding the text. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#halo) */ halo: TextSymbol3DLayerHalo; /** * Adjusts the horizontal alignment of the text in multi-lines. * * @default "center" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#horizontalAlignment) */ horizontalAlignment: "left" | "right" | "center"; /** * The height of the space between each line of text. * * @default 1.0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#lineHeight) */ lineHeight: number; /** * The material used to color the text. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#material) */ material: TextSymbol3DLayerMaterial; /** * Size of the text label in points. * * @default 9 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#size) */ size: number; /** * The text to be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#text) */ text: string; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#type) */ readonly type: "text"; /** * Adjusts the vertical alignment of the text. * * @default "baseline" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#verticalAlignment) */ verticalAlignment: "baseline" | "top" | "middle" | "bottom"; /** * TextSymbol3DLayer is used to draw text labels for features of any geometry type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html) */ constructor(properties?: TextSymbol3DLayerProperties); /** * Creates a deep clone of the symbol layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#clone) */ clone(): TextSymbol3DLayer; static fromJSON(json: any): TextSymbol3DLayer; } interface TextSymbol3DLayerProperties extends Symbol3DLayerProperties { /** * The background of the text. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#background) */ background?: TextSymbol3DLayerBackgroundProperties; /** * The font of the text label. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#font) */ font?: FontProperties; /** * The halo surrounding the text. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#halo) */ halo?: TextSymbol3DLayerHaloProperties; /** * Adjusts the horizontal alignment of the text in multi-lines. * * @default "center" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#horizontalAlignment) */ horizontalAlignment?: "left" | "right" | "center"; /** * The height of the space between each line of text. * * @default 1.0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#lineHeight) */ lineHeight?: number; /** * The material used to color the text. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#material) */ material?: TextSymbol3DLayerMaterialProperties; /** * Size of the text label in points. * * @default 9 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#size) */ size?: number | string; /** * The text to be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#text) */ text?: string; /** * Adjusts the vertical alignment of the text. * * @default "baseline" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#verticalAlignment) */ verticalAlignment?: "baseline" | "top" | "middle" | "bottom"; } export interface TextSymbol3DLayerBackgroundProperties { /** * The color of the background. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#background) */ color?: Color | number[] | string; } export interface TextSymbol3DLayerBackground extends AnonymousAccessor { /** * The color of the background. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#background) */ color?: Color; } export interface TextSymbol3DLayerHaloProperties { /** * The color of the halo. * * @default black * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#halo) */ color?: Color | number[] | string; /** * The size of the halo in points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#halo) */ size?: number | string; } export interface TextSymbol3DLayerHalo extends AnonymousAccessor { /** * The color of the halo. * * @default black * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#halo) */ color?: Color; /** * The size of the halo in points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#halo) */ size?: number; } export interface TextSymbol3DLayerMaterialProperties { /** * The color of the text. * * @default white * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#material) */ color?: Color | number[] | string; } export interface TextSymbol3DLayerMaterial extends AnonymousAccessor { /** * The color of the text. * * @default white * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#material) */ color?: Color; } export class WaterSymbol3DLayer extends Symbol3DLayer { /** * The dominant color used to shade the water. * * @default #0077BE * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WaterSymbol3DLayer.html#color) */ color: Color; /** * The symbol type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WaterSymbol3DLayer.html#type) */ readonly type: "water"; /** * Indicates the size of the waterbody which is represented by the symbol layer. * * @default medium * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WaterSymbol3DLayer.html#waterbodySize) */ waterbodySize: "small" | "medium" | "large"; /** * Indicates the direction in which the waves travel. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WaterSymbol3DLayer.html#waveDirection) */ waveDirection: number; /** * Indicates the shape and intensity of the waves. * * @default moderate * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WaterSymbol3DLayer.html#waveStrength) */ waveStrength: "calm" | "rippled" | "slight" | "moderate"; /** * WaterSymbol3DLayer is used to render [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) geometries as realistic, animated water surfaces, therefore it can only be used inside a [PolygonSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PolygonSymbol3D.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WaterSymbol3DLayer.html) */ constructor(properties?: WaterSymbol3DLayerProperties); /** * Creates a deep clone of the symbol layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WaterSymbol3DLayer.html#clone) */ clone(): WaterSymbol3DLayer; static fromJSON(json: any): WaterSymbol3DLayer; } interface WaterSymbol3DLayerProperties extends Symbol3DLayerProperties { /** * The dominant color used to shade the water. * * @default #0077BE * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WaterSymbol3DLayer.html#color) */ color?: Color | number[] | string; /** * Indicates the size of the waterbody which is represented by the symbol layer. * * @default medium * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WaterSymbol3DLayer.html#waterbodySize) */ waterbodySize?: "small" | "medium" | "large"; /** * Indicates the direction in which the waves travel. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WaterSymbol3DLayer.html#waveDirection) */ waveDirection?: number; /** * Indicates the shape and intensity of the waves. * * @default moderate * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WaterSymbol3DLayer.html#waveStrength) */ waveStrength?: "calm" | "rippled" | "slight" | "moderate"; } export class WebStyleSymbol extends Symbol { /** * The name of the symbol within the web style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#name) */ name: string; /** * The portal that contains the web style this symbol refers to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#portal) */ portal: Portal; /** * A registered web style name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#styleName) */ styleName: string; /** * URL that points to the web style definition. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#styleUrl) */ styleUrl: string; readonly type: "web-style"; /** * WebStyleSymbol is a class used to conveniently create vector 2D symbols and realistic and thematic 3D symbols. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html) */ constructor(properties?: WebStyleSymbolProperties); /** * Creates a deep clone of the symbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#clone) */ clone(): WebStyleSymbol; /** * Returns the [CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html) instance the WebStyleSymbol refers to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#fetchCIMSymbol) */ fetchCIMSymbol(options?: WebStyleSymbolFetchCIMSymbolOptions): Promise; /** * Downloads and returns the [PointSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html) instance the WebStyleSymbol refers to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#fetchSymbol) */ fetchSymbol(options?: WebStyleSymbolFetchSymbolOptions): Promise; static fromJSON(json: any): WebStyleSymbol; } interface WebStyleSymbolProperties extends SymbolProperties { /** * The name of the symbol within the web style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#name) */ name?: string; /** * The portal that contains the web style this symbol refers to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#portal) */ portal?: PortalProperties; /** * A registered web style name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#styleName) */ styleName?: string; /** * URL that points to the web style definition. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#styleUrl) */ styleUrl?: string; } export interface WebStyleSymbolFetchCIMSymbolOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#fetchCIMSymbol) */ signal?: AbortSignal; } export interface WebStyleSymbolFetchSymbolOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#fetchSymbol) */ signal?: AbortSignal; } /** * CIMSymbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#CIMSymbol) */ export type symbolsCIMSymbol = CIMSymbol; /** * ExtrudeSymbol3DLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#ExtrudeSymbol3DLayer) */ export type symbolsExtrudeSymbol3DLayer = ExtrudeSymbol3DLayer; /** * FillSymbol types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#FillSymbol) */ export type symbolsFillSymbol = PictureFillSymbol | SimpleFillSymbol; /** * FillSymbol3DLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#FillSymbol3DLayer) */ export type symbolsFillSymbol3DLayer = FillSymbol3DLayer; /** * Font. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#Font) */ export type symbolsFont = Font; /** * IconSymbol3DLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#IconSymbol3DLayer) */ export type symbolsIconSymbol3DLayer = IconSymbol3DLayer; /** * LabelSymbol3D. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#LabelSymbol3D) */ export type symbolsLabelSymbol3D = LabelSymbol3D; /** * LineSymbol3D. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#LineSymbol3D) */ export type symbolsLineSymbol3D = LineSymbol3D; /** * LineSymbol3DLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#LineSymbol3DLayer) */ export type symbolsLineSymbol3DLayer = LineSymbol3DLayer; /** * MarkerSymbol types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#MarkerSymbol) */ export type symbolsMarkerSymbol = PictureMarkerSymbol | SimpleMarkerSymbol; /** * MeshSymbol3D. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#MeshSymbol3D) */ export type symbolsMeshSymbol3D = MeshSymbol3D; /** * ObjectSymbol3DLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#ObjectSymbol3DLayer) */ export type symbolsObjectSymbol3DLayer = ObjectSymbol3DLayer; /** * PathSymbol3DLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#PathSymbol3DLayer) */ export type symbolsPathSymbol3DLayer = PathSymbol3DLayer; /** * PictureFillSymbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#PictureFillSymbol) */ export type symbolsPictureFillSymbol = PictureFillSymbol; /** * PictureMarkerSymbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#PictureMarkerSymbol) */ export type symbolsPictureMarkerSymbol = PictureMarkerSymbol; /** * PointSymbol3D. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#PointSymbol3D) */ export type symbolsPointSymbol3D = PointSymbol3D; /** * PolygonSymbol3D. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#PolygonSymbol3D) */ export type symbolsPolygonSymbol3D = PolygonSymbol3D; /** * SimpleFillSymbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#SimpleFillSymbol) */ export type symbolsSimpleFillSymbol = SimpleFillSymbol; /** * SimpleLineSymbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#SimpleLineSymbol) */ export type symbolsSimpleLineSymbol = SimpleLineSymbol; /** * SimpleMarkerSymbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#SimpleMarkerSymbol) */ export type symbolsSimpleMarkerSymbol = SimpleMarkerSymbol; /** * Symbol types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#Symbol) */ export type symbolsSymbol = Symbol2D3D | WebStyleSymbol; /** * Symbol2D types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#Symbol2D) */ export type Symbol2D = | PictureFillSymbol | PictureMarkerSymbol | SimpleFillSymbol | SimpleLineSymbol | SimpleMarkerSymbol | TextSymbol | CIMSymbol; /** * Symbol2D3D types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#Symbol2D3D) */ export type Symbol2D3D = Symbol2D | symbolsSymbol3D; /** * Symbol3D types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#Symbol3D) */ export type symbolsSymbol3D = LabelSymbol3D | LineSymbol3D | MeshSymbol3D | PointSymbol3D | PolygonSymbol3D; /** * Symbol3DLayer types. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#Symbol3DLayer) */ export type symbolsSymbol3DLayer = | ExtrudeSymbol3DLayer | FillSymbol3DLayer | WaterSymbol3DLayer | IconSymbol3DLayer | LineSymbol3DLayer | ObjectSymbol3DLayer | PathSymbol3DLayer | TextSymbol3DLayer | WaterSymbol3DLayer; /** * TextSymbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#TextSymbol) */ export type symbolsTextSymbol = TextSymbol; /** * TextSymbol3DLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#TextSymbol3DLayer) */ export type symbolsTextSymbol3DLayer = TextSymbol3DLayer; /** * WaterSymbol3DLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#WaterSymbol3DLayer) */ export type symbolsWaterSymbol3DLayer = WaterSymbol3DLayer; /** * WebStyleSymbol. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html#WebStyleSymbol) */ export type symbolsWebStyleSymbol = WebStyleSymbol; export interface TimeExtent extends Accessor, JSONSupport { } export class TimeExtent { /** * The end time of the time extent. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeExtent.html#end) */ end: Date; /** * The start time of the time extent. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeExtent.html#start) */ start: Date; /** * A period of time with a definitive [start](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeExtent.html#start) and [end](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeExtent.html#end) date. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeExtent.html) */ constructor(properties?: TimeExtentProperties); /** * Creates a deep clone of TimeExtent object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeExtent.html#clone) */ clone(): TimeExtent; /** * Expands the TimeExtent so that the start and end dates are rounded down and up, respectively, to the parsed time unit. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeExtent.html#expandTo) */ expandTo(unit: | "milliseconds" | "seconds" | "minutes" | "hours" | "days" | "weeks" | "months" | "years" | "decades" | "centuries", timeZone: "system" | "unknown" | string): TimeExtent; /** * Returns the time extent resulting from the intersection of a given time extent and parsed time extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeExtent.html#intersection) */ intersection(timeExtent: TimeExtent): TimeExtent; /** * Returns the time extent resulting from the union of the current time extent and a given time extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeExtent.html#union) */ union(timeExtent: TimeExtent): TimeExtent; static fromJSON(json: any): TimeExtent; } interface TimeExtentProperties { /** * The end time of the time extent. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeExtent.html#end) */ end?: DateProperties; /** * The start time of the time extent. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeExtent.html#start) */ start?: DateProperties; } export interface TimeInterval extends Accessor, JSONSupport, Clonable { } export class TimeInterval { /** * Temporal units. * * @default milliseconds * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeInterval.html#unit) */ unit: | "milliseconds" | "seconds" | "minutes" | "hours" | "days" | "weeks" | "months" | "years" | "decades" | "centuries"; /** * The numerical value of the time extent. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeInterval.html#value) */ value: number; /** * TimeInterval is a class that describes a length of time in one of ten temporal units such as seconds, days, or years. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeInterval.html) */ constructor(properties?: TimeIntervalProperties); static fromJSON(json: any): TimeInterval; } interface TimeIntervalProperties { /** * Temporal units. * * @default milliseconds * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeInterval.html#unit) */ unit?: | "milliseconds" | "seconds" | "minutes" | "hours" | "days" | "weeks" | "months" | "years" | "decades" | "centuries"; /** * The numerical value of the time extent. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeInterval.html#value) */ value?: number; } export class VersionManagementService { /** * Describes the version management service's supported capabilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#capabilities) */ capabilities: VersionManagementServiceCapabilities; /** * Contains the value for the default version's name and GUID. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#defaultVersionIdentifier) */ defaultVersionIdentifier: VersionIdentifier; /** * Indicates whether the instance has loaded. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#loaded) */ readonly loaded: boolean; /** * The Error object returned if an error occurred while loading. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#loadError) */ readonly loadError: Error; /** * Represents the status of a [load](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#load) operation. * * @default not-loaded * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#loadStatus) */ readonly loadStatus: "not-loaded" | "loading" | "failed" | "loaded"; /** * The name of the version management service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#name) */ name: string; /** * The absolute URL of the REST endpoint for the version management service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#url) */ url: string; constructor(properties?: any); /** * The alter operation allows you to change the geodatabase version's name, description, owner, and access permissions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#alterVersion) */ alterVersion(versionIdentifier: VersionIdentifier, props: VersionManagementServiceAlterVersionProps): Promise; /** * `canRedo` may be used to verify that a [redo](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#redo) operation is possible. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#canRedo) */ canRedo(versionIdentifier: VersionIdentifier): boolean; /** * `canUndo` may be used to verify that an [undo](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#undo) operation is possible. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#canUndo) */ canUndo(versionIdentifier: VersionIdentifier): boolean; /** * Method used to change a layer's version/moment or network's version/moment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#changeVersion) */ changeVersion(input: WebMap | Collection | FeatureLayer[] | Network, fromVersion: Date | VersionIdentifier, toVersion: Date | VersionIdentifier): Promise; /** * Creates a new version given the following parameters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#createVersion) */ createVersion(props?: VersionManagementServiceCreateVersionProps): Promise; /** * Deletes a version given the following parameters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#deleteVersion) */ deleteVersion(versionIdentifier: VersionIdentifier): Promise; /** * Returns the current client lock type on a given version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#getLockType) */ getLockType(versionIdentifier: VersionIdentifier): string; /** * This method will return the [versionIdentifier](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#versionIdentifier) given the guid of the version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#getVersionIdentifierFromGuid) */ getVersionIdentifierFromGuid(guid: string): VersionIdentifier; /** * This method will return the [versionIdentifier](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#versionIdentifier) given the name of the version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#getVersionIdentifierFromName) */ getVersionIdentifierFromName(name: string): VersionIdentifier; /** * Method used to get extended information about a version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#getVersionInfoExtended) */ getVersionInfoExtended(versionIdentifier: VersionIdentifier): Promise; /** * Returns information about a version or versions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#getVersionInfos) */ getVersionInfos(props?: VersionManagementServiceGetVersionInfosProps): Promise; /** * Triggers the loading of the version management service instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#load) */ load(): Promise; /** * The Post operation allows the client to post the changes in their version to the default version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#post) */ post(versionIdentifier: VersionIdentifier): Promise; /** * Use the reconcile operation to reconcile a branch version with the default version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#reconcile) */ reconcile(versionIdentifier: VersionIdentifier, props: VersionManagementServiceReconcileProps): Promise; /** * This method redos the last edit made while in an edit session. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#redo) */ redo(versionIdentifier: VersionIdentifier): void; /** * Using the specified session ID an exclusive lock is obtained for the session on the version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#startEditing) */ startEditing(versionIdentifier: VersionIdentifier): Promise; /** * Using the specified client generated session ID, a shared lock is obtained for the session if the version is not already being edited by another user/session. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#startReading) */ startReading(versionIdentifier: VersionIdentifier): Promise; /** * Using the specified session id, the exclusive lock for the version is downgraded to a shared lock. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#stopEditing) */ stopEditing(versionIdentifier: VersionIdentifier, saveEdits: boolean): Promise; /** * The shared lock is released on the version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#stopReading) */ stopReading(versionIdentifier: VersionIdentifier): Promise; /** * This method undos the last edit made while in an edit session. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#undo) */ undo(versionIdentifier: VersionIdentifier): void; } /** * This contains information about the post result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#PostResult) */ export interface PostResult { /** * Returns data moments of the post. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#PostResult) */ moment: Date; /** * Specifies if the post rest call was successful. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#PostResult) */ success: boolean; } /** * This contains information about the reconcile result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#ReconcileResult) */ export interface ReconcileResult { /** * Specifies if the reconcile returned with conflicts. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#ReconcileResult) */ hasConflicts: boolean; /** * Returns data moment of the reconcile. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#ReconcileResult) */ moment: Date; /** * Specifies if the updates from the version were posted. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#ReconcileResult) */ didPost: boolean; /** * Specifies if the reconcile rest call was successful. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#ReconcileResult) */ success: boolean; } /** * Holds the name and guid of a version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionIdentifier) */ export interface VersionIdentifier { /** * The version name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionIdentifier) */ name: string; /** * The version GUID. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionIdentifier) */ guid: string; } /** * This contains extended information about a given version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoExtendedJSON) */ export interface VersionInfoExtendedJSON { /** * The identifier of a version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoExtendedJSON) */ versionIdentifier: VersionInfoExtendedJSONVersionIdentifier; /** * Description of the version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoExtendedJSON) */ description?: string; /** * The access type permissions of the version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoExtendedJSON) */ access?: "hidden" | "private" | "protected" | "public"; /** * The id of the version that was edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoExtendedJSON) */ versionId?: string; /** * The date the version was created on. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoExtendedJSON) */ creationDate?: number; /** * The date when the version was last modified or changed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoExtendedJSON) */ modifiedDate?: number; /** * The date when the version was last reconciled with the parent version or the default version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoExtendedJSON) */ reconcileDate?: number; /** * The date when the version was last evaluated for conflicts or discrepancies during the reconciliation process. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoExtendedJSON) */ evaluationDate?: number; /** * The date of the most recent ancestor version, if applicable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoExtendedJSON) */ previousAncestorDate?: number; /** * The date of the common ancestor version, which is the shared ancestor between two or more versions during the reconciliation process. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoExtendedJSON) */ commonAncestorDate?: number; /** * Specifies if the version is currently being edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoExtendedJSON) */ isBeingEdited?: boolean; /** * Specifies if the version is currently being read. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoExtendedJSON) */ isBeingRead?: boolean; /** * Specifies if the version is has conflicts. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoExtendedJSON) */ hasConflicts?: boolean; /** * Specifies if the version has UninspectedConflicts. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoExtendedJSON) */ hasUninspectedConflicts?: boolean; /** * Specifies if the version currenlty has a lock. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoExtendedJSON) */ isLocked?: boolean; /** * Specifies which user is the current lock owner. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoExtendedJSON) */ lockOwner?: string; /** * Specifies the date at which the version was locked. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoExtendedJSON) */ lockDate?: number; } /** * This contains basic information about a given version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoJSON) */ export interface VersionInfoJSON { /** * The identifier of a version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoJSON) */ versionIdentifier: VersionInfoJSONVersionIdentifier; /** * Description of the version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoJSON) */ description?: string; /** * Access type accepts values of private, public, hidden, and protected. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoJSON) */ access?: string; /** * The id of the version that was edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoJSON) */ versionId?: string; /** * The date the version was created on. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoJSON) */ creationDate?: number; /** * The date when the version was last modified or changed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoJSON) */ modifiedDate?: number; /** * The date when the version was last reconciled with the parent version or the default version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoJSON) */ reconcileDate?: number; /** * The date when the version was last evaluated for conflicts or discrepancies during the reconciliation process. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoJSON) */ evaluationDate?: number; /** * The date of the most recent ancestor version, if applicable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoJSON) */ previousAncestorDate?: number; /** * The date of the common ancestor version, which is the shared ancestor between two or more versions during the reconciliation process. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoJSON) */ commonAncestorDate?: number; } export interface VersionManagementServiceAlterVersionProps { /** * The new owner name of the version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#alterVersion) */ ownerName?: string; /** * The new name for the version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#alterVersion) */ versionName?: string; /** * The new description for the version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#alterVersion) */ description?: string; /** * The new access permissions of the version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#alterVersion) */ access?: "hidden" | "private" | "protected" | "public"; } /** * Describes the version management service's supported capabilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionManagementServiceCapabilities) */ export interface VersionManagementServiceCapabilities { /** * Indicates whether the service supports conflict detection based on attribute values during editing operations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionManagementServiceCapabilities) */ supportsConflictDetectionByAttribute: boolean; /** * Indicates whether the service supports partial posting, allowing users to post only a subset of edits instead of the entire set. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionManagementServiceCapabilities) */ supportsPartialPost: boolean; /** * Indicates whether the service supports retrieving differences in data from a specific moment in time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionManagementServiceCapabilities) */ supportsDifferencesFromMoment: boolean; /** * Indicates whether the service supports retrieving differences in data between different layers or feature classes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionManagementServiceCapabilities) */ supportsDifferencesWithLayers: boolean; /** * Indicates whether the service supports asynchronous reconcile operations, allowing users to reconcile conflicting edits asynchronously. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionManagementServiceCapabilities) */ supportsAsyncReconcile: boolean; /** * Indicates whether the service supports asynchronous posting of edits, allowing users to post edits asynchronously. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionManagementServiceCapabilities) */ supportsAsyncPost: boolean; /** * Indicates whether the service supports asynchronous retrieval of differences in data, allowing users to retrieve differences asynchronously. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionManagementServiceCapabilities) */ supportsAsyncDifferences: boolean; } export interface VersionManagementServiceCreateVersionProps { /** * The name of the new version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#createVersion) */ versionName: string; /** * The description of the new version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#createVersion) */ description?: string; /** * The access type of the new version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#createVersion) */ access?: "hidden" | "private" | "protected" | "public"; } export interface VersionManagementServiceGetVersionInfosProps { /** * Filter to query versions by owner name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#getVersionInfos) */ ownerFilter: string; /** * Specifies whether to include hidden versions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#getVersionInfos) */ includeHidden: boolean; } export interface VersionManagementServiceReconcileProps { /** * Specifies whether the reconcile should be aborted if conflicts are found. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#reconcile) */ abortIfConflicts: boolean; /** * Specifies the conditions required for conflicts to occur are defined by object (row) or attribute (column). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#reconcile) */ conflictDetection: "by-attribute" | "by-object"; /** * Specifies if post will occur after calling reconcile. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#reconcile) */ withPost: boolean; } export interface VersionInfoExtendedJSONVersionIdentifier { /** * The name of the version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoExtendedJSON) */ name: string; /** * The guid of a version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoExtendedJSON) */ guid: string; } export interface VersionInfoJSONVersionIdentifier { /** * The name of the version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoJSON) */ name: string; /** * The guid of a version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html#VersionInfoJSON) */ guid: string; } export interface Viewpoint extends Accessor, JSONSupport { } export class Viewpoint { /** * The viewpoint camera (3D only). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html#camera) */ camera: Camera; /** * The rotation of due north in relation to the top of the view in degrees. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html#rotation) */ rotation: number; /** * The scale of the viewpoint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html#scale) */ scale: number; /** * The target geometry framed by the viewpoint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html#targetGeometry) */ targetGeometry: Geometry; /** * Describes a point of view for a 2D or 3D view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) */ constructor(properties?: ViewpointProperties); /** * Create a deep clone of the viewpoint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html#clone) */ clone(): Viewpoint; static fromJSON(json: any): Viewpoint; } interface ViewpointProperties { /** * The viewpoint camera (3D only). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html#camera) */ camera?: CameraProperties; /** * The rotation of due north in relation to the top of the view in degrees. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html#rotation) */ rotation?: number; /** * The scale of the viewpoint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html#scale) */ scale?: number; /** * The target geometry framed by the viewpoint. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html#targetGeometry) */ targetGeometry?: GeometryProperties; } export class BaseLayerView2D extends LayerView { /** * The array of [Tile](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#Tile) objects computed to cover the MapView's visible area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#tiles) */ tiles: Tile[]; /** * References the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) this [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) belongs to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#view) */ view: MapView; /** * Represents the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) after it has been added to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) with a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html) */ constructor(properties?: BaseLayerView2DProperties); /** * Method called when after the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) is created and right before it's asked to draw the layer's content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#attach) */ attach(): void; /** * Method called after the layer is removed and the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) is about to be removed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#detach) */ detach(): void; /** * Method to implement that is responsible for providing objects hit at the specified screen coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#hitTest) */ hitTest(mapPoint: Point, screenPoint: ScreenPoint): Promise; /** * The method to implement that is responsible of drawing the content of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#render) */ render(renderParameters: BaseLayerView2DRenderRenderParameters): void; /** * The [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) can call this method to ask the MapView to schedule a new rendering frame. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#requestRender) */ requestRender(): void; /** * Method to implement, which notifies of tiles being added or removed for the current view state. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#tilesChanged) */ tilesChanged(added: Tile[], removed: Tile[]): void; } interface BaseLayerView2DProperties extends LayerViewProperties { /** * The array of [Tile](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#Tile) objects computed to cover the MapView's visible area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#tiles) */ tiles?: Tile[]; /** * References the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) this [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) belongs to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#view) */ view?: MapViewProperties; } export interface BaseLayerView2DRenderRenderParameters { /** * The [canvas 2D context](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D) in which to draw content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#render) */ context: CanvasRenderingContext2D; /** * The stationary state of the `MapView`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#render) */ stationary: boolean; /** * The object that describes view state. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#render) */ state: ViewState; } /** * An object representing a point on the screen. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#ScreenPoint) */ export interface ScreenPoint { /** * The x coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#ScreenPoint) */ x: number; /** * The y coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#ScreenPoint) */ y: number; } /** * Represents a tile reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#Tile) */ export interface Tile { /** * The tile string identifier in the format `level/row/col/world` * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#Tile) */ id: string; /** * The level identifier of the [LOD](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LOD.html) to which the tile belongs * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#Tile) */ level: number; /** * The row identifier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#Tile) */ row: number; /** * The column identifier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#Tile) */ col: number; /** * When the projection allows world wrapping (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#Tile) */ world: number; /** * The number of map units per pixel in the tile. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#Tile) */ resolution: number; /** * The map scale at the tile's level. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#Tile) */ scale: number; /** * The coordinates of the top-left corner of the tile as an array of two numbers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#Tile) */ coords: number[]; /** * The bounds of the tile as an array of four numbers that be readily converted to an [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#Tile) */ bounds: number[]; } export class BaseLayerViewGL2D extends LayerView { /** * The WebGL rendering context associated to this layer view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#context) */ context: any; /** * The array of module:esri/views/2d/layers/BaseLayerViewGL2D#Tile objects computed to cover the MapView's visible area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#tiles) */ tiles: BaseLayerViewGL2DTile[]; /** * References the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) this [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) belongs to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#view) */ view: MapView; /** * Represents the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) after it has been added to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) with a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html) */ constructor(properties?: BaseLayerViewGL2DProperties); /** * Method called after the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) is created and right before it starts drawing the layer's content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#attach) */ attach(): void; /** * Bind the designated rendering output surface and restore the correct viewport. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#bindRenderTarget) */ bindRenderTarget(): void; /** * Method called after the layer is removed and the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) is about to be removed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#detach) */ detach(): void; /** * Get the designated rendering output surface and corresponding viewport configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#getRenderTarget) */ getRenderTarget(): RenderTarget; /** * Method to implement that is responsible for providing objects hit at the specified screen coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#hitTest) */ hitTest(mapPoint: Point, screenPoint: BaseLayerViewGL2DScreenPoint): Promise; /** * The method to implement that is responsible of drawing the content of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#render) */ render(renderParameters: BaseLayerViewGL2DRenderRenderParameters): void; /** * The [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) can call this method to ask the MapView to schedule a new rendering frame. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#requestRender) */ requestRender(): void; /** * Tessellate an [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) into a rectangle. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#tessellateExtent) */ tessellateExtent(extent: Extent): Promise; /** * Tessellate a [Multipoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html) into quads (markers). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#tessellateMultipoint) */ tessellateMultipoint(multipoint: Multipoint, footprint: Rect): Promise; /** * Tessellate a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) into a quad (marker). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#tessellatePoint) */ tessellatePoint(point: Point, footprint: Rect): Promise; /** * Tessellate a [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) into triangles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#tessellatePolygon) */ tessellatePolygon(polygon: Polygon): Promise; /** * Tessellate a [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) into triangles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#tessellatePolyline) */ tessellatePolyline(polyline: Polyline, width: number): Promise; /** * Method to implement, which notifies of tiles being added or removed for the current view state. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#tilesChanged) */ tilesChanged(added: BaseLayerViewGL2DTile[], removed: BaseLayerViewGL2DTile[]): void; } interface BaseLayerViewGL2DProperties extends LayerViewProperties { /** * The WebGL rendering context associated to this layer view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#context) */ context?: any; /** * The array of module:esri/views/2d/layers/BaseLayerViewGL2D#Tile objects computed to cover the MapView's visible area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#tiles) */ tiles?: BaseLayerViewGL2DTile[]; /** * References the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) this [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) belongs to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#view) */ view?: MapViewProperties; } export interface BaseLayerViewGL2DRenderRenderParameters { /** * The WebGL or WebGL 2 context. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#render) */ context: any; /** * The stationary state of the `MapView`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#render) */ stationary: boolean; /** * The object that describes view state. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#render) */ state: ViewState; } /** * A vertex of a tessellated mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#MeshVertex) */ export interface MeshVertex { /** * The `x`-coordinate, expressed in the same units as the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#MeshVertex) */ x: number; /** * The `y`-coordinate, expressed in the same units as the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#MeshVertex) */ y: number; /** * The `x`-offset in screen space; this is used to extrude points (into quads) and polylines, and is 0 for polygons. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#MeshVertex) */ xOffset: number; /** * The `y`-offset in screen space; this is used to extrude points (into quads) and polylines, and is 0 for polygons. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#MeshVertex) */ yOffset: number; /** * The `u`-coordinate for texture mapping. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#MeshVertex) */ uTexcoord: number; /** * The `v`-coordinate for texture mapping. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#MeshVertex) */ vTexcoord: number; /** * The distance parameter for this vertex; this only applies when tessellating polylines. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#MeshVertex) */ distance: number; } /** * A rectangle in screen-space. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#Rect) */ export interface Rect { /** * The `x`-coordinate of the upper-left corner of the rectangle, relative to the anchor of the marker. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#Rect) */ x: number; /** * The `y`-coordinate of the upper-left corner of the rectangle, relative to the anchor of the marker. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#Rect) */ y: number; /** * Width of the rectangle. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#Rect) */ width: number; /** * Height of the rectangle. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#Rect) */ height: number; } /** * The destination to which [render()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#render) should direct its output. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#RenderTarget) */ export interface RenderTarget { /** * The framebuffer where the [render()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#render) method should direct its output. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#RenderTarget) */ framebuffer: any; /** * A viewport that fully covers `framebuffer`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#RenderTarget) */ viewport: number[]; } /** * An object representing a point on the screen. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#ScreenPoint) */ export interface BaseLayerViewGL2DScreenPoint { /** * The x coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#ScreenPoint) */ x: number; /** * The y coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#ScreenPoint) */ y: number; } /** * The triangle mesh resulting from a tessellation operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#TessellatedMesh) */ export interface TessellatedMesh { /** * The vertices that make up the mesh. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#TessellatedMesh) */ vertices: MeshVertex[]; /** * The indices of the triangles that connect vertices together; each consecutive triplet of indices denotes a triangle. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#TessellatedMesh) */ indices: number[]; } /** * Represents a tile reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#Tile) */ export interface BaseLayerViewGL2DTile { /** * The tile string identifier in the format `level/row/col/world` * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#Tile) */ id: string; /** * The level identifier of the [LOD](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LOD.html) to which the tile belongs * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#Tile) */ level: number; /** * The row identifier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#Tile) */ row: number; /** * The column identifier. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#Tile) */ col: number; /** * When the projection allows world wrapping (e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#Tile) */ world: number; /** * The number of map units per pixel in the tile. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#Tile) */ resolution: number; /** * The map scale at the tile's level. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#Tile) */ scale: number; /** * The coordinates of the top-left corner of the tile as an array of two numbers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#Tile) */ coords: number[]; /** * The bounds of the tile as an array of four numbers that be readily converted to an [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerViewGL2D.html#Tile) */ bounds: number[]; } export interface ViewState extends Accessor, JSONSupport { } export class ViewState { /** * Represents the view's center point as an array of two numbers `[x, y]`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#center) */ readonly center: number[]; /** * The extent represents the visible portion of a map within the view as an instance of Extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#extent) */ readonly extent: Extent; /** * Represents the size of one pixel in map units. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#resolution) */ readonly resolution: number; /** * The clockwise rotation of due north in relation to the top of the view in degrees. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#rotation) */ readonly rotation: number; /** * Represents the map scale at the center of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#scale) */ readonly scale: number; /** * Represents the width and height of the view in pixels, e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#size) */ readonly size: number[]; /** * Object that holds information about the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) state. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html) */ constructor(properties?: ViewStateProperties); /** * Creates a deep clone of ViewState object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#clone) */ clone(): ViewState; /** * Copies the properties from a given view state. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#copy) */ copy(state: ViewState): ViewState; /** * Converts the x and y screen coordinates to map coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#toMap) */ toMap(out: number[], x: number, y: number): number[]; /** * Converts the x and y map coordinates to screen coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#toScreen) */ toScreen(out: number[], x: number, y: number): number[]; /** * Converts the x and y map coordinates to screen coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#toScreenClosest) */ toScreenClosest(out: number[], x: number, y: number): number[]; /** * Converts the x and y map coordinates to screen coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#toScreenNoRotation) */ toScreenNoRotation(out: number[], x: number, y: number): number[]; static fromJSON(json: any): ViewState; } interface ViewStateProperties { } export class AreaMeasurementAnalysisView3D { /** * The area measurement analysis object associated with the analysis view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-AreaMeasurementAnalysisView3D.html#analysis) */ readonly analysis: AreaMeasurementAnalysis; /** * Result of the area measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-AreaMeasurementAnalysisView3D.html#result) */ result: AreaMeasurementAnalysisResult; /** * The analysis view type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-AreaMeasurementAnalysisView3D.html#type) */ readonly type: "area-measurement-view-3d"; /** * When `true`, the analysis is visualized in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-AreaMeasurementAnalysisView3D.html#visible) */ visible: boolean; constructor(properties?: any); } /** * Result obtained from an [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-AreaMeasurementAnalysis.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-AreaMeasurementAnalysisView3D.html#AreaMeasurementAnalysisResult) */ export interface AreaMeasurementAnalysisResult { /** * Describes the mode in which the measurement is computed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-AreaMeasurementAnalysisView3D.html#AreaMeasurementAnalysisResult) */ mode: "euclidean" | "geodesic"; /** * Area of the polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-AreaMeasurementAnalysisView3D.html#AreaMeasurementAnalysisResult) */ area: Area; /** * Perimeter length of the polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-AreaMeasurementAnalysisView3D.html#AreaMeasurementAnalysisResult) */ pathLength: Length; } export class DirectLineMeasurementAnalysisView3D { /** * The direct line measurement analysis object associated with the analysis view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-DirectLineMeasurementAnalysisView3D.html#analysis) */ readonly analysis: DirectLineMeasurementAnalysis; /** * Result of the direct line measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-DirectLineMeasurementAnalysisView3D.html#result) */ result: DirectLineMeasurementAnalysisResult; /** * The analysis view type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-DirectLineMeasurementAnalysisView3D.html#type) */ readonly type: "direct-line-measurement-view-3d"; /** * When `true`, the analysis is visualized in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-DirectLineMeasurementAnalysisView3D.html#visible) */ visible: boolean; constructor(properties?: any); } /** * Result obtained from a [DirectLineMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-DirectLineMeasurementAnalysisView3D.html#DirectLineMeasurementAnalysisResult) */ export interface DirectLineMeasurementAnalysisResult { /** * Describes how the `horizontalDistance` is computed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-DirectLineMeasurementAnalysisView3D.html#DirectLineMeasurementAnalysisResult) */ mode: "euclidean" | "geodesic"; /** * DEPRECATED since 4.29: Use `directDistance` and `horizontalDistance` - Measured distance between the start and end points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-DirectLineMeasurementAnalysisView3D.html#DirectLineMeasurementAnalysisResult) */ distance: Length; /** * The 3D distance between the two points that is computed in a Euclidean manner. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-DirectLineMeasurementAnalysisView3D.html#DirectLineMeasurementAnalysisResult) */ directDistance: Length; /** * The 2D distance between the two points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-DirectLineMeasurementAnalysisView3D.html#DirectLineMeasurementAnalysisResult) */ horizontalDistance: Length; /** * The elevation difference between the two points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-DirectLineMeasurementAnalysisView3D.html#DirectLineMeasurementAnalysisResult) */ verticalDistance: Length; } export class LineOfSightAnalysisResult { /** * The first [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) intersected by the line of sight. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-LineOfSightAnalysisResult.html#intersectedGraphic) */ readonly intersectedGraphic: Graphic; /** * A [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing the location where the line of sight first intersects the ground or 3D objects in the scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-LineOfSightAnalysisResult.html#intersectedLocation) */ readonly intersectedLocation: Point; /** * Represents a target in a [LineOfSightAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html) which is used to calculate the visibility from the [LineOfSightAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html#observer). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-LineOfSightAnalysisResult.html#target) */ target: LineOfSightAnalysisTarget; /** * Whether the target is visible from the observer or not. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-LineOfSightAnalysisResult.html#visible) */ readonly visible: boolean; constructor(properties?: any); } export class LineOfSightAnalysisView3D { /** * The line of sight analysis object associated with the analysis view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-LineOfSightAnalysisView3D.html#analysis) */ readonly analysis: LineOfSightAnalysis; /** * Set to `true` to enable interactivity for the associated [LineOfSightAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-LineOfSightAnalysisView3D.html#interactive) */ interactive: boolean; /** * Analysis results for each target. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-LineOfSightAnalysisView3D.html#results) */ readonly results: Collection; /** * The analysis view type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-LineOfSightAnalysisView3D.html#type) */ readonly type: "line-of-sight-view-3d"; /** * When `true`, the [analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-LineOfSightAnalysisView3D.html#analysis) is visualized in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-LineOfSightAnalysisView3D.html#visible) */ visible: boolean; constructor(properties?: any); } export class SliceAnalysisView3D { /** * Only one [SliceAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html) at a time can be active in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-SliceAnalysisView3D.html#active) */ active: boolean; /** * The direct line measurement analysis object associated with the analysis view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-SliceAnalysisView3D.html#analysis) */ readonly analysis: SliceAnalysis; /** * Set to `true` to enable interactivity for the associated [SliceAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-SliceAnalysisView3D.html#interactive) */ interactive: boolean; readonly type: "slice-view-3d"; /** * When `true`, the analysis is visualized in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-SliceAnalysisView3D.html#visible) */ visible: boolean; constructor(properties?: any); } export class CloudyWeather extends Accessor { /** * Specifies the amount of cloud cover in the sky for a certain weather type. * * @default 0.5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-CloudyWeather.html#cloudCover) */ cloudCover: number; /** * The type of weather * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-CloudyWeather.html#type) */ readonly type: "cloudy"; /** * The CloudyWeather class allows you to change the weather conditions in the scene to cloudy weather. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-CloudyWeather.html) */ constructor(properties?: CloudyWeatherProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-CloudyWeather.html#clone) */ clone(): CloudyWeather; } interface CloudyWeatherProperties { /** * Specifies the amount of cloud cover in the sky for a certain weather type. * * @default 0.5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-CloudyWeather.html#cloudCover) */ cloudCover?: number; } export class FoggyWeather extends Accessor { /** * Specifies the amount of fog used in the scene. * * @default 0.5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-FoggyWeather.html#fogStrength) */ fogStrength: number; /** * The type of Weather * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-FoggyWeather.html#type) */ readonly type: "foggy"; /** * The FoggyWeather class allows you to change the weather conditions in the scene to foggy weather. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-FoggyWeather.html) */ constructor(properties?: FoggyWeatherProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-FoggyWeather.html#clone) */ clone(): FoggyWeather; } interface FoggyWeatherProperties { /** * Specifies the amount of fog used in the scene. * * @default 0.5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-FoggyWeather.html#fogStrength) */ fogStrength?: number; } export class RainyWeather extends Accessor { /** * Specifies the amount of cloud cover in the sky for a certain weather type. * * @default 0.5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html#cloudCover) */ cloudCover: number; /** * Specifies the amount of falling rain. * * @default 0.5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html#precipitation) */ precipitation: number; /** * The type of Weather * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html#type) */ readonly type: "rainy"; /** * The RainyWeather class allows you to change the weather conditions in the scene to rainy weather. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html) */ constructor(properties?: RainyWeatherProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html#clone) */ clone(): RainyWeather; } interface RainyWeatherProperties { /** * Specifies the amount of cloud cover in the sky for a certain weather type. * * @default 0.5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html#cloudCover) */ cloudCover?: number; /** * Specifies the amount of falling rain. * * @default 0.5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html#precipitation) */ precipitation?: number; } export class SnowyWeather extends Accessor { /** * Specifies the amount of cloud cover in the sky for a certain weather type. * * @default 0.5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html#cloudCover) */ cloudCover: number; /** * Specifies the amount of falling snow. * * @default 0.5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html#precipitation) */ precipitation: number; /** * Display surfaces covered with snow. * * @default "disabled" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html#snowCover) */ snowCover: "enabled" | "disabled"; /** * The type of Weather * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html#type) */ readonly type: "snowy"; /** * The SnowyWeather class allows you to change the weather conditions in the scene to snowy weather. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html) */ constructor(properties?: SnowyWeatherProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html#clone) */ clone(): SnowyWeather; } interface SnowyWeatherProperties { /** * Specifies the amount of cloud cover in the sky for a certain weather type. * * @default 0.5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html#cloudCover) */ cloudCover?: number; /** * Specifies the amount of falling snow. * * @default 0.5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html#precipitation) */ precipitation?: number; /** * Display surfaces covered with snow. * * @default "disabled" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html#snowCover) */ snowCover?: "enabled" | "disabled"; } export class SunLighting extends websceneSunLighting { /** * Indicates whether to show ambient occlusion shading. * * @default false * @deprecated since version 4.27. Ambient occlusion is automatically shown and this property has no effect. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html#ambientOcclusionEnabled) */ ambientOcclusionEnabled: boolean; /** * Indicates whether the date and time of the simulated sun is automatically updated to maintain the current time of day while the camera changes. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html#cameraTrackingEnabled) */ cameraTrackingEnabled: boolean; /** * Indicates whether [WaterSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WaterSymbol3DLayer.html) display reflections of surrounding terrain, buildings and other 3D objects. * * @default false * @deprecated since version 4.27. Reflections are automatically shown and this property has no effect. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html#waterReflectionEnabled) */ waterReflectionEnabled: boolean; /** * The SunLighting class allows you to change the lighting in the scene to sunlight. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html) */ constructor(properties?: SunLightingProperties); /** * Create a clone of this while partially applying the provided webscene lighting settings. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html#cloneWithWebsceneLighting) */ cloneWithWebsceneLighting(): void; } interface SunLightingProperties extends websceneSunLightingProperties { /** * Indicates whether to show ambient occlusion shading. * * @default false * @deprecated since version 4.27. Ambient occlusion is automatically shown and this property has no effect. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html#ambientOcclusionEnabled) */ ambientOcclusionEnabled?: boolean; /** * Indicates whether the date and time of the simulated sun is automatically updated to maintain the current time of day while the camera changes. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html#cameraTrackingEnabled) */ cameraTrackingEnabled?: boolean; /** * Indicates whether [WaterSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WaterSymbol3DLayer.html) display reflections of surrounding terrain, buildings and other 3D objects. * * @default false * @deprecated since version 4.27. Reflections are automatically shown and this property has no effect. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html#waterReflectionEnabled) */ waterReflectionEnabled?: boolean; } export class SunnyWeather extends Accessor { /** * Specifies the amount of cloud cover in the sky for a certain weather type. * * @default 0.5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunnyWeather.html#cloudCover) */ cloudCover: number; /** * The type of weather * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunnyWeather.html#type) */ readonly type: "sunny"; /** * The SunnyWeather class allows you to change the weather conditions in the scene to sunny weather. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunnyWeather.html) */ constructor(properties?: SunnyWeatherProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunnyWeather.html#clone) */ clone(): SunnyWeather; } interface SunnyWeatherProperties { /** * Specifies the amount of cloud cover in the sky for a certain weather type. * * @default 0.5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunnyWeather.html#cloudCover) */ cloudCover?: number; } export class VirtualLighting extends websceneVirtualLighting { /** * Indicates whether to show ambient occlusion shading. * * @default false * @deprecated since version 4.27. Ambient occlusion is automatically shown and this property has no effect. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html#ambientOcclusionEnabled) */ ambientOcclusionEnabled: boolean; /** * Indicates whether [WaterSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WaterSymbol3DLayer.html) display reflections of surrounding terrain, buildings and other 3D objects. * * @default false * @deprecated since version 4.27. Reflections are automatically shown and this property has no effect. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html#waterReflectionEnabled) */ waterReflectionEnabled: boolean; /** * The VirtualLighting class allows you to change the lighting in the scene to virtual light. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html) */ constructor(properties?: VirtualLightingProperties); /** * Create a clone of this while partially applying the provided webscene lighting settings. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html#cloneWithWebsceneLighting) */ cloneWithWebsceneLighting(): void; } interface VirtualLightingProperties extends websceneVirtualLightingProperties { /** * Indicates whether to show ambient occlusion shading. * * @default false * @deprecated since version 4.27. Ambient occlusion is automatically shown and this property has no effect. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html#ambientOcclusionEnabled) */ ambientOcclusionEnabled?: boolean; /** * Indicates whether [WaterSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WaterSymbol3DLayer.html) display reflections of surrounding terrain, buildings and other 3D objects. * * @default false * @deprecated since version 4.27. Reflections are automatically shown and this property has no effect. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html#waterReflectionEnabled) */ waterReflectionEnabled?: boolean; } /** * render the map/scene on screen. * * @deprecated since 4.29. Use the new {@link module:esri/views/3d/webgl/RenderNode RenderNode} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html) */ interface externalRenderers { add(view: SceneView, renderer: ExternalRenderer): void; fromRenderCoordinates(): void; getRenderCamera(): RenderCamera; remove(view: SceneView, renderer: ExternalRenderer): void; renderCoordinateTransformAt(): void; requestRender(): void; toRenderCoordinates(): void; } export const externalRenderers: externalRenderers; /** * Defines an external renderer using callbacks and properties. * * @deprecated since 4.29. Use new {@link module:esri/views/3d/webgl/RenderNode RenderNode} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#ExternalRenderer) */ export interface ExternalRenderer { /** * Typically called once after adding the external renderer to a view, or whenever the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) becomes [ready](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#ready). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#ExternalRenderer) */ setup?: RenderContextCallback; /** * Called in every frame to execute the state update and draw calls. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#ExternalRenderer) */ render?: RenderContextCallback; /** * Called when the external renderer is removed from a view, or when the [ready](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#ready) state of the view turns false. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#ExternalRenderer) */ dispose?: RenderContextCallback; } /** * The object passed as a parameter to every call to `setup` and `render` the external renderer. * * @deprecated since 4.29. Use new {@link module:esri/views/3d/webgl/RenderNode RenderNode} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderContext) */ export interface RenderContext { /** * The WebGL rendering context. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderContext) */ gl: any; /** * The camera used to render the current frame. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderContext) */ camera: RenderCamera; /** * The lighting used by [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) to render the current frame. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderContext) */ sunLight: SunLight; /** * A convenience function provided to completely reset the WebGL state after using it. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderContext) */ resetWebGLState(): void; /** * Binds the color and depth buffers an external renderer is supposed to render into. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderContext) */ bindRenderTarget(): void; } export type RenderContextCallback = (context?: RenderContext) => void; /** * This class contains performance information like memory usage and number of features for a specific layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-support-LayerPerformanceInfo.html) */ interface LayerPerformanceInfo { /** * The number of features displayed in the SceneView. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-support-LayerPerformanceInfo.html#displayedNumberOfFeatures) */ displayedNumberOfFeatures: number; /** * The layer corresponding to the memory usage information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-support-LayerPerformanceInfo.html#layer) */ layer: Layer; /** * The maximum number of features that can be displayed in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-support-LayerPerformanceInfo.html#maximumNumberOfFeatures) */ maximumNumberOfFeatures: number; /** * An estimate of the memory currently in use by the layer, in bytes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-support-LayerPerformanceInfo.html#memory) */ memory: number; /** * The total number of features contained in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-support-LayerPerformanceInfo.html#totalNumberOfFeatures) */ totalNumberOfFeatures: number; } export const LayerPerformanceInfo: LayerPerformanceInfo; /** * This class contains information about performance in the scene like global memory usage and additional details for layers about memory consumption and number of features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-support-SceneViewPerformanceInfo.html) */ interface SceneViewPerformanceInfo { /** * An estimate of the memory used by the [Edges3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-Edges3D.html) feature when added to 3D objects in [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) or to polygons with [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html) symbols. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-support-SceneViewPerformanceInfo.html#edgesMemory) */ edgesMemory: number; /** * An array representing detailed information about memory usage of most layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-support-SceneViewPerformanceInfo.html#layerPerformanceInfos) */ layerPerformanceInfos: LayerPerformanceInfo[]; /** * Quality level as a number between 0 and 1. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-support-SceneViewPerformanceInfo.html#quality) */ quality: number; /** * An estimate of the memory currently in use by [ElevationLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html) and [tiled layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html), in bytes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-support-SceneViewPerformanceInfo.html#terrainMemory) */ terrainMemory: number; /** * The total memory available to the SceneView, in bytes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-support-SceneViewPerformanceInfo.html#totalMemory) */ totalMemory: number; /** * An estimate of the memory that is in use by the SceneView, in bytes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-support-SceneViewPerformanceInfo.html#usedMemory) */ usedMemory: number; } export const SceneViewPerformanceInfo: SceneViewPerformanceInfo; /** * A convenience module for importing [RenderNode](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html) classes when developing with [TypeScript](https://developers.arcgis.com/javascript/latest/typescript-setup/). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl.html) */ interface webgl { /** * Transforms positions from the internal rendering coordinate system to the output spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl.html#fromRenderCoordinates) */ fromRenderCoordinates(__0: SceneView, srcCoordinates: number[] | Float32Array | Float64Array, srcStart: number, destCoordinates: number[] | Float32Array | Float64Array, destStart: number, destSpatialReference: SpatialReference, count: number): number[] | Float32Array | Float64Array; /** * Computes a 4x4 affine transformation matrix that constitutes a linear coordinate transformation from a local Cartesian coordinate system to the virtual world coordinate system. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl.html#renderCoordinateTransformAt) */ renderCoordinateTransformAt(__0: SceneView, origin: number[] | Float32Array | Float64Array, srcSpatialReference?: SpatialReference, dest?: number[] | Float32Array): number[] | Float32Array; /** * Transforms positions from the given spatial reference to the internal rendering coordinate system. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl.html#toRenderCoordinates) */ toRenderCoordinates(__0: SceneView, srcCoordinates: number[] | Float32Array | Float64Array, srcStart: number, srcSpatialReference: SpatialReference, destCoordinates: number[] | Float32Array | Float64Array, destStart: number, count: number): number[] | Float32Array | Float64Array; } export const webgl: webgl; /** * ManagedFBO is an interface to represent a framebuffer object resource of the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-ManagedFBO.html) */ interface ManagedFBO { /** * The name of the managed fbo target * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-ManagedFBO.html#name) */ readonly name: RenderNodeInput; /** * Acquire and attach a new color texture to this framebuffer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-ManagedFBO.html#acquireColor) */ acquireColor(attachment: ColorAttachment): ManagedFBO; /** * Acquire and attach a new depth buffer texture to this framebuffer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-ManagedFBO.html#acquireDepth) */ acquireDepth(): ManagedFBO; /** * Attach a color buffer texture to this framebuffer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-ManagedFBO.html#attachColor) */ attachColor(color: ManagedColorAttachment, attachment: ColorAttachment): ManagedFBO; /** * Attach a depth buffer texture to this framebuffer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-ManagedFBO.html#attachDepth) */ attachDepth(depth: ManagedDepthAttachment): ManagedFBO; /** * Returns a managed color attachment linked to this framebuffer object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-ManagedFBO.html#getAttachment) */ getAttachment(attachment?: ColorAttachment | DepthAttachment): ManagedColorAttachment | ManagedDepthAttachment; /** * Return the texture for a given color or depth attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-ManagedFBO.html#getTexture) */ getTexture(attachment?: ColorAttachment | DepthAttachment): FBOTexture; /** * Release this managed framebuffer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-ManagedFBO.html#release) */ release(): void; /** * Increase reference counting on this managed framebuffer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-ManagedFBO.html#retain) */ retain(): void; } export const ManagedFBO: ManagedFBO; /** * Describes a color attachment point of WebGL2. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-ManagedFBO.html#ColorAttachment) */ export interface ColorAttachment { } /** * Describes a depth attachment point of WebGL2. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-ManagedFBO.html#DepthAttachment) */ export interface DepthAttachment { } /** * Encapsulates a WebGL texture. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-ManagedFBO.html#FBOTexture) */ export interface FBOTexture { /** * the WebGL name content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-ManagedFBO.html#FBOTexture) */ glName: string; } /** * Describes a single attachment of a managed framebuffer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-ManagedFBO.html#ManagedColorAttachment) */ export interface ManagedColorAttachment { /** * Increase reference counting on this managed attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-ManagedFBO.html#ManagedColorAttachment) */ retain(): void; /** * Release this managed attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-ManagedFBO.html#ManagedColorAttachment) */ release(): void; } /** * Describes the depth attachment of a managed framebuffer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-ManagedFBO.html#ManagedDepthAttachment) */ export interface ManagedDepthAttachment { /** * Increase reference counting on this managed attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-ManagedFBO.html#ManagedDepthAttachment) */ retain(): void; /** * Release this managed attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-ManagedFBO.html#ManagedDepthAttachment) */ release(): void; } export class RenderNode extends Accessor { /** * Get the render representation of the current camera of a view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#camera) */ camera: RenderCamera; /** * Declare which inputs are needed from the engine for rendering. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#consumes) */ consumes: ConsumedNodes; /** * Returns the current WebGL2RenderingContext instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#gl) */ gl: any; /** * Define the output produced by the render function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#produces) */ produces: RenderNodeOutput; /** * The lighting used by [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) to render the current frame. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#sunLight) */ sunLight: SunLight; /** * The SceneView linked to this render node. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#view) */ view: SceneView; /** * The RenderNode provides low level access to the render pipeline of the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) to create custom visualizations and effects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html) */ constructor(properties?: RenderNodeProperties); /** * Acquires and binds a managed framebuffer object to be written to and returned by the render function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#acquireOutputFramebuffer) */ acquireOutputFramebuffer(): ManagedFBO; /** * Bind the color and depth buffers to render into and return the ManagedFBO. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#bindRenderTarget) */ bindRenderTarget(): ManagedFBO; /** * The render function is called whenever a frame is rendered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#render) */ render(inputs: ManagedFBO[]): ManagedFBO; /** * Request the SceneView to be redrawn. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#requestRender) */ requestRender(): void; /** * Reset WebGL to a well-defined state. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#resetWebGLState) */ resetWebGLState(): void; } interface RenderNodeProperties { /** * Get the render representation of the current camera of a view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#camera) */ camera?: RenderCamera; /** * Declare which inputs are needed from the engine for rendering. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#consumes) */ consumes?: ConsumedNodes; /** * Returns the current WebGL2RenderingContext instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#gl) */ gl?: any; /** * Define the output produced by the render function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#produces) */ produces?: "composite-color" | "opaque-color" | "transparent-color"; /** * The lighting used by [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) to render the current frame. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#sunLight) */ sunLight?: SunLight; /** * The SceneView linked to this render node. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#view) */ view?: SceneViewProperties; } /** * Tuple of an RGB color value and an intensity value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#ColorAndIntensity) */ export interface ColorAndIntensity { /** * RGB color with values between 0 and 1. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#ColorAndIntensity) */ color: ArrayLike; /** * Scalar intensity value by which the color should be scaled for compositing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#ColorAndIntensity) */ intensity: number; } /** * Describes the lighting used by [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html), derived from its sun lighting model. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#SunLight) */ export interface SunLight { /** * The incident light direction in render coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#SunLight) */ direction: ArrayLike; /** * The diffuse light color and intensity. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#SunLight) */ diffuse: ColorAndIntensity; /** * The ambient light color and intensity. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl-RenderNode.html#SunLight) */ ambient: ColorAndIntensity; } /** * Describes the input framebuffer objects of a custom RenderNode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl.html#ConsumedNodes) */ export interface ConsumedNodes { /** * One or more required inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl.html#ConsumedNodes) */ required: RenderNodeInput[]; /** * One or more optional inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl.html#ConsumedNodes) */ optional?: RenderNodeInput[]; } /** * The camera object passed to render function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl.html#RenderCamera) */ export interface RenderCamera { /** * A 4x4 matrix that transforms coordinates from world space to camera space. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl.html#RenderCamera) */ viewMatrix: ArrayLike; /** * The inverse transpose of `viewMatrix`, used to transform normals from world space to camera space. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl.html#RenderCamera) */ viewInverseTransposeMatrix: ArrayLike; /** * A 4x4 matrix that defines the perspective projection transformation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl.html#RenderCamera) */ projectionMatrix: ArrayLike; /** * The position of the camera in the internal Cartesian rendering coordinate system. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl.html#RenderCamera) */ eye: ArrayLike; /** * The camera target ("look at") position in the internal Cartesian rendering coordinate system. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl.html#RenderCamera) */ center: ArrayLike; /** * The camera up vector. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl.html#RenderCamera) */ up: ArrayLike; /** * The distance to the near plane. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl.html#RenderCamera) */ near: number; /** * The distance to the far plane. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl.html#RenderCamera) */ far: number; /** * The horizontal field of view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl.html#RenderCamera) */ fovX: number; /** * The vertical field of view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl.html#RenderCamera) */ fovY: number; /** * The render pixel ratio. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl.html#RenderCamera) */ pixelRatio: number; /** * The viewport (x, y, width, height). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl.html#RenderCamera) */ viewport: any; } /** * Describes a specific RenderNodeInput. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl.html#RenderNodeInput) */ export type RenderNodeInput = "composite-color" | "opaque-color" | "transparent-color" | "normals" | "highlights"; /** * Describes a specific RenderNodeOutput. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-webgl.html#RenderNodeOutput) */ export type RenderNodeOutput = "composite-color" | "opaque-color" | "transparent-color"; export class DimensionAnalysisView extends Accessor { /** * The dimension analysis object associated with the analysis view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-analysis-DimensionAnalysisView.html#analysis) */ readonly analysis: DimensionAnalysis; /** * Set to `true` to enable interactivity for the [analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-analysis-DimensionAnalysisView.html#analysis). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-analysis-DimensionAnalysisView.html#interactive) */ interactive: boolean; /** * Results for each dimension in the [analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-analysis-DimensionAnalysisView.html#analysis). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-analysis-DimensionAnalysisView.html#results) */ readonly results: Collection; /** * The selected dimension. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-analysis-DimensionAnalysisView.html#selectedDimension) */ selectedDimension: LengthDimension; /** * When `true`, the [analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-analysis-DimensionAnalysisView.html#analysis) is visualized in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-analysis-DimensionAnalysisView.html#visible) */ visible: boolean; /** * Represents the analysis view of a [DimensionAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DimensionAnalysis.html) after it has been added to [SceneView.analyses](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#analyses). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-analysis-DimensionAnalysisView.html) */ constructor(properties?: DimensionAnalysisViewProperties); /** * Starts the interactive creation of new dimensions and adds them to the [analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-analysis-DimensionAnalysisView.html#analysis). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-analysis-DimensionAnalysisView.html#createLengthDimensions) */ createLengthDimensions(options?: DimensionAnalysisViewCreateLengthDimensionsOptions): Promise; } interface DimensionAnalysisViewProperties { /** * Set to `true` to enable interactivity for the [analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-analysis-DimensionAnalysisView.html#analysis). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-analysis-DimensionAnalysisView.html#interactive) */ interactive?: boolean; /** * The selected dimension. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-analysis-DimensionAnalysisView.html#selectedDimension) */ selectedDimension?: LengthDimensionProperties; /** * When `true`, the [analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-analysis-DimensionAnalysisView.html#analysis) is visualized in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-analysis-DimensionAnalysisView.html#visible) */ visible?: boolean; } export interface DimensionAnalysisViewCreateLengthDimensionsOptions { /** * Abort signal which can be used to cancel creation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-analysis-DimensionAnalysisView.html#createLengthDimensions) */ signal?: AbortSignal; } /** * Represents the result of a LengthDimension. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-analysis-LengthDimensionResult.html) */ interface LengthDimensionResult { /** * The [LengthDimension](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html) that this result corresponds to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-analysis-LengthDimensionResult.html#dimension) */ dimension: LengthDimension; /** * The length currently being measured by the [dimension](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-analysis-LengthDimensionResult.html#dimension). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-analysis-LengthDimensionResult.html#length) */ length: Length; } export const LengthDimensionResult: LengthDimensionResult; export class BasemapView extends Accessor { /** * A collection containing a hierarchical list of all the created [LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of the base layers in the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BasemapView.html#baseLayerViews) */ readonly baseLayerViews: Collection; /** * A collection containing a hierarchical list of all the created [LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of the reference layers in the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BasemapView.html#referenceLayerViews) */ readonly referenceLayerViews: Collection; /** * Value is `true` when the basemap is updating; for example, if it is in the process of fetching data. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BasemapView.html#updating) */ readonly updating: boolean; /** * References the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BasemapView.html#view) */ view: MapView | SceneView; /** * Represents the view for a single basemap after it has been added to either a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BasemapView.html) */ constructor(properties?: BasemapViewProperties); } interface BasemapViewProperties { /** * References the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BasemapView.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } export class BreakpointsOwner { /** * A convenience property used for defining the breakpoints on the [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height) and [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) */ breakpoints: BreakpointsOwnerBreakpoints; /** * A convenience property indicating the general size of the view's height. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint) */ heightBreakpoint: "xsmall" | "small" | "medium" | "large" | "xlarge"; /** * A convenience property indicating the view's orientation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#orientation) */ readonly orientation: "landscape" | "portrait"; /** * A convenience property indicating the general size of the view's width. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) */ widthBreakpoint: "xsmall" | "small" | "medium" | "large" | "xlarge"; } interface BreakpointsOwnerProperties { /** * A convenience property used for defining the breakpoints on the [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height) and [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) */ breakpoints?: BreakpointsOwnerBreakpoints; /** * A convenience property indicating the general size of the view's height. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint) */ heightBreakpoint?: "xsmall" | "small" | "medium" | "large" | "xlarge"; /** * A convenience property indicating the general size of the view's width. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) */ widthBreakpoint?: "xsmall" | "small" | "medium" | "large" | "xlarge"; } export interface BreakpointsOwnerBreakpoints { /** * Sets the `xsmall` breakpoint in pixels used by [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) and [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint). * * @default 544 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) */ xsmall?: number; /** * Sets the `small` breakpoint in pixels used by [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) and [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint). * * @default 768 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) */ small?: number; /** * Sets the `medium` breakpoint in pixels used by [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) and [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint). * * @default 992 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) */ medium?: number; /** * Sets the `large` breakpoint in pixels used by [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) and [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint). * * @default 1200 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) */ large?: number; /** * Sets the `xlarge` breakpoint in pixels used by [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) and [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) */ xlarge?: number; } export class DOMContainer { /** * The `id` or node representing the DOM element containing the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#container) */ container: HTMLDivElement; /** * Indicates if the browser focus is on the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#focused) */ readonly focused: boolean; /** * The height of the view in pixels read from the view container element. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#height) */ readonly height: number; /** * Indicates if the view is being resized. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#resizing) */ readonly resizing: boolean; /** * An array containing the width and height of the view in pixels, e.g. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#size) */ readonly size: number[]; /** * Indicates if the view is visible on the page. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#suspended) */ readonly suspended: boolean; /** * Exposes the default widgets available in the view and allows you to toggle them on and off. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#ui) */ ui: DefaultUI; /** * The width of the view in pixels read from the view container element. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#width) */ readonly width: number; } interface DOMContainerProperties { /** * The `id` or node representing the DOM element containing the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#container) */ container?: HTMLDivElement | string; /** * Exposes the default widgets available in the view and allows you to toggle them on and off. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#ui) */ ui?: DefaultUIProperties; } export class Draw extends Accessor { /** * A reference to the active [draw action](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-Draw.html#activeAction) */ activeAction: DrawAction; /** * The view in which geometries will be drawn by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-Draw.html#view) */ view: MapView | SceneView; /** * The Draw class provides advanced drawing capabilities for developers who need complete control over creating temporary graphics with different geometries. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-Draw.html) */ constructor(properties?: DrawProperties); /** * Complete the current active drawing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-Draw.html#complete) */ complete(): void; /** * Creates an instance of the requested draw action. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-Draw.html#create) */ create(drawAction: "point" | "multipoint" | "polyline" | "polygon" | "rectangle" | "circle" | "ellipse", drawOptions?: DrawCreateDrawOptions): DrawAction; /** * Resets the drawing by clearing the active action. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-Draw.html#reset) */ reset(): void; } interface DrawProperties { /** * A reference to the active [draw action](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-Draw.html#activeAction) */ activeAction?: DrawActionProperties; /** * The view in which geometries will be drawn by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-Draw.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } export interface DrawCreateDrawOptions { /** * The drawing mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-Draw.html#create) */ mode?: "hybrid" | "freehand" | "click"; } export interface DrawAction extends Accessor, Evented { } export class DrawAction { /** * Controls whether the created geometry will have z coordinates or not. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html#hasZ) */ hasZ: boolean; /** * Two-dimensional array of numbers representing the coordinates of each vertex comprising the geometry being drawn. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html#vertices) */ readonly vertices: number[][]; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html#view) */ view: MapView; /** * DrawAction is the base class for all draw actions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html) */ constructor(properties?: DrawActionProperties); /** * Indicates if the [redo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html#redo) method can be called on the action instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html#canRedo) */ canRedo(): boolean; /** * Indicates if the [undo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html#undo) method can be called on the action instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html#canUndo) */ canUndo(): boolean; /** * Maps the given screen point to a map point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html#getCoordsAndPointFromScreenPoint) */ getCoordsAndPointFromScreenPoint(screenPoint: DrawActionScreenPoint): FromScreenPointResult | null; /** * Maps the given screen point to a map point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html#getCoordsFromScreenPoint) */ getCoordsFromScreenPoint(screenPoint: DrawActionScreenPoint): number[] | null; /** * Incrementally redo actions recorded in the stack. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html#redo) */ redo(): void; /** * Maps the given screen point to a map point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html#screenToMap) */ screenToMap(screenPoint: DrawActionScreenPoint): Point | null; /** * Incrementally undo actions recorded in the stack. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html#undo) */ undo(): void; } interface DrawActionProperties { /** * Controls whether the created geometry will have z coordinates or not. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html#hasZ) */ hasZ?: boolean; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html#view) */ view?: MapViewProperties; } /** * The result object of the [getCoordsAndPointFromScreenPoint()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html#getCoordsAndPointFromScreenPoint) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html#FromScreenPointResult) */ export interface FromScreenPointResult { /** * Array of x, y, and z component (if hasZ is enabled). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html#FromScreenPointResult) */ vertex: number[]; /** * The map point of the point associated with the given screen point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html#FromScreenPointResult) */ mapPoint: Point; } /** * An object representing a point on the screen. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html#ScreenPoint) */ export interface DrawActionScreenPoint { /** * The x coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html#ScreenPoint) */ x: number; /** * The y coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-DrawAction.html#ScreenPoint) */ y: number; } export class MultipointDrawAction extends DrawAction { /** * This class uses the view events to generate a set of coordinates to create a new [Multipoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html) geometry using [Draw](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-Draw.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-MultipointDrawAction.html) */ constructor(properties?: MultipointDrawActionProperties); /** * Completes drawing the [multipoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html) geometry and fires the [draw-complete](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-MultipointDrawAction.html#event-draw-complete) event. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-MultipointDrawAction.html#complete) */ complete(): void; on(name: "cursor-update", eventHandler: MultipointDrawActionCursorUpdateEventHandler): IHandle; on(name: "vertex-add", eventHandler: MultipointDrawActionVertexAddEventHandler): IHandle; on(name: "vertex-remove", eventHandler: MultipointDrawActionVertexRemoveEventHandler): IHandle; on(name: "draw-complete", eventHandler: MultipointDrawActionDrawCompleteEventHandler): IHandle; on(name: "undo", eventHandler: MultipointDrawActionUndoEventHandler): IHandle; on(name: "redo", eventHandler: MultipointDrawActionRedoEventHandler): IHandle; } interface MultipointDrawActionProperties extends DrawActionProperties { } export interface MultipointDrawActionCursorUpdateEvent { defaultPrevented: boolean; preventDefault: Function; type: "cursor-update"; vertexIndex: number; vertices: number[][]; } export interface MultipointDrawActionDrawCompleteEvent { defaultPrevented: boolean; preventDefault: Function; type: "draw-complete"; vertices: number[][]; } export interface MultipointDrawActionRedoEvent { defaultPrevented: boolean; preventDefault: Function; type: string; vertexIndex: number; vertices: number[][]; } export interface MultipointDrawActionUndoEvent { defaultPrevented: boolean; preventDefault: Function; type: string; vertexIndex: number; vertices: number[][]; } export interface MultipointDrawActionVertexAddEvent { defaultPrevented: boolean; preventDefault: Function; type: "vertex-add"; vertexIndex: number; vertices: number[][]; } export interface MultipointDrawActionVertexRemoveEvent { defaultPrevented: boolean; preventDefault: Function; type: "vertex-remove"; vertexIndex: number; vertices: number[][]; } export class PointDrawAction extends DrawAction { /** * This class uses the view events to generate a set of coordinates to create a new [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometry using [Draw](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-Draw.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-PointDrawAction.html) */ constructor(properties?: PointDrawActionProperties); /** * Completes drawing the [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometry and fires the [draw-complete](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-PointDrawAction.html#event-draw-complete) event. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-PointDrawAction.html#complete) */ complete(): void; on(name: "cursor-update", eventHandler: PointDrawActionCursorUpdateEventHandler): IHandle; on(name: "draw-complete", eventHandler: PointDrawActionDrawCompleteEventHandler): IHandle; } interface PointDrawActionProperties extends DrawActionProperties { } export interface PointDrawActionCursorUpdateEvent { coordinates: number[]; defaultPrevented: boolean; preventDefault: Function; type: "cursor-update"; } export interface PointDrawActionDrawCompleteEvent { coordinates: number[]; defaultPrevented: boolean; preventDefault: Function; type: "draw-complete"; } export class PolygonDrawAction extends DrawAction { /** * The drawing mode. * * @default hybrid * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-PolygonDrawAction.html#mode) */ mode: "hybrid" | "freehand" | "click"; /** * This class uses different [events](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-PolygonDrawAction.html#events-summary) to generate a set of vertices to create a new [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) geometry using [Draw](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-Draw.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-PolygonDrawAction.html) */ constructor(properties?: PolygonDrawActionProperties); /** * Completes drawing the polygon geometry and fires the [draw-complete](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-PolygonDrawAction.html#event-draw-complete) event. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-PolygonDrawAction.html#complete) */ complete(): void; on(name: "cursor-update", eventHandler: PolygonDrawActionCursorUpdateEventHandler): IHandle; on(name: "vertex-add", eventHandler: PolygonDrawActionVertexAddEventHandler): IHandle; on(name: "vertex-remove", eventHandler: PolygonDrawActionVertexRemoveEventHandler): IHandle; on(name: "draw-complete", eventHandler: PolygonDrawActionDrawCompleteEventHandler): IHandle; on(name: "undo", eventHandler: PolygonDrawActionUndoEventHandler): IHandle; on(name: "redo", eventHandler: PolygonDrawActionRedoEventHandler): IHandle; } interface PolygonDrawActionProperties extends DrawActionProperties { /** * The drawing mode. * * @default hybrid * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-PolygonDrawAction.html#mode) */ mode?: "hybrid" | "freehand" | "click"; } export interface PolygonDrawActionCursorUpdateEvent { defaultPrevented: boolean; preventDefault: Function; type: "cursor-update"; vertexIndex: number; vertices: number[][]; } export interface PolygonDrawActionDrawCompleteEvent { defaultPrevented: boolean; preventDefault: Function; type: "draw-complete"; vertices: number[][]; } export interface PolygonDrawActionRedoEvent { defaultPrevented: boolean; preventDefault: Function; type: string; vertexIndex: number; vertices: number[][]; } export interface PolygonDrawActionUndoEvent { defaultPrevented: boolean; preventDefault: Function; type: string; vertexIndex: number; vertices: number[][]; } export interface PolygonDrawActionVertexAddEvent { defaultPrevented: boolean; preventDefault: Function; type: "vertex-add"; vertexIndex: number; vertices: number[][]; } export interface PolygonDrawActionVertexRemoveEvent { defaultPrevented: boolean; preventDefault: Function; type: "vertex-remove"; vertexIndex: number; vertices: number[][]; } export class PolylineDrawAction extends DrawAction { /** * The drawing mode. * * @default hybrid * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-PolylineDrawAction.html#mode) */ mode: "hybrid" | "freehand" | "click"; /** * This class uses different [events](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-PolylineDrawAction.html#events-summary) to generate a set of vertices to create a new [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) geometry using [Draw](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-Draw.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-PolylineDrawAction.html) */ constructor(properties?: PolylineDrawActionProperties); /** * Completes drawing the polyline geometry and fires the [draw-complete](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-PolylineDrawAction.html#event-draw-complete) event. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-PolylineDrawAction.html#complete) */ complete(): void; on(name: "cursor-update", eventHandler: PolylineDrawActionCursorUpdateEventHandler): IHandle; on(name: "vertex-add", eventHandler: PolylineDrawActionVertexAddEventHandler): IHandle; on(name: "vertex-remove", eventHandler: PolylineDrawActionVertexRemoveEventHandler): IHandle; on(name: "draw-complete", eventHandler: PolylineDrawActionDrawCompleteEventHandler): IHandle; on(name: "undo", eventHandler: PolylineDrawActionUndoEventHandler): IHandle; on(name: "redo", eventHandler: PolylineDrawActionRedoEventHandler): IHandle; } interface PolylineDrawActionProperties extends DrawActionProperties { /** * The drawing mode. * * @default hybrid * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-PolylineDrawAction.html#mode) */ mode?: "hybrid" | "freehand" | "click"; } export interface PolylineDrawActionCursorUpdateEvent { defaultPrevented: boolean; preventDefault: Function; type: "cursor-update"; vertexIndex: number; vertices: number[][]; } export interface PolylineDrawActionDrawCompleteEvent { defaultPrevented: boolean; preventDefault: Function; type: "draw-complete"; vertices: number[][]; } export interface PolylineDrawActionRedoEvent { defaultPrevented: boolean; preventDefault: Function; type: string; vertexIndex: number; vertices: number[][]; } export interface PolylineDrawActionUndoEvent { defaultPrevented: boolean; preventDefault: Function; type: string; vertexIndex: number; vertices: number[][]; } export interface PolylineDrawActionVertexAddEvent { defaultPrevented: boolean; preventDefault: Function; type: "vertex-add"; vertexIndex: number; vertices: number[][]; } export interface PolylineDrawActionVertexRemoveEvent { defaultPrevented: boolean; preventDefault: Function; type: "vertex-remove"; vertexIndex: number; vertices: number[][]; } export class SegmentDrawAction extends DrawAction { /** * The drawing mode. * * @default freehand * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-SegmentDrawAction.html#mode) */ mode: "freehand" | "click"; /** * This class uses different [events](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-SegmentDrawAction.html#events-summary) to generate a set of vertices to create a geometry with [drag mode](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-SegmentDrawAction.html#mode) or with two clicks. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-SegmentDrawAction.html) */ constructor(properties?: SegmentDrawActionProperties); /** * Completes drawing the polygon geometry and fires the [draw-complete](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-SegmentDrawAction.html#event-draw-complete) event. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-SegmentDrawAction.html#complete) */ complete(): void; on(name: "cursor-update", eventHandler: SegmentDrawActionCursorUpdateEventHandler): IHandle; on(name: "draw-complete", eventHandler: SegmentDrawActionDrawCompleteEventHandler): IHandle; on(name: "vertex-add", eventHandler: SegmentDrawActionVertexAddEventHandler): IHandle; } interface SegmentDrawActionProperties extends DrawActionProperties { /** * The drawing mode. * * @default freehand * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-draw-SegmentDrawAction.html#mode) */ mode?: "freehand" | "click"; } export interface SegmentDrawActionCursorUpdateEvent { defaultPrevented: boolean; preventDefault: Function; type: "cursor-update"; vertexIndex: number; vertices: number[][]; } export interface SegmentDrawActionDrawCompleteEvent { defaultPrevented: boolean; preventDefault: Function; type: "draw-complete"; vertices: number[][]; } export interface SegmentDrawActionVertexAddEvent { defaultPrevented: boolean; preventDefault: Function; type: "vertex-add"; vertexIndex: number; vertices: number[][]; } export class GroundView extends Accessor { /** * An elevation sampler that may be used to sample and query elevation values from the ground surface that is currently being displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-GroundView.html#elevationSampler) */ readonly elevationSampler: ElevationSampler; /** * The extent represents the visible portion of ground within the view as an instance of [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-GroundView.html#extent) */ readonly extent: Extent; /** * A collection containing a hierarchical list of all the created [LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of the [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#layers) in the ground. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-GroundView.html#layerViews) */ readonly layerViews: Collection; /** * Value is `true` when any of the ground layer views are updating. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-GroundView.html#updating) */ readonly updating: boolean; /** * This class represents the view for the [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html) of a map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-GroundView.html) */ constructor(properties?: GroundViewProperties); } interface GroundViewProperties { } export class GamepadInputDevice extends Accessor { /** * The native Gamepad object exposed by the browser. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-input-gamepad-GamepadInputDevice.html#native) */ readonly native: Gamepad; /** * Properties and configuration of a gamepad. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-input-gamepad-GamepadInputDevice.html) */ constructor(properties?: GamepadInputDeviceProperties); } interface GamepadInputDeviceProperties { } export class GamepadSettings extends Accessor { /** * A readonly collection of all gamepads detected. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-input-gamepad-GamepadSettings.html#devices) */ readonly devices: Collection; /** * Determines what focus is required for gamepad events to be dispatched. * * @default document * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-input-gamepad-GamepadSettings.html#enabledFocusMode) */ enabledFocusMode: "document" | "view" | "none"; /** * Gamepad input specific configuration settings. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-input-gamepad-GamepadSettings.html) */ constructor(properties?: GamepadSettingsProperties); } interface GamepadSettingsProperties { /** * Determines what focus is required for gamepad events to be dispatched. * * @default document * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-input-gamepad-GamepadSettings.html#enabledFocusMode) */ enabledFocusMode?: "document" | "view" | "none"; } export class Input extends Accessor { /** * Gamepad input specific configuration settings. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-input-Input.html#gamepad) */ readonly gamepad: GamepadSettings; /** * Input device related configuration settings on the View. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-input-Input.html) */ constructor(properties?: InputProperties); } interface InputProperties { } export class SketchLabelOptions extends Accessor { /** * Whether labels are shown next to each segment of the graphic being sketched. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchLabelOptions.html#enabled) */ enabled: boolean; /** * The `SketchLabelOptions` allows users to configure the labels which are shown next to each segment of a graphic while sketching and editing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchLabelOptions.html) */ constructor(properties?: SketchLabelOptionsProperties); } interface SketchLabelOptionsProperties { /** * Whether labels are shown next to each segment of the graphic being sketched. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchLabelOptions.html#enabled) */ enabled?: boolean; } export class SketchTooltipOptions extends Accessor { /** * Whether tooltips are shown while sketching and editing. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchTooltipOptions.html#enabled) */ enabled: boolean; /** * Whether users can focus the tooltip and input editing constraint values. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchTooltipOptions.html#inputEnabled) */ inputEnabled: boolean; /** * The elements that are displayed within the tooltip while sketching. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchTooltipOptions.html#visibleElements) */ visibleElements: VisibleElements; /** * The `SketchTooltipOptions` allows users to configure the tooltips which are shown while sketching and editing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchTooltipOptions.html) */ constructor(properties?: SketchTooltipOptionsProperties); } interface SketchTooltipOptionsProperties { /** * Whether tooltips are shown while sketching and editing. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchTooltipOptions.html#enabled) */ enabled?: boolean; /** * Whether users can focus the tooltip and input editing constraint values. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchTooltipOptions.html#inputEnabled) */ inputEnabled?: boolean; /** * The elements that are displayed within the tooltip while sketching. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchTooltipOptions.html#visibleElements) */ visibleElements?: VisibleElements; } /** * The elements that are displayed within the tooltip while sketching and editing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchTooltipOptions.html#VisibleElements) */ export interface VisibleElements { /** * When set to `false`, the area is not shown in the tooltip. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchTooltipOptions.html#VisibleElements) */ area?: boolean; /** * When set to `false`, the direction (or deflection angle) is not shown in the tooltip. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchTooltipOptions.html#VisibleElements) */ direction?: boolean; /** * When set to `false`, the distance is not shown in the tooltip. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchTooltipOptions.html#VisibleElements) */ distance?: boolean; /** * When set to `false`, the elevation is not shown in the tooltip. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchTooltipOptions.html#VisibleElements) */ elevation?: boolean; /** * When set to `false`, the header at the top of the tooltip is not shown, when in input mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchTooltipOptions.html#VisibleElements) */ header?: boolean; /** * When set to `false`, the help message at the bottom of the tooltip is not shown. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchTooltipOptions.html#VisibleElements) */ helpMessage?: boolean; /** * When set to `false`, the orientation is not shown in the tooltip. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchTooltipOptions.html#VisibleElements) */ orientation?: boolean; /** * When set to `false`, the radius is not shown in the tooltip. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchTooltipOptions.html#VisibleElements) */ radius?: boolean; /** * When set to `false`, the rotation is not shown in the tooltip. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchTooltipOptions.html#VisibleElements) */ rotation?: boolean; /** * When set to `false`, the scale is not shown in the tooltip. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchTooltipOptions.html#VisibleElements) */ scale?: boolean; /** * When set to `false`, the size is not shown in the tooltip. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchTooltipOptions.html#VisibleElements) */ size?: boolean; /** * When set to `false`, the total length is not shown in the tooltip. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchTooltipOptions.html#VisibleElements) */ totalLength?: boolean; } export class SketchValueOptions extends Accessor { /** * How direction values are displayed and, in case of input, how they are interpreted. * * @default "relative" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchValueOptions.html#directionMode) */ directionMode: "relative" | "absolute"; /** * The `SketchValueOptions` allows users to configure how numerical values and constraints behave while sketching and editing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchValueOptions.html) */ constructor(properties?: SketchValueOptionsProperties); } interface SketchValueOptionsProperties { /** * How direction values are displayed and, in case of input, how they are interpreted. * * @default "relative" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-sketch-SketchValueOptions.html#directionMode) */ directionMode?: "relative" | "absolute"; } export class FeatureSnappingLayerSource extends Accessor { /** * Indicates whether feature snapping is turned on or off. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-FeatureSnappingLayerSource.html#enabled) */ enabled: boolean; /** * The source layer used for snapping. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-FeatureSnappingLayerSource.html#layer) */ readonly layer: | BuildingSceneLayer | CSVLayer | FeatureLayer | GeoJSONLayer | GraphicsLayer | MapNotesLayer | SceneLayer | SubtypeSublayer | WFSLayer; /** * The FeatureSnappingLayerSource specifies which layers will be utilized for snapping in the [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-FeatureSnappingLayerSource.html) */ constructor(properties?: FeatureSnappingLayerSourceProperties); } interface FeatureSnappingLayerSourceProperties { /** * Indicates whether feature snapping is turned on or off. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-FeatureSnappingLayerSource.html#enabled) */ enabled?: boolean; /** * The source layer used for snapping. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-FeatureSnappingLayerSource.html#layer) */ layer?: | (BuildingSceneLayerProperties & { type: "building-scene" }) | (CSVLayerProperties & { type: "csv" }) | (FeatureLayerProperties & { type: "feature" }) | (GeoJSONLayerProperties & { type: "geojson" }) | (GraphicsLayerProperties & { type: "graphics" }) | (MapNotesLayerProperties & { type: "map-notes" }) | (SceneLayerProperties & { type: "scene" }) | (SubtypeSublayerProperties & { type: "subtype-sublayer" }) | (WFSLayerProperties & { type: "wfs" }); } export class SnappingOptions extends Accessor { /** * Snapping distance for snapping in pixels. * * @default 5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html#distance) */ distance: number; /** * Global configuration to turn snapping on or off. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html#enabled) */ enabled: boolean; /** * Global configuration option to turn feature snapping on or off. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html#featureEnabled) */ featureEnabled: boolean; /** * List of sources for feature snapping. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html#featureSources) */ featureSources: Collection; /** * Global configuration option to turn self snapping (within one feature while either drawing or reshaping) on or off. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html#selfEnabled) */ selfEnabled: boolean; /** * The `SnappingOptions` allows users to configure snapping for their editing or drawing experience in both the [Sketch](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#snappingOptions) and [Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#snappingOptions) widgets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) */ constructor(properties?: SnappingOptionsProperties); } interface SnappingOptionsProperties { /** * Snapping distance for snapping in pixels. * * @default 5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html#distance) */ distance?: number; /** * Global configuration to turn snapping on or off. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html#enabled) */ enabled?: boolean; /** * Global configuration option to turn feature snapping on or off. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html#featureEnabled) */ featureEnabled?: boolean; /** * List of sources for feature snapping. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html#featureSources) */ featureSources?: CollectionProperties; /** * Global configuration option to turn self snapping (within one feature while either drawing or reshaping) on or off. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html#selfEnabled) */ selfEnabled?: boolean; } export class BuildingComponentSublayerView extends Accessor { /** * A list of attribute fields fetched for each feature including fields required for layer [rendering](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#renderer) and additional fields defined on the [BuildingComponentSublayer.outFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#outFields) or [BuildingSceneLayer.outFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html#outFields). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingComponentSublayerView.html#availableFields) */ readonly availableFields: string[]; /** * Applies a client-side [FeatureFilter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html) to the displayed data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingComponentSublayerView.html#filter) */ filter: FeatureFilter; /** * The sublayer being viewed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingComponentSublayerView.html#sublayer) */ readonly sublayer: BuildingComponentSublayer; /** * Value is `true` if the sublayer is suspended (i.e., sublayer will not redraw or update itself when the extent changes). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingComponentSublayerView.html#suspended) */ readonly suspended: boolean; /** * Value is `true` when the sublayer is updating; for example, if it is in the process of fetching data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingComponentSublayerView.html#updating) */ readonly updating: boolean; /** * Represents the sublayer view of a [BuildingComponentSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingComponentSublayerView.html) */ constructor(properties?: BuildingComponentSublayerViewProperties); /** * Creates a query parameter object that can be used to fetch features as they are being displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingComponentSublayerView.html#createQuery) */ createQuery(): Query; /** * Highlights the given feature(s). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingComponentSublayerView.html#highlight) */ highlight(target?: Graphic | Graphic[] | number | number[]): Handle; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against features in the layer view and returns the 3D [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. * * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against features in the layer view and returns the 3D [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. If query parameters are not provided, the extent and count of all loaded features are returned. Read more about queries in the Query section of the [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html) class description. To query for the extent of features directly from a Scene Service rather than those loaded for the current view, you must use the [BuildingComponentSublayer.queryExtent()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#queryExtent) method. For making attribute based queries on a BuildingComponentSublayerView you need to specify the required fields in the [outFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#outFields) property of the BuildingComponentSublayer to ensure that attribute values are available on the client for querying. You can use [availableFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingComponentSublayerView.html#availableFields) to inspect which fields are available on the client. [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingComponentSublayerView.html#queryExtent) */ queryExtent(query?: Query | QueryProperties, options?: BuildingComponentSublayerViewQueryExtentOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against features in the layer view and returns the number of features that satisfy the query. * * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against features in the layer view and returns the number of features that satisfy the query. If query parameters are not provided, the count of all loaded features is returned. To query for the count of features directly from a Scene Service rather than those loaded for the current view, you must use the [BuildingComponentSublayer.queryFeatureCount()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#queryFeatureCount) method. For making attribute based queries on a BuildingSceneLayerView you need to specify the required fields in the [outFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html#outFields) property of the BuildingComponentSublayer to ensure that attribute values are available on the client for querying. You can use [availableFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingComponentSublayerView.html#availableFields) to inspect which fields are available on the client. Read more about queries in the Query section of the [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html) class description. [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingComponentSublayerView.html#queryFeatureCount) */ queryFeatureCount(query?: Query | QueryProperties, options?: BuildingComponentSublayerViewQueryFeatureCountOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against features in the layer view and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingComponentSublayerView.html#queryFeatures) */ queryFeatures(query?: Query | QueryProperties, options?: BuildingComponentSublayerViewQueryFeaturesOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against features in the layer view and returns an array of the ObjectIDs of features that satisfy the input query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingComponentSublayerView.html#queryObjectIds) */ queryObjectIds(query?: Query | QueryProperties, options?: BuildingComponentSublayerViewQueryObjectIdsOptions): Promise; } interface BuildingComponentSublayerViewProperties { /** * Applies a client-side [FeatureFilter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html) to the displayed data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingComponentSublayerView.html#filter) */ filter?: FeatureFilterProperties; } export interface BuildingComponentSublayerViewQueryExtentOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingComponentSublayerView.html#queryExtent) */ signal?: AbortSignal; } export interface BuildingComponentSublayerViewQueryFeatureCountOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingComponentSublayerView.html#queryFeatureCount) */ signal?: AbortSignal; } export interface BuildingComponentSublayerViewQueryFeaturesOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingComponentSublayerView.html#queryFeatures) */ signal?: AbortSignal; } export interface BuildingComponentSublayerViewQueryObjectIdsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingComponentSublayerView.html#queryObjectIds) */ signal?: AbortSignal; } export class BuildingSceneLayerView extends LayerView { /** * The layer being viewed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingSceneLayerView.html#layer) */ readonly layer: BuildingSceneLayer; /** * Collection of [sublayer views](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingComponentSublayerView.html) for all the component sublayers of the BuildingSceneLayer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingSceneLayerView.html#sublayerViews) */ readonly sublayerViews: Collection; /** * Represents the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of a [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html) after it has been added to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingSceneLayerView.html) */ constructor(properties?: BuildingSceneLayerViewProperties); /** * Highlights the given feature(s). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-BuildingSceneLayerView.html#highlight) */ highlight(target?: Graphic | Graphic[]): Handle; } interface BuildingSceneLayerViewProperties extends LayerViewProperties { } export interface CSVLayerView extends LayerView, FeatureLayerViewMixin, HighlightLayerViewMixin { } export class CSVLayerView { /** * Represents the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of a [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html) after it has been added to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) in either a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-CSVLayerView.html) */ constructor(properties?: CSVLayerViewProperties); } interface CSVLayerViewProperties extends LayerViewProperties, FeatureLayerViewMixinProperties, HighlightLayerViewMixinProperties { } export class DimensionLayerView extends LayerView { /** * Set to `true` to enable interactivity for the [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-DimensionLayerView.html#layer). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-DimensionLayerView.html#interactive) */ interactive: boolean; /** * The layer being viewed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-DimensionLayerView.html#layer) */ readonly layer: DimensionLayer; /** * Results for each dimension in the layer [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-DimensionLayer.html#source). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-DimensionLayerView.html#results) */ readonly results: Collection; /** * The selected dimension. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-DimensionLayerView.html#selectedDimension) */ selectedDimension: LengthDimension; /** * Represents the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of a [DimensionLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-DimensionLayer.html) after it has been added to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-DimensionLayerView.html) */ constructor(properties?: DimensionLayerViewProperties); /** * Starts the interactive creation of new dimensions and adds them to the layer [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-DimensionLayer.html#source). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-DimensionLayerView.html#createLengthDimensions) */ createLengthDimensions(options?: DimensionLayerViewCreateLengthDimensionsOptions): Promise; } interface DimensionLayerViewProperties extends LayerViewProperties { /** * Set to `true` to enable interactivity for the [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-DimensionLayerView.html#layer). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-DimensionLayerView.html#interactive) */ interactive?: boolean; /** * The selected dimension. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-DimensionLayerView.html#selectedDimension) */ selectedDimension?: LengthDimensionProperties; } export interface DimensionLayerViewCreateLengthDimensionsOptions { /** * Abort signal which can be used to cancel creation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-DimensionLayerView.html#createLengthDimensions) */ signal?: AbortSignal; } export interface FeatureLayerView extends LayerView, FeatureLayerViewMixin, HighlightLayerViewMixin { } export class FeatureLayerView { /** * The layer being viewed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html#layer) */ readonly layer: FeatureLayer; /** * Represents the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) after it has been added to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) in either a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html) */ constructor(properties?: FeatureLayerViewProperties); } interface FeatureLayerViewProperties extends LayerViewProperties, FeatureLayerViewMixinProperties, HighlightLayerViewMixinProperties { } export class FeatureLayerViewMixin { /** * A list of attribute fields fetched for each feature including fields required for layer's `renderer` `labelingInfo`, `elevationInfo`, and additional fields defined on the `outFields` properties. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#availableFields) */ readonly availableFields: string[]; /** * Indicates if the layer view is updating its data and new features are being fetched. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#dataUpdating) */ readonly dataUpdating: boolean; /** * The featureEffect can be used to draw attention features of interest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#featureEffect) */ featureEffect: FeatureEffect; /** * The [attribute](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#where), [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#geometry), and [time extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#timeExtent) filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#filter) */ filter: FeatureFilter; /** * Indicates whether the layer view contains all available features from the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#hasAllFeatures) */ readonly hasAllFeatures: boolean; /** * Indicates whether the layer view has all the features available in the current view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#hasAllFeaturesInView) */ readonly hasAllFeaturesInView: boolean; /** * Indicates whether the layer view has geometries at full resolution. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#hasFullGeometries) */ readonly hasFullGeometries: boolean; /** * The maximum number of features that can be displayed at a time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#maximumNumberOfFeatures) */ maximumNumberOfFeatures: number; /** * Signifies whether the maximum number of features has been exceeded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#maximumNumberOfFeaturesExceeded) */ maximumNumberOfFeaturesExceeded: boolean; /** * Creates query parameter object that can be used to [fetch aggregate features](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#queryAggregates) as they are being displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#createAggregateQuery) */ createAggregateQuery(): Query; /** * Creates a query parameter object that can be used to fetch features as they are being displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#createQuery) */ createQuery(): Query; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against aggregate features (i.e. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#queryAggregates) */ queryAggregates(query?: Query | QueryProperties, options?: FeatureLayerViewMixinQueryAggregatesOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against features available for drawing in the layerView and returns the [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#queryExtent) */ queryExtent(query?: Query | QueryProperties, options?: FeatureLayerViewMixinQueryExtentOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against features available for drawing in the layerView and returns the number of features that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#queryFeatureCount) */ queryFeatureCount(query?: Query | QueryProperties, options?: FeatureLayerViewMixinQueryFeatureCountOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against features available for drawing in the layerView and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#queryFeatures) */ queryFeatures(query?: Query | QueryProperties, options?: FeatureLayerViewMixinQueryFeaturesOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against features available for drawing in the layerView and returns array of the ObjectIDs of features that satisfy the input query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#queryObjectIds) */ queryObjectIds(query?: Query | QueryProperties, options?: FeatureLayerViewMixinQueryObjectIdsOptions): Promise; } interface FeatureLayerViewMixinProperties { /** * The featureEffect can be used to draw attention features of interest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#featureEffect) */ featureEffect?: FeatureEffectProperties; /** * The [attribute](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#where), [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#geometry), and [time extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#timeExtent) filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#filter) */ filter?: FeatureFilterProperties; /** * The maximum number of features that can be displayed at a time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#maximumNumberOfFeatures) */ maximumNumberOfFeatures?: number; /** * Signifies whether the maximum number of features has been exceeded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#maximumNumberOfFeaturesExceeded) */ maximumNumberOfFeaturesExceeded?: boolean; } export interface FeatureLayerViewMixinQueryAggregatesOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#queryAggregates) */ signal?: AbortSignal; } export interface FeatureLayerViewMixinQueryExtentOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#queryExtent) */ signal?: AbortSignal; } export interface FeatureLayerViewMixinQueryFeatureCountOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#queryFeatureCount) */ signal?: AbortSignal; } export interface FeatureLayerViewMixinQueryFeaturesOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#queryFeatures) */ signal?: AbortSignal; } export interface FeatureLayerViewMixinQueryObjectIdsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerViewMixin.html#queryObjectIds) */ signal?: AbortSignal; } export interface GeoJSONLayerView extends LayerView, FeatureLayerViewMixin, HighlightLayerViewMixin { } export class GeoJSONLayerView { /** * Represents the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of a [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html) after it has been added to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) in either a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-GeoJSONLayerView.html) */ constructor(properties?: GeoJSONLayerViewProperties); } interface GeoJSONLayerViewProperties extends LayerViewProperties, FeatureLayerViewMixinProperties, HighlightLayerViewMixinProperties { } export class GeoRSSLayerView extends LayerView { /** * Represents the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of a [GeoRSSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html) after it has been added to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) in either a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-GeoRSSLayerView.html) */ constructor(properties?: GeoRSSLayerViewProperties); /** * Highlights the given feature(s). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-GeoRSSLayerView.html#highlight) */ highlight(target?: Graphic | Graphic[]): Handle; } interface GeoRSSLayerViewProperties extends LayerViewProperties { } export interface GraphicsLayerView extends LayerView, HighlightLayerViewMixin { } export class GraphicsLayerView { /** * Represents the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of a [GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) after it has been added to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) in either a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-GraphicsLayerView.html) */ constructor(properties?: GraphicsLayerViewProperties); /** * Returns all graphics available for drawing in the layer view as a [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-GraphicsLayerView.html#queryGraphics) */ queryGraphics(): Promise>; } interface GraphicsLayerViewProperties extends LayerViewProperties, HighlightLayerViewMixinProperties { } export class HighlightLayerViewMixin { /** * Options for configuring the highlight. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-HighlightLayerViewMixin.html#highlightOptions) */ highlightOptions: HighlightOptions; /** * Highlights the given feature(s) in a layer view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-HighlightLayerViewMixin.html#highlight) */ highlight(target?: Graphic | Graphic[] | number | number[] | string | string[]): Handle; } interface HighlightLayerViewMixinProperties { /** * Options for configuring the highlight. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-HighlightLayerViewMixin.html#highlightOptions) */ highlightOptions?: HighlightOptions; } export interface ImageryLayerView extends LayerView, HighlightLayerViewMixin { } export class ImageryLayerView { /** * An object that provides the user access to [pixels](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixels) and their values in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ImageryLayerView.html#pixelData) */ pixelData: PixelData; /** * Represents the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of an [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html) after it has been added to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) in either a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ImageryLayerView.html) */ constructor(properties?: ImageryLayerViewProperties); } interface ImageryLayerViewProperties extends LayerViewProperties, HighlightLayerViewMixinProperties { /** * An object that provides the user access to [pixels](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixels) and their values in the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ImageryLayerView.html#pixelData) */ pixelData?: PixelData; } export class KMLLayerView extends LayerView { /** * A collection of all the [MapImages](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-KMLLayerView.html#MapImage) from visible sublayers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-KMLLayerView.html#allVisibleMapImages) */ readonly allVisibleMapImages: Collection; /** * A collection of graphics representing all the points from visible sublayers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-KMLLayerView.html#allVisiblePoints) */ readonly allVisiblePoints: Collection; /** * A collection of graphics representing all the polygons from visible sublayers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-KMLLayerView.html#allVisiblePolygons) */ readonly allVisiblePolygons: Collection; /** * A collection of graphics representing all the polylines from visible sublayers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-KMLLayerView.html#allVisiblePolylines) */ readonly allVisiblePolylines: Collection; /** * Represents the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of a [KMLLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html) after it has been added to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-KMLLayerView.html) */ constructor(properties?: KMLLayerViewProperties); } interface KMLLayerViewProperties extends LayerViewProperties { } /** * **MapImage** represents an image overlay draped onto the terrain. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-KMLLayerView.html#MapImage) */ export interface KMLLayerViewMapImage { /** * Map image id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-KMLLayerView.html#MapImage) */ id: number; /** * URL to the map image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-KMLLayerView.html#MapImage) */ href: string; /** * The [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of the map image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-KMLLayerView.html#MapImage) */ Extent: Extent; /** * Rotation of the map image about its center, in degrees. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-KMLLayerView.html#MapImage) */ rotation: number; } export interface LayerView extends Accessor, corePromise, Identifiable { } export class LayerView { /** * The layer being viewed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html#layer) */ readonly layer: Layer; /** * Indicates if the [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#spatialReference) of the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) is supported by the layer view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html#spatialReferenceSupported) */ readonly spatialReferenceSupported: boolean; /** * Value is `true` if the layer is suspended (i.e., layer will not redraw or update itself when the extent changes). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html#suspended) */ readonly suspended: boolean; /** * Indicates if the layer view is making any updates that will impact what is displayed on the map. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html#updating) */ readonly updating: boolean; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) associated with the layer view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html#view) */ readonly view: MapView | SceneView; /** * When `true`, the layer is visible in the view. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html#visible) */ visible: boolean; /** * Represents the view for a single layer after it has been added to either a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) */ constructor(properties?: LayerViewProperties); } interface LayerViewProperties { /** * When `true`, the layer is visible in the view. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html#visible) */ visible?: boolean; } export interface OGCFeatureLayerView extends LayerView, FeatureLayerViewMixin, HighlightLayerViewMixin { } export class OGCFeatureLayerView { /** * Represents the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of a [OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html) after it has been added to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) in either a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-OGCFeatureLayerView.html) */ constructor(properties?: OGCFeatureLayerViewProperties); } interface OGCFeatureLayerViewProperties extends LayerViewProperties, FeatureLayerViewMixinProperties, HighlightLayerViewMixinProperties { } export class PointCloudLayerView extends LayerView { /** * A list of attribute fields fetched for each feature including fields required for layer [rendering](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#renderer) and additional fields defined on the [SceneLayer.outFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#outFields). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-PointCloudLayerView.html#availableFields) */ readonly availableFields: string[]; /** * Represents the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of a [PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html) after it has been added to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-PointCloudLayerView.html) */ constructor(properties?: PointCloudLayerViewProperties); /** * Highlights the given point(s). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-PointCloudLayerView.html#highlight) */ highlight(target?: Graphic | Graphic[]): Handle; } interface PointCloudLayerViewProperties extends LayerViewProperties { } export class SceneLayerView extends LayerView { /** * A list of attribute fields fetched for each feature including fields required for layer [rendering](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#renderer) and additional fields defined on the [SceneLayer.outFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#outFields). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#availableFields) */ readonly availableFields: string[]; /** * Applies a client-side [FeatureFilter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html) to the displayed data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#filter) */ filter: FeatureFilter; /** * The scene layer being viewed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#layer) */ readonly layer: SceneLayer; /** * The maximum number of features that can be displayed at a time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#maximumNumberOfFeatures) */ maximumNumberOfFeatures: number; /** * Signifies whether the maximum number of features has been exceeded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#maximumNumberOfFeaturesExceeded) */ maximumNumberOfFeaturesExceeded: boolean; /** * Represents the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of a [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) after it has been added to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html) */ constructor(properties?: SceneLayerViewProperties); /** * Creates query parameter object that can be used to fetch features as they are being displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#createQuery) */ createQuery(): Query; /** * Highlights the given feature(s). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#highlight) */ highlight(target?: Graphic | Graphic[] | number | number[]): Handle; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against features in the layer view and returns the 3D [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. * * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against features in the layer view and returns the 3D [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. If query parameters are not provided, the extent and count of all loaded features are returned. Read more about queries in the Query section of the [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) class description. To query for the extent of features directly from a Scene Service rather than those loaded for the current view, you must use the [SceneLayer.queryExtent()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryExtent) method. For making attribute based queries on a SceneLayerView you need to specify the required fields in the [outFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#outFields) property of the SceneLayer to ensure that attribute values are available on the client for querying. You can use [availableFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#availableFields) to inspect which fields are available on the client. [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#queryExtent) */ queryExtent(query?: Query | QueryProperties, options?: SceneLayerViewQueryExtentOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against features in the layer view and returns the number of features that satisfy the query. * * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against features in the layer view and returns the number of features that satisfy the query. If query parameters are not provided, the count of all loaded features is returned. Read more about queries in the Query section of the [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) class description. To query for the count of features directly from a Scene Service rather than those loaded for the current view, you must use the [SceneLayer.queryFeatureCount()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryFeatureCount) method. For making attribute based queries on a SceneLayerView you need to specify the required fields in the [outFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#outFields) property of the SceneLayer to ensure that attribute values are available on the client for querying. You can use [availableFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#availableFields) to inspect which fields are available on the client. [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#queryFeatureCount) */ queryFeatureCount(query?: Query | QueryProperties, options?: SceneLayerViewQueryFeatureCountOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against features in the layer view and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#queryFeatures) */ queryFeatures(query?: Query | QueryProperties, options?: SceneLayerViewQueryFeaturesOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against features in the layer view and returns an array of the ObjectIDs of features that satisfy the input query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#queryObjectIds) */ queryObjectIds(query?: Query | QueryProperties, options?: SceneLayerViewQueryObjectIdsOptions): Promise; } interface SceneLayerViewProperties extends LayerViewProperties { /** * Applies a client-side [FeatureFilter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html) to the displayed data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#filter) */ filter?: FeatureFilterProperties; /** * The maximum number of features that can be displayed at a time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#maximumNumberOfFeatures) */ maximumNumberOfFeatures?: number; /** * Signifies whether the maximum number of features has been exceeded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#maximumNumberOfFeaturesExceeded) */ maximumNumberOfFeaturesExceeded?: boolean; } export interface SceneLayerViewQueryExtentOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#queryExtent) */ signal?: AbortSignal; } export interface SceneLayerViewQueryFeatureCountOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#queryFeatureCount) */ signal?: AbortSignal; } export interface SceneLayerViewQueryFeaturesOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#queryFeatures) */ signal?: AbortSignal; } export interface SceneLayerViewQueryObjectIdsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#queryObjectIds) */ signal?: AbortSignal; } export interface StreamLayerView extends LayerView, HighlightLayerViewMixin, Evented { } export class StreamLayerView { /** * The error that explains an unsuccessful attempt to connect to the stream service or an unexpected disconnection from the stream service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#connectionError) */ readonly connectionError: Error; /** * The status of the Web Socket connection with the stream service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#connectionStatus) */ readonly connectionStatus: "connected" | "disconnected" | "paused"; /** * The featureEffect can be used to draw attention features of interest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#featureEffect) */ featureEffect: FeatureEffect; /** * The [attribute](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#where), [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#geometry), and [time extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#timeExtent) filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#filter) */ filter: FeatureFilter; /** * Represents the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of a [StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html) after it has been added to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) in either a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html) */ constructor(properties?: StreamLayerViewProperties); /** * Connects to a stream service web socket. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#connect) */ connect(): void; /** * Creates a query parameter object that can be used to fetch features as they are being displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#createQuery) */ createQuery(): Query; /** * Disconnects from a stream service web socket. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#disconnect) */ disconnect(): void; /** * Pauses the connection and stops new observations from being applied until [resume()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#resume) is called. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#pause) */ pause(): void; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against features available for drawing in the layerView and returns the [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#queryExtent) */ queryExtent(query?: Query | QueryProperties, options?: StreamLayerViewQueryExtentOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against features available for drawing in the layerView and returns the number of features that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#queryFeatureCount) */ queryFeatureCount(query?: Query | QueryProperties, options?: StreamLayerViewQueryFeatureCountOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against features available for drawing in the layerView and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#queryFeatures) */ queryFeatures(query?: Query | QueryProperties, options?: StreamLayerViewQueryFeaturesOptions): Promise; /** * If a [trackIdField](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#trackIdField) is specified on the stream service, this method executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against features available for drawing in the layerView and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html) of the latest observations for each `trackId` that satisfy the query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#queryLatestObservations) */ queryLatestObservations(query?: Query | QueryProperties, options?: StreamLayerViewQueryLatestObservationsOptions): Promise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) against features available for drawing in the layerView and returns array of the ObjectIDs of features that satisfy the input query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#queryObjectIds) */ queryObjectIds(query?: Query | QueryProperties, options?: StreamLayerViewQueryObjectIdsOptions): Promise; /** * Resumes the connection and the new observations will be applied. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#resume) */ resume(): void; on(name: "data-received", eventHandler: StreamLayerViewDataReceivedEventHandler): IHandle; on(name: "message-received", eventHandler: StreamLayerViewMessageReceivedEventHandler): IHandle; on(name: "update-rate", eventHandler: StreamLayerViewUpdateRateEventHandler): IHandle; } interface StreamLayerViewProperties extends LayerViewProperties, HighlightLayerViewMixinProperties { /** * The featureEffect can be used to draw attention features of interest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#featureEffect) */ featureEffect?: FeatureEffectProperties; /** * The [attribute](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#where), [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#geometry), and [time extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#timeExtent) filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#filter) */ filter?: FeatureFilterProperties; } export interface StreamLayerViewDataReceivedEvent { attributes: any; geometry: any; } export interface StreamLayerViewMessageReceivedEvent { message: any; } export interface StreamLayerViewQueryExtentOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#queryExtent) */ signal?: AbortSignal; } export interface StreamLayerViewQueryFeatureCountOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#queryFeatureCount) */ signal?: AbortSignal; } export interface StreamLayerViewQueryFeaturesOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#queryFeatures) */ signal?: AbortSignal; } export interface StreamLayerViewQueryLatestObservationsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#queryLatestObservations) */ signal?: AbortSignal; } export interface StreamLayerViewQueryObjectIdsOptions { /** * Signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#queryObjectIds) */ signal?: AbortSignal; } export interface StreamLayerViewUpdateRateEvent { client: number; websocket: number; } export interface WFSLayerView extends LayerView, FeatureLayerViewMixin, HighlightLayerViewMixin { } export class WFSLayerView { /** * Represents the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of a [WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html) after it has been added to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) in either a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-WFSLayerView.html) */ constructor(properties?: WFSLayerViewProperties); } interface WFSLayerViewProperties extends LayerViewProperties, FeatureLayerViewMixinProperties, HighlightLayerViewMixinProperties { } export class Magnifier extends Accessor { /** * Controls the amount of magnification to display. * * @default 1.5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Magnifier.html#factor) */ factor: number; /** * Indicates whether the mask image is enabled. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Magnifier.html#maskEnabled) */ maskEnabled: boolean; /** * The mask url points to an image that determines the visible area of the magnified image [(alpha channel)](https://developer.mozilla.org/en-US/docs/Glossary/Alpha). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Magnifier.html#maskUrl) */ maskUrl: string; /** * The offset of the magnifier in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Magnifier.html#offset) */ offset: MagnifierScreenPoint; /** * Indicates whether the overlay image is enabled. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Magnifier.html#overlayEnabled) */ overlayEnabled: boolean; /** * The overlay url points to an image that is displayed on top of the magnified image. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Magnifier.html#overlayUrl) */ overlayUrl: string; /** * The position of the magnifier in pixels. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Magnifier.html#position) */ position: MagnifierScreenPoint; /** * The size of the magnifier in pixels. * * @default 120 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Magnifier.html#size) */ size: number; /** * Indicates whether the magnifier is visible. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Magnifier.html#visible) */ visible: boolean; /** * The Magnifier allows end users to show a portion of the view as a magnified image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Magnifier.html) */ constructor(properties?: MagnifierProperties); } interface MagnifierProperties { /** * Controls the amount of magnification to display. * * @default 1.5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Magnifier.html#factor) */ factor?: number; /** * Indicates whether the mask image is enabled. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Magnifier.html#maskEnabled) */ maskEnabled?: boolean; /** * The mask url points to an image that determines the visible area of the magnified image [(alpha channel)](https://developer.mozilla.org/en-US/docs/Glossary/Alpha). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Magnifier.html#maskUrl) */ maskUrl?: string; /** * The offset of the magnifier in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Magnifier.html#offset) */ offset?: MagnifierScreenPoint; /** * Indicates whether the overlay image is enabled. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Magnifier.html#overlayEnabled) */ overlayEnabled?: boolean; /** * The overlay url points to an image that is displayed on top of the magnified image. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Magnifier.html#overlayUrl) */ overlayUrl?: string; /** * The position of the magnifier in pixels. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Magnifier.html#position) */ position?: MagnifierScreenPoint; /** * The size of the magnifier in pixels. * * @default 120 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Magnifier.html#size) */ size?: number; /** * Indicates whether the magnifier is visible. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Magnifier.html#visible) */ visible?: boolean; } /** * An object representing the location on the screen. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Magnifier.html#ScreenPoint) */ export interface MagnifierScreenPoint { /** * The x coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Magnifier.html#ScreenPoint) */ x: number; /** * The y coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Magnifier.html#ScreenPoint) */ y: number; } export interface MapView extends View, BreakpointsOwner, PopupView { } export class MapView { /** * The background color of the MapView. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#background) */ background: ColorBackground; /** * Represents the view's center point; when setting the center, you may pass a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance or an array of numbers representing a longitude/latitude pair (`[-100.4593, 36.9014]`). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#center) */ center: Point; /** * Specifies constraints to [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale), [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#zoom), and [rotation](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#rotation) that may be applied to the MapView. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ constraints: MapViewConstraints; /** * The extent represents the visible portion of a [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) within the view as an instance of [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#extent) */ extent: Extent; /** * Applies a display filter on the view for a specific set of floor levels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#floors) */ floors: Collection; /** * Options for configuring the highlight. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#highlightOptions) */ highlightOptions: HighlightOptions; /** * Defines which anchor stays still while resizing the browser window. * * @default center * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#resizeAlign) */ resizeAlign: | "center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right"; /** * The clockwise rotation of due north in relation to the top of the view in degrees. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#rotation) */ rotation: number; /** * Represents the map scale at the center of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) */ scale: number; /** * Indicates if the MapView's [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#spatialReference) can be changed after it is initialized. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#spatialReferenceLocked) */ spatialReferenceLocked: boolean; /** * Defines the time zone of the view. * * @default system * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#timeZone) */ timeZone: string; /** * The dimension of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#type) */ readonly type: "2d"; /** * Represents the current view as a [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) or point of observation on the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#viewpoint) */ viewpoint: Viewpoint; /** * Represents the level of detail (LOD) at the center of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#zoom) */ zoom: number; /** * A MapView displays a 2D view of a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) */ constructor(properties?: MapViewProperties); /** * Sets the view to a given target. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) */ goTo(target: GoToTarget2D, options?: GoToOptions2D): Promise; /** * Returns [hit test results](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#HitTestResult) from each layer that intersects the specified screen coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hitTest) */ hitTest(screenPoint: MapViewScreenPoint | MouseEvent, options?: MapViewHitTestOptions): Promise; /** * Create a screenshot of the current view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#takeScreenshot) */ takeScreenshot(options?: MapViewTakeScreenshotOptions): Promise; /** * Converts the given screen point to a [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#toMap) */ toMap(screenPoint: MapViewScreenPoint | MouseEvent): Point; /** * Converts the given [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) to a screen point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#toScreen) */ toScreen(point: Point, options?: ToScreenOptions2D): MapViewScreenPoint; } interface MapViewProperties extends ViewProperties, BreakpointsOwnerProperties, PopupViewProperties { /** * The background color of the MapView. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#background) */ background?: ColorBackgroundProperties; /** * Represents the view's center point; when setting the center, you may pass a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance or an array of numbers representing a longitude/latitude pair (`[-100.4593, 36.9014]`). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#center) */ center?: (PointProperties & { type: "point" }) | number[]; /** * Specifies constraints to [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale), [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#zoom), and [rotation](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#rotation) that may be applied to the MapView. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ constraints?: MapViewConstraints; /** * The extent represents the visible portion of a [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) within the view as an instance of [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#extent) */ extent?: ExtentProperties; /** * Applies a display filter on the view for a specific set of floor levels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#floors) */ floors?: CollectionProperties; /** * Options for configuring the highlight. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#highlightOptions) */ highlightOptions?: HighlightOptions; /** * Defines which anchor stays still while resizing the browser window. * * @default center * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#resizeAlign) */ resizeAlign?: | "center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right"; /** * The clockwise rotation of due north in relation to the top of the view in degrees. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#rotation) */ rotation?: number; /** * Represents the map scale at the center of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) */ scale?: number; /** * Indicates if the MapView's [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#spatialReference) can be changed after it is initialized. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#spatialReferenceLocked) */ spatialReferenceLocked?: boolean; /** * Defines the time zone of the view. * * @default system * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#timeZone) */ timeZone?: string; /** * Represents the current view as a [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) or point of observation on the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#viewpoint) */ viewpoint?: ViewpointProperties; /** * Represents the level of detail (LOD) at the center of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#zoom) */ zoom?: number; } /** * Animation options for the [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#GoToOptions2D) */ export interface GoToOptions2D { /** * Indicates if the transition to the new view should be animated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#GoToOptions2D) */ animate?: boolean; /** * The duration of the animation in milliseconds. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#GoToOptions2D) */ duration?: number; /** * The easing function used for the animation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#GoToOptions2D) */ easing?: "linear" | "ease" | "ease-in" | "ease-out" | "ease-in-out" | Function; /** * **Since 4.28.** Indicates if the target geometry is normalized based on the [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#center) of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#GoToOptions2D) */ pickClosestTarget?: boolean; /** * An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to abort the animation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#GoToOptions2D) */ signal?: AbortSignal; } /** * The target location/viewpoint to animate to in the [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#GoToTarget2D) */ export type GoToTarget2D = | number[] | Geometry | Geometry[] | Collection | Graphic | Graphic[] | Collection | Viewpoint | any; /** * Object specification for the graphic hit result returned in [HitTestResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#HitTestResult) of the [hitTest()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hitTest) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#GraphicHit) */ export interface GraphicHit { type: "graphic"; /** * A graphic representing a feature in the view that intersects the input screen coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#GraphicHit) */ graphic: Graphic; /** * The layer that contains the feature/graphic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#GraphicHit) */ layer: Layer; /** * The point geometry in the spatial reference of the view corresponding with the input screen coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#GraphicHit) */ mapPoint: Point; } /** * A layer, graphic, or collection of layers or graphics to be used in the [hitTest()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hitTest) filter options. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#HitTestItem) */ export type HitTestItem = Layer | Graphic | Collection | Collection | Layer[] | Graphic[]; /** * Object specification for the result of the [hitTest()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hitTest) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#HitTestResult) */ export interface HitTestResult { /** * An array of result objects returned from the [hitTest()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hitTest). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#HitTestResult) */ results: ViewHit[]; /** * The screen coordinates (or native mouse event) of the click on the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#HitTestResult) */ screenPoint: MapViewScreenPoint; } export interface MapViewConstraints { /** * An array of [LODs](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LOD.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ lods?: LOD[]; /** * The area in which the user is allowed to navigate laterally. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ geometry?: Geometry; /** * The minimum [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) the user is allowed to zoom to within the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ minScale?: number; /** * The maximum [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) the user is allowed to zoom to within the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ maxScale?: number; /** * The minimum [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#zoom) level the user is allowed to zoom to within the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ minZoom?: number; /** * The maximum [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#zoom) level the user is allowed to zoom to within the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ maxZoom?: number; /** * When `true`, the view snaps to the next LOD when zooming in or out. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ snapToZoom?: boolean; /** * Indicates whether the user can rotate the map. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ rotationEnabled?: boolean; /** * A read-only property that specifies the levels of detail (LODs) read from the [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ effectiveLODs?: LOD[]; /** * A read-only property that specifies the minimum [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#zoom) level the user is allowed to zoom to within the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ effectiveMinZoom?: number; /** * A read-only property that specifies the maximum [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#zoom) level the user is allowed to zoom to within the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ effectiveMaxZoom?: number; /** * A read-only property that specifies the minimum [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) the user is allowed to zoom to within the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ effectiveMinScale?: number; /** * A read-only property that specifies the maximum [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) the user is allowed to zoom to within the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ effectiveMaxScale?: number; } export interface MapViewHitTestOptions { /** * A list of layers and graphics to include in the hitTest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hitTest) */ include?: HitTestItem[] | Collection | Layer | Graphic; /** * A list of layers and graphics to exclude from the hitTest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hitTest) */ exclude?: HitTestItem[] | Collection | Layer | Graphic; } export interface MapViewTakeScreenshotOptions { /** * The format of the resulting encoded data url. * * @default png * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#takeScreenshot) */ format?: "jpg" | "png"; /** * When used, only the visible layers in this list will be included in the output. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#takeScreenshot) */ layers?: Layer[]; /** * The quality (0 to 100) of the encoded image when encoding as `jpg`. * * @default 98 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#takeScreenshot) */ quality?: number; /** * The width of the screenshot (defaults to the area width). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#takeScreenshot) */ width?: number; /** * The height of the screenshot (defaults to the area height). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#takeScreenshot) */ height?: number; /** * Specifies whether to take a screenshot of a specific area of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#takeScreenshot) */ area?: MapViewTakeScreenshotOptionsArea; /** * Indicates whether to ignore the background color set in the [initial view properties](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#initialViewProperties) of the web map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#takeScreenshot) */ ignoreBackground?: boolean; /** * Indicates whether view padding should be ignored. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#takeScreenshot) */ ignorePadding?: boolean; } export interface MapViewTakeScreenshotOptionsArea { /** * The x coordinate of the area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#takeScreenshot) */ x?: number; /** * The y coordinate of the area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#takeScreenshot) */ y?: number; /** * The width of the area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#takeScreenshot) */ width?: number; /** * The height of the area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#takeScreenshot) */ height?: number; } /** * Object specification for the media hit results returned from [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html) in [HitTestResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#HitTestResult) of the [hitTest()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hitTest) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#MediaHit) */ export interface MediaHit { type: "media"; /** * An element representing a media element in [MediaLayer.source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#source) that intersects the input screen coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#MediaHit) */ element: ImageElement | VideoElement; /** * The media layer that contains the element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#MediaHit) */ layer: MediaLayer; /** * The point geometry in the spatial reference of the view corresponding with the input screen coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#MediaHit) */ mapPoint: Point; /** * _Since 4.28_ An object representing a point on the element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#MediaHit) */ sourcePoint: SourcePoint; } /** * Object specification for the route hit results returned from [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html) in [HitTestResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#HitTestResult) of the [hitTest()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hitTest) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#RouteHit) */ export interface RouteHit { type: "route"; /** * The route layer that contains the element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#RouteHit) */ layer: RouteLayer; /** * The point geometry in the spatial reference of the view corresponding with the input screen coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#RouteHit) */ mapPoint: Point; /** * The route hit test will contain all intersecting network elements, which includes one of the following: DirectionLine, DirectionPoint, PointBarrier, PolylineBarrier, PolygonBarrier, Stop, or RouteInfo. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#RouteHit) */ networkFeature: DirectionLine | DirectionPoint | PointBarrier | PolygonBarrier | PolygonBarrier | RouteInfo | Stop; } /** * An object representing a point on the screen. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#ScreenPoint) */ export interface MapViewScreenPoint { /** * The x coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#ScreenPoint) */ x: number; /** * The y coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#ScreenPoint) */ y: number; } /** * Object returned when [takeScreenshot()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#takeScreenshot) promise resolves: * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#Screenshot) */ export interface Screenshot { /** * A data url representing the screenshot. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#Screenshot) */ dataUrl: string; /** * The raw RGBA image data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#Screenshot) */ data: ImageData; } /** * Options for the [toScreen()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#toScreen) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#ToScreenOptions2D) */ export interface ToScreenOptions2D { /** * Indicates if the point will be normalized based on the [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#center) of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#ToScreenOptions2D) */ pickClosestTarget?: boolean; } /** * Object specification for the result returned in [HitTestResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#HitTestResult) of the [hitTest()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hitTest) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#ViewHit) */ export type ViewHit = GraphicHit | MediaHit | RouteHit; export class gamepadGamepadSettings extends Accessor { /** * Use this property to explicitly select the gamepad device for map and scene navigation. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-gamepad-GamepadSettings.html#device) */ device: GamepadInputDevice; /** * Whether gamepad navigation is enabled on the View. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-gamepad-GamepadSettings.html#enabled) */ enabled: boolean; /** * This setting controls the behavior of forward and back movement of the left stick. * * @default pan * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-gamepad-GamepadSettings.html#mode) */ mode: "pan" | "zoom"; /** * Determines whether pressing the tilt axis forwards make the view tilt down (towards the nadir), or up (towards the zenith). * * @default forward-down * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-gamepad-GamepadSettings.html#tiltDirection) */ tiltDirection: "forward-down" | "forward-up"; /** * Gamepad navigation specific configuration settings. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-gamepad-GamepadSettings.html) */ constructor(properties?: gamepadGamepadSettingsProperties); } interface gamepadGamepadSettingsProperties { /** * Use this property to explicitly select the gamepad device for map and scene navigation. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-gamepad-GamepadSettings.html#device) */ device?: GamepadInputDeviceProperties; /** * Whether gamepad navigation is enabled on the View. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-gamepad-GamepadSettings.html#enabled) */ enabled?: boolean; /** * This setting controls the behavior of forward and back movement of the left stick. * * @default pan * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-gamepad-GamepadSettings.html#mode) */ mode?: "pan" | "zoom"; /** * Determines whether pressing the tilt axis forwards make the view tilt down (towards the nadir), or up (towards the zenith). * * @default forward-down * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-gamepad-GamepadSettings.html#tiltDirection) */ tiltDirection?: "forward-down" | "forward-up"; } export class Navigation extends Accessor { /** * Indicates if single finger touch [drag](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#event-drag) events are enabled or disabled. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-Navigation.html#browserTouchPanEnabled) */ browserTouchPanEnabled: boolean; /** * Gamepad navigation specific configuration settings. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-Navigation.html#gamepad) */ gamepad: gamepadGamepadSettings; /** * When `true`, the view will temporarily continue to pan after the pointer (e.g. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-Navigation.html#momentumEnabled) */ momentumEnabled: boolean; /** * Indicates whether the view can be zoomed in or out with the mouse wheel. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-Navigation.html#mouseWheelZoomEnabled) */ mouseWheelZoomEnabled: boolean; /** * Navigation related configuration settings on the View. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-Navigation.html) */ constructor(properties?: NavigationProperties); } interface NavigationProperties { /** * Indicates if single finger touch [drag](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#event-drag) events are enabled or disabled. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-Navigation.html#browserTouchPanEnabled) */ browserTouchPanEnabled?: boolean; /** * Gamepad navigation specific configuration settings. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-Navigation.html#gamepad) */ gamepad?: gamepadGamepadSettingsProperties; /** * When `true`, the view will temporarily continue to pan after the pointer (e.g. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-Navigation.html#momentumEnabled) */ momentumEnabled?: boolean; /** * Indicates whether the view can be zoomed in or out with the mouse wheel. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-Navigation.html#mouseWheelZoomEnabled) */ mouseWheelZoomEnabled?: boolean; } export class PopupView { /** * A [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) object that displays general content or attributes from [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-PopupView.html#map). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-PopupView.html#popup) */ popup: Popup; /** * Controls whether the popup opens when users click on the view. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-PopupView.html#popupEnabled) */ popupEnabled: boolean; /** * Closes the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-PopupView.html#closePopup) */ closePopup(): void; /** * Opens the popup at the given location with content defined either explicitly with `content` or driven from the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) of input features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-PopupView.html#openPopup) */ openPopup(options?: PopupViewOpenPopupOptions): Promise; } interface PopupViewProperties { /** * A [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) object that displays general content or attributes from [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-PopupView.html#map). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-PopupView.html#popup) */ popup?: PopupProperties; /** * Controls whether the popup opens when users click on the view. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-PopupView.html#popupEnabled) */ popupEnabled?: boolean; } export interface PopupViewOpenPopupOptions { /** * Sets the [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#title) of the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-PopupView.html#openPopup) */ title?: string; /** * Sets the [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#content) of the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-PopupView.html#openPopup) */ content?: string | HTMLElement | Widget; /** * Sets the popup's [location](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#location), which is the geometry used to position the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-PopupView.html#openPopup) */ location?: Geometry; /** * When `true`, indicates the popup should fetch the content of this feature and display it. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-PopupView.html#openPopup) */ fetchFeatures?: boolean; /** * Sets the popup's [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#features), which populate the title and content of the popup based on each graphic's [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-PopupView.html#openPopup) */ features?: Graphic[]; /** * Sets pending [promises](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#promises) on the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-PopupView.html#openPopup) */ promises?: Promise[]; /** * This property enables multiple features in a popup to display in a list rather than displaying the first selected feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-PopupView.html#openPopup) */ featureMenuOpen?: boolean; /** * When `true`, indicates the popup should update its [location](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#location) for each paginated feature based on the [selectedFeature's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeature) geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-PopupView.html#openPopup) */ updateLocationEnabled?: boolean; /** * When `true`, indicates that only the popup header will display. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-PopupView.html#openPopup) */ collapsed?: boolean; /** * When `true`, indicates that the focus should be on the popup after it has been opened. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-PopupView.html#openPopup) */ shouldFocus?: boolean; } export interface SceneView extends View, BreakpointsOwner, PopupView { } export class SceneView { /** * Allows the view to be partially or fully transparent when composited with the webpage elements behind it. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#alphaCompositingEnabled) */ alphaCompositingEnabled: boolean; /** * Allows for adding analyses directly to the default analyses in the View. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#analyses) */ analyses: Collection< DimensionAnalysis | DirectLineMeasurementAnalysis | AreaMeasurementAnalysis | SliceAnalysis | LineOfSightAnalysis >; /** * The observation point from which the visible portion (or perspective) of the SceneView is determined. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera) */ camera: Camera; /** * Represents the view's center point; when setting the center you may pass a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance or an array of numbers representing at longitude/latitude pair (`[-100.4593, 36.9014]`). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center) */ center: Point; /** * Represents an optional clipping area used to define the visible [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of a local scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#clippingArea) */ clippingArea: Extent; /** * Specifies constraints for [Camera tilt](esri-Camera.html#tilt) and altitude that may be applied to the SceneView. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ constraints: SceneViewConstraints; /** * Specifies various properties of the environment's visualization in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ environment: SceneViewEnvironment; /** * The extent represents the visible portion of a [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) within the view as an instance of [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#extent) */ extent: Extent; /** * Applies a display filter on the view for a specific set of floor levels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#floors) */ floors: Collection; /** * The view for the ground of the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#groundView) */ readonly groundView: GroundView; /** * Options for configuring the highlight. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlightOptions) */ highlightOptions: HighlightOptions; /** * This property contains performance information in a SceneView like global memory usage and additional details for layers about memory consumption and number of features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#performanceInfo) */ readonly performanceInfo: SceneViewPerformanceInfo; /** * SceneView can draw scenes in three different quality modes: `high`, `medium` and `low`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#qualityProfile) */ qualityProfile: "low" | "medium" | "high"; /** * Represents an approximation of the map scale at the center of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale) */ scale: number; /** * The type of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#type) */ readonly type: "3d"; /** * The viewing mode (`local` or `global`). * * @default global * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewingMode) */ viewingMode: "global" | "local"; /** * Represents the current view as a [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) or point of observation on the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint) */ viewpoint: Viewpoint; /** * Represents the level of detail (LOD) at the center of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom) */ zoom: number; /** * A SceneView displays a 3D view of a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) or [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) */ constructor(properties?: SceneViewProperties); /** * Sets the view to a given target. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) */ goTo(target: GoToTarget3D, options?: GoToOptions3D): Promise; /** * Returns [hit test results](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult) from each layer that intersects the specified screen coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest) */ hitTest(screenPoint: SceneViewScreenPoint | MouseEvent, options?: SceneViewHitTestOptions): Promise; /** * Create a screenshot of the current view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot) */ takeScreenshot(options?: SceneViewTakeScreenshotOptions): Promise; /** * Converts the given screen point to a [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#toMap) */ toMap(screenPoint: SceneViewScreenPoint | MouseEvent, options?: SceneViewToMapOptions): Point; /** * Converts the given [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) to a screen point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#toScreen) */ toScreen(point: Point): SceneViewScreenPoint; /** * Gets the analysis view created for the given analysis object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenAnalysisView) */ whenAnalysisView(analysis: LineOfSightAnalysis): Promise; /** * Gets the analysis view created for the given analysis object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenAnalysisView) */ whenAnalysisView(analysis: DirectLineMeasurementAnalysis): Promise; /** * Gets the analysis view created for the given analysis object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenAnalysisView) */ whenAnalysisView(analysis: AreaMeasurementAnalysis): Promise; /** * Gets the analysis view created for the given analysis object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenAnalysisView) */ whenAnalysisView(analysis: SliceAnalysis): Promise; /** * Gets the analysis view created for the given analysis object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenAnalysisView) */ whenAnalysisView(analysis: DimensionAnalysis): Promise; /** * Gets the analysis view created for the given analysis object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenAnalysisView) */ whenAnalysisView(analysis: | AreaMeasurementAnalysis | DimensionAnalysis | DirectLineMeasurementAnalysis | LineOfSightAnalysis | SliceAnalysis): Promise< | AreaMeasurementAnalysisView3D | DimensionAnalysisView | DirectLineMeasurementAnalysisView3D | LineOfSightAnalysisView3D | SliceAnalysisView3D >; } interface SceneViewProperties extends ViewProperties, BreakpointsOwnerProperties, PopupViewProperties { /** * Allows the view to be partially or fully transparent when composited with the webpage elements behind it. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#alphaCompositingEnabled) */ alphaCompositingEnabled?: boolean; /** * Allows for adding analyses directly to the default analyses in the View. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#analyses) */ analyses?: CollectionProperties< | DimensionAnalysisProperties | DirectLineMeasurementAnalysisProperties | AreaMeasurementAnalysisProperties | (SliceAnalysisProperties & { type: "slice" }) | LineOfSightAnalysisProperties >; /** * The observation point from which the visible portion (or perspective) of the SceneView is determined. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera) */ camera?: CameraProperties; /** * Represents the view's center point; when setting the center you may pass a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance or an array of numbers representing at longitude/latitude pair (`[-100.4593, 36.9014]`). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center) */ center?: (PointProperties & { type: "point" }) | number[]; /** * Represents an optional clipping area used to define the visible [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of a local scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#clippingArea) */ clippingArea?: ExtentProperties; /** * Specifies constraints for [Camera tilt](esri-Camera.html#tilt) and altitude that may be applied to the SceneView. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ constraints?: SceneViewConstraintsProperties; /** * Specifies various properties of the environment's visualization in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ environment?: SceneViewEnvironmentProperties; /** * The extent represents the visible portion of a [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) within the view as an instance of [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#extent) */ extent?: ExtentProperties; /** * Applies a display filter on the view for a specific set of floor levels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#floors) */ floors?: CollectionProperties; /** * Options for configuring the highlight. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlightOptions) */ highlightOptions?: HighlightOptions; /** * SceneView can draw scenes in three different quality modes: `high`, `medium` and `low`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#qualityProfile) */ qualityProfile?: "low" | "medium" | "high"; /** * Represents an approximation of the map scale at the center of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale) */ scale?: number; /** * The viewing mode (`local` or `global`). * * @default global * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewingMode) */ viewingMode?: "global" | "local"; /** * Represents the current view as a [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) or point of observation on the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint) */ viewpoint?: ViewpointProperties; /** * Represents the level of detail (LOD) at the center of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom) */ zoom?: number; } export type EasingFunction = (t: number, duration: number) => number; /** * Animation options for the [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#GoToOptions3D) */ export interface GoToOptions3D { /** * Indicates if the transition to the new view should be animated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#GoToOptions3D) */ animate?: boolean; /** * Increases or decreases the animation speed by the specified factor. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#GoToOptions3D) */ speedFactor?: number; /** * Set the exact duration (in milliseconds) of the animation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#GoToOptions3D) */ duration?: number; /** * The maximum allowed duration (in milliseconds) of the animation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#GoToOptions3D) */ maxDuration?: number; /** * The easing function to use for the animation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#GoToOptions3D) */ easing?: | "linear" | "in-cubic" | "out-cubic" | "in-out-cubic" | "in-expo" | "out-expo" | "in-out-expo" | "in-out-coast-quadratic" | EasingFunction; /** * An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to abort the animation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#GoToOptions3D) */ signal?: AbortSignal; } /** * The target location/viewpoint to animate to in the [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#GoToTarget3D) */ export type GoToTarget3D = | number[] | Geometry | Geometry[] | Collection | Graphic | Graphic[] | Collection | Camera | Viewpoint | any; /** * Object specification for the graphic hit result returned in [HitTestResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult) of the [hitTest()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#GraphicHit) */ export interface SceneViewGraphicHit { type: "graphic"; /** * A graphic present in the view that intersects the input screen coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#GraphicHit) */ graphic: Graphic; /** * The distance from the camera position to the point geometry hit on this graphic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#GraphicHit) */ distance: number; /** * The layer that contains the feature/graphic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#GraphicHit) */ layer: Layer; /** * The point geometry in the spatial reference of the view corresponding with the input screen coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#GraphicHit) */ mapPoint: Point; } /** * Object specification for the result of the [hitTest()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult) */ export interface SceneViewHitTestResult { /** * An array of result objects returned from the [hitTest()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest) when the location of the input screen coordinates intersect features in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult) */ results: SceneViewViewHit[]; /** * Ground intersection result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult) */ ground: HitTestResultGround; /** * The screen coordinates (or native mouse event) of the click on the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult) */ screenPoint: SceneViewScreenPoint | MouseEvent; } /** * A layer or graphic to be used in [toMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#toMap) and [hitTest](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest) filter options. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#IntersectItem) */ export type IntersectItem = Graphic | Layer | BuildingSublayer; /** * Object specification for the media hit results returned from [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html) in [HitTestResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult) of the [hitTest()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#MediaHit) */ export interface SceneViewMediaHit { type: "media"; /** * An element representing a media element in [MediaLayer.source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html#source) that intersects the input screen coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#MediaHit) */ element: ImageElement | VideoElement; /** * The distance from the camera position to the point geometry hit on this graphic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#MediaHit) */ distance: number; /** * The media layer that contains the element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#MediaHit) */ layer: MediaLayer; /** * The point geometry in the spatial reference of the view corresponding with the input screen coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#MediaHit) */ mapPoint: Point; /** * _Since 4.28_ An object representing a point on the element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#MediaHit) */ sourcePoint: SourcePoint; } /** * Object specification for the route hit results returned from [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html) in [HitTestResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult) of the [hitTest()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#RouteHit) */ export interface SceneViewRouteHit { type: "route"; /** * The route layer that contains the element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#RouteHit) */ layer: RouteLayer; /** * The point geometry in the spatial reference of the view corresponding with the input screen coordinates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#RouteHit) */ mapPoint: Point; /** * The route hit test will contain all intersecting network elements which, includes one of the following: DirectionLine, DirectionPoint, PointBarrier, PolylineBarrier, PolygonBarrier, Stop, or RouteInfo. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#RouteHit) */ networkFeature: DirectionLine | DirectionPoint | PointBarrier | PolygonBarrier | PolygonBarrier | RouteInfo | Stop; } export interface SceneViewConstraintsProperties { /** * Specifies a constraint on the minimum and maximum allowed camera altitude. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ altitude?: SceneViewConstraintsAltitudeProperties; /** * Specifies the near and far webgl clip distances. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ clipDistance?: SceneViewConstraintsClipDistanceProperties; /** * Specifies a constraint on the amount of allowed tilting of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ tilt?: SceneViewConstraintsTiltProperties; } export interface SceneViewConstraints extends AnonymousAccessor { /** * Specifies a constraint on the minimum and maximum allowed camera altitude. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ altitude?: SceneViewConstraintsAltitude; /** * Specifies the near and far webgl clip distances. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ clipDistance?: SceneViewConstraintsClipDistance; /** * Specifies a constraint on the amount of allowed tilting of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ tilt?: SceneViewConstraintsTilt; } export interface SceneViewConstraintsAltitudeProperties { /** * The minimum allowed camera altitude (in meters). * * @default -∞ * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ min?: number; /** * The maximum allowed camera altitude (in meters). * * @default EARTH_RADIUS * 4 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ max?: number; } export interface SceneViewConstraintsAltitude extends AnonymousAccessor { /** * The minimum allowed camera altitude (in meters). * * @default -∞ * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ min?: number; /** * The maximum allowed camera altitude (in meters). * * @default EARTH_RADIUS * 4 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ max?: number; } export interface SceneViewConstraintsClipDistanceProperties { /** * The near clip distance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ near?: number; /** * The far clip distance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ far?: number; /** * Specifies the mode of the constraint which is either `auto` or `manual`. * * @default auto * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ mode?: "auto" | "manual"; } export interface SceneViewConstraintsClipDistance extends AnonymousAccessor { /** * The near clip distance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ near?: number; /** * The far clip distance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ far?: number; /** * Specifies the mode of the constraint which is either `auto` or `manual`. * * @default auto * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ mode?: "auto" | "manual"; } export interface SceneViewConstraintsTiltProperties { /** * Specifies the maximum amount of tilt (in degrees) allowed in the view and may range from 0.5 to 179.5 degrees. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ max?: number; /** * Specifies the mode of the constraint. * * @default auto * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ mode?: "auto" | "manual"; } export interface SceneViewConstraintsTilt extends AnonymousAccessor { /** * Specifies the maximum amount of tilt (in degrees) allowed in the view and may range from 0.5 to 179.5 degrees. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ max?: number; /** * Specifies the mode of the constraint. * * @default auto * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ mode?: "auto" | "manual"; } export interface SceneViewEnvironmentProperties { /** * Specifies how the background of the scene (which lies behind sky, stars and atmosphere) should be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ background?: BackgroundProperties; /** * Indicates the type of lighting in the scene. * * @default SunLighting * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ lighting?: (SunLightingProperties & { type?: "sun" }) | (VirtualLightingProperties & { type: "virtual" }); /** * Indicates whether atmosphere visualization is enabled. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ atmosphereEnabled?: boolean; /** * Atmosphere conditions of the scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ atmosphere?: SceneViewEnvironmentAtmosphereProperties; /** * Indicates the type of weather visualization in the scene. * * @default SunnyWeather * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ weather?: | (SunnyWeatherProperties & { type: "sunny" }) | (CloudyWeatherProperties & { type: "cloudy" }) | (RainyWeatherProperties & { type: "rainy" }) | (SnowyWeatherProperties & { type: "snowy" }) | (FoggyWeatherProperties & { type: "foggy" }); /** * Indicates whether stars visualization is enabled. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ starsEnabled?: boolean; } export interface SceneViewEnvironment extends AnonymousAccessor { /** * Specifies how the background of the scene (which lies behind sky, stars and atmosphere) should be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ background?: Background; /** * Indicates the type of lighting in the scene. * * @default SunLighting * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ lighting?: SunLighting | VirtualLighting; /** * Indicates whether atmosphere visualization is enabled. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ atmosphereEnabled?: boolean; /** * Atmosphere conditions of the scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ atmosphere?: SceneViewEnvironmentAtmosphere; /** * Indicates the type of weather visualization in the scene. * * @default SunnyWeather * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ weather?: SunnyWeather | CloudyWeather | RainyWeather | SnowyWeather | FoggyWeather; /** * Indicates whether stars visualization is enabled. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ starsEnabled?: boolean; } export interface SceneViewEnvironmentAtmosphereProperties { /** * Indicates the quality of the atmosphere visualization. * * @default low * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ quality?: "low" | "high"; } export interface SceneViewEnvironmentAtmosphere extends AnonymousAccessor { /** * Indicates the quality of the atmosphere visualization. * * @default low * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ quality?: "low" | "high"; } export interface SceneViewHitTestOptions { /** * A list of layers and graphics to include for intersection testing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest) */ include?: | (IntersectItem | Collection | IntersectItem[] | Ground)[] | Collection | IntersectItem; /** * A list of layers and graphics to include for intersection testing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest) */ exclude?: | (IntersectItem | Collection | IntersectItem[] | Ground)[] | Collection | IntersectItem; } export interface SceneViewTakeScreenshotOptions { /** * The format of the resulting encoded data url. * * @default png * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot) */ format?: "jpg" | "png"; /** * The quality (0 to 100) of the encoded image when format is `jpg`. * * @default 98 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot) */ quality?: number; /** * The width of the screenshot (defaults to the area width). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot) */ width?: number; /** * The height of the screenshot (defaults to the area height). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot) */ height?: number; /** * Specifies whether to take a screenshot of a specific area of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot) */ area?: SceneViewTakeScreenshotOptionsArea; /** * Indicates whether view padding should be ignored. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot) */ ignorePadding?: boolean; } export interface SceneViewTakeScreenshotOptionsArea { /** * The x coordinate of the area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot) */ x?: number; /** * The y coordinate of the area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot) */ y?: number; /** * The width of the area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot) */ width?: number; /** * The height of the area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot) */ height?: number; } export interface SceneViewToMapOptions { /** * A list of layers and graphics to include for intersection testing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#toMap) */ include?: | (IntersectItem | Collection | IntersectItem[] | Ground)[] | Collection | IntersectItem; /** * A list of layers and graphics to include for intersection testing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#toMap) */ exclude?: | (IntersectItem | Collection | IntersectItem[] | Ground)[] | Collection | IntersectItem; } /** * An object representing a point on the screen. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#ScreenPoint) */ export interface SceneViewScreenPoint { /** * The x coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#ScreenPoint) */ x: number; /** * The y coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#ScreenPoint) */ y: number; } /** * Object returned when [takeScreenshot()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot) promise resolves: * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#Screenshot) */ export interface SceneViewScreenshot { /** * A data url representing the screenshot. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#Screenshot) */ dataUrl: string; /** * The raw RGBA image data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#Screenshot) */ data: ImageData; } /** * Object specification for the result returned in [HitTestResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult) of the [hitTest()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#ViewHit) */ export type SceneViewViewHit = SceneViewGraphicHit | SceneViewMediaHit | SceneViewRouteHit; export interface HitTestResultGround { /** * The point at which the ground was hit while performing the hitTest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult) */ mapPoint: Point; /** * The distance from camera position to the ground hit. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult) */ distance: number; } /** * Contains utilities for working with colors in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-support-colorUtils.html) */ interface colorUtils { /** * Returns the average color of the view's background within the view's [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#extent). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-support-colorUtils.html#getBackgroundColor) */ getBackgroundColor(view: MapView | SceneView): Promise; /** * This method inspects the basemap and background of a MapView and returns either `light` or `dark` as the theme of the background depending on if the average color of the basemap and the view's background is light or dark. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-support-colorUtils.html#getBackgroundColorTheme) */ getBackgroundColorTheme(view: MapView | SceneView): Promise<"light" | "dark">; } export const colorUtils: colorUtils; export class Theme extends Accessor { /** * The base color used to render temporary graphics in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Theme.html#accentColor) */ accentColor: Color; /** * The base color used to render temporary labels in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Theme.html#textColor) */ textColor: Color; /** * This class is used by the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) to define the base colors used by widgets and components to render temporary graphics and labels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Theme.html) */ constructor(properties?: ThemeProperties); } interface ThemeProperties { /** * The base color used to render temporary graphics in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Theme.html#accentColor) */ accentColor?: Color | number[] | string; /** * The base color used to render temporary labels in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-Theme.html#textColor) */ textColor?: Color | number[] | string; } export class DefaultUI extends UI { /** * An array of strings representing the default widgets visible when a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) is created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-DefaultUI.html#components) */ components: string[]; /** * The DefaultUI class exposes the default [widget](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html) [components](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-DefaultUI.html#components) available in either a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-DefaultUI.html) */ constructor(properties?: DefaultUIProperties); } interface DefaultUIProperties extends UIProperties { /** * An array of strings representing the default widgets visible when a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) is created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-DefaultUI.html#components) */ components?: string[]; } export class UI extends Accessor { /** * The HTML Element that contains the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#container) */ container: HTMLElement; /** * The height of the UI container. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#height) */ readonly height: number; /** * Defines the padding for the UI from the top, left, right, and bottom sides of the container or [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * @default { left: 15, top: 15, right: 15, bottom: 15 } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#padding) */ padding: any | number; /** * The view associated with the UI components. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#view) */ view: MapView | SceneView; /** * The width of the UI container. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#width) */ readonly width: number; /** * This class provides a simple interface for [adding](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#add), [moving](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#move) and [removing](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#remove) components from a view's user interface (UI). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html) */ constructor(properties?: UIProperties); /** * Adds one or more HTML component(s) or [widgets](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html) to the UI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#add) */ add(component: Widget | HTMLElement | string | any[] | UIAddComponent, position?: string | UIAddPosition): void; /** * Removes all components from a given position. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#empty) */ empty(position?: | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "top-leading" | "top-left" | "top-right" | "top-trailing" | "manual"): void; /** * Find a component by widget or DOM ID. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#find) */ find(id: string): HTMLElement | Widget; /** * Returns all widgets and/or HTML elements in the view, or only components at specified positions in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#getComponents) */ getComponents(position?: UIPosition | UIPosition[]): (Widget | HTMLElement)[]; /** * Moves one or more UI component(s) to the specified position. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#move) */ move(component: Widget | HTMLElement | string | any[] | UIMoveComponent, position?: string | UIMovePosition): void; /** * Removes one or more HTML component(s) or [widgets](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html) from the UI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#remove) */ remove(component: Widget | HTMLElement | string | any[]): void; } interface UIProperties { /** * The HTML Element that contains the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#container) */ container?: HTMLElement; /** * Defines the padding for the UI from the top, left, right, and bottom sides of the container or [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * @default { left: 15, top: 15, right: 15, bottom: 15 } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#padding) */ padding?: any | number; /** * The view associated with the UI components. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } export interface UIAddComponent { /** * The component to add to the UI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#add) */ component: Widget | HTMLElement | string; /** * The position in the view at which to add the component. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#add) */ position?: | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "top-leading" | "top-left" | "top-right" | "top-trailing" | "manual"; /** * The placement index of the component. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#add) */ index?: number; } export interface UIAddPosition { /** * The position in the view at which to add the component. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#add) */ position?: | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "top-leading" | "top-left" | "top-right" | "top-trailing" | "manual"; /** * The placement index of the component(s). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#add) */ index?: number; } export interface UIMoveComponent { /** * The component to move. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#move) */ component: Widget | HTMLElement | string; /** * The destination position. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#move) */ position?: | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "top-leading" | "top-left" | "top-right" | "top-trailing" | "manual"; /** * The placement index of the component. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#move) */ index?: number; } export interface UIMovePosition { /** * The position in the view at which to add the component. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#move) */ position?: | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "top-leading" | "top-left" | "top-right" | "top-trailing" | "manual"; /** * The placement index of the component(s). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#move) */ index?: number; } /** * The UI position of an element in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#UIPosition) */ export type UIPosition = | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "top-leading" | "top-left" | "top-right" | "top-trailing" | "manual"; export interface View extends Accessor, corePromise, Evented, DOMContainer, PopupView { } export class View { /** * Collection containing a flat list of all the created [LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) related to the basemap, operational layers, and group layers in this view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#allLayerViews) */ allLayerViews: Collection; /** * Represents an ongoing view animation initialized by [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#animation) */ animation: ViewAnimation; /** * Represents the view for a single basemap after it has been added to the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#basemapView) */ basemapView: BasemapView; /** * A fatal [error](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html) returned when the view loses its WebGL context. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#fatalError) */ fatalError: Error; /** * Allows for adding [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) directly to the default graphics in the View. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#graphics) */ graphics: Collection; /** * Options to configure input handling of the View. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#input) */ readonly input: Input; /** * Indication whether the view is being interacted with (for example when panning or by an interactive tool). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#interacting) */ readonly interacting: boolean; /** * A collection containing a hierarchical list of all the created [LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of the [operational layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#layerViews) */ layerViews: Collection; /** * The magnifier allows for showing a portion of the view as a magnifier image on top of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#magnifier) */ readonly magnifier: Magnifier; /** * An instance of a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) object to display in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#map) */ map: Map; /** * Indication whether the view is being navigated (for example when panning). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#navigating) */ readonly navigating: boolean; /** * Options to configure the navigation behavior of the View. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#navigation) */ navigation: Navigation; /** * Use the padding property to make the [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#center), and [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#extent), etc. * * @default {left: 0, top: 0, right: 0, bottom: 0} * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#padding) */ padding: ViewPadding; /** * When `true`, this property indicates whether the view successfully satisfied all dependencies, signaling that the following conditions are met. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#ready) */ readonly ready: boolean; /** * Represents the current value of one pixel in the unit of the view's [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#spatialReference). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#resolution) */ readonly resolution: number; /** * The spatial reference of the view. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#spatialReference) */ spatialReference: SpatialReference; /** * Indication whether the view is animating, being navigated with or resizing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#stationary) */ readonly stationary: boolean; /** * This property specifies the base colors used by some widgets and components to render graphics and labels. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#theme) */ theme: Theme; /** * The view's time extent. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#timeExtent) */ timeExtent: TimeExtent; /** * The type of the view is either `2d` (indicating a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html)) or `3d` (indicating a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#type) */ readonly type: string; /** * Indicates whether the view is being updated by additional data requests to the network, or by processing received data. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#updating) */ readonly updating: boolean; /** * Contains the collection of active views on the page. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#views) */ static readonly views: Collection; /** * A view provides the means of viewing and interacting with the components of a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) */ constructor(properties?: ViewProperties); /** * Destroys the view, and any associated resources, including its [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#map), [popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#popup), and [UI](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#ui) elements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#destroy) */ destroy(): void; /** * Sets the focus on the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#focus) */ focus(): void; /** * Call this method to clear any [fatal errors](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#fatalError) resulting from a lost WebGL context. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#tryFatalErrorRecovery) */ tryFatalErrorRecovery(): void; /** * Gets the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) created on the view for the given layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#whenLayerView) */ whenLayerView(layer: PointCloudLayer): Promise; /** * Gets the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) created on the view for the given layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#whenLayerView) */ whenLayerView(layer: StreamLayer): Promise; /** * Gets the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) created on the view for the given layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#whenLayerView) */ whenLayerView(layer: WFSLayer): Promise; /** * Gets the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) created on the view for the given layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#whenLayerView) */ whenLayerView(layer: OGCFeatureLayer): Promise; /** * Gets the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) created on the view for the given layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#whenLayerView) */ whenLayerView(layer: FeatureLayer): Promise; /** * Gets the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) created on the view for the given layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#whenLayerView) */ whenLayerView(layer: CSVLayer): Promise; /** * Gets the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) created on the view for the given layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#whenLayerView) */ whenLayerView(layer: GeoJSONLayer): Promise; /** * Gets the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) created on the view for the given layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#whenLayerView) */ whenLayerView(layer: GeoRSSLayer): Promise; /** * Gets the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) created on the view for the given layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#whenLayerView) */ whenLayerView(layer: GraphicsLayer): Promise; /** * Gets the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) created on the view for the given layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#whenLayerView) */ whenLayerView(layer: ImageryLayer): Promise; /** * Gets the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) created on the view for the given layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#whenLayerView) */ whenLayerView(layer: KMLLayer): Promise; /** * Gets the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) created on the view for the given layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#whenLayerView) */ whenLayerView(layer: SceneLayer): Promise; /** * Gets the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) created on the view for the given layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#whenLayerView) */ whenLayerView(layer: DimensionLayer): Promise; /** * Gets the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) created on the view for the given layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#whenLayerView) */ whenLayerView(layer: Layer): Promise; on(name: "resize", eventHandler: ViewResizeEventHandler): IHandle; on(name: "layerview-create", eventHandler: ViewLayerviewCreateEventHandler): IHandle; on(name: "layerview-create-error", eventHandler: ViewLayerviewCreateErrorEventHandler): IHandle; on(name: "layerview-destroy", eventHandler: ViewLayerviewDestroyEventHandler): IHandle; on(name: "click", eventHandler: ViewClickEventHandler): IHandle; on(name: "click", modifiers: string[], eventHandler: ViewClickEventHandler): IHandle; on(name: "double-click", eventHandler: ViewDoubleClickEventHandler): IHandle; on(name: "double-click", modifiers: string[], eventHandler: ViewDoubleClickEventHandler): IHandle; on(name: "immediate-double-click", eventHandler: ViewImmediateDoubleClickEventHandler): IHandle; on(name: "immediate-double-click", modifiers: string[], eventHandler: ViewImmediateDoubleClickEventHandler): IHandle; on(name: "immediate-click", eventHandler: ViewImmediateClickEventHandler): IHandle; on(name: "immediate-click", modifiers: string[], eventHandler: ViewImmediateClickEventHandler): IHandle; on(name: "hold", eventHandler: ViewHoldEventHandler): IHandle; on(name: "hold", modifiers: string[], eventHandler: ViewHoldEventHandler): IHandle; on(name: "drag", eventHandler: ViewDragEventHandler): IHandle; on(name: "drag", modifiers: string[], eventHandler: ViewDragEventHandler): IHandle; on(name: "mouse-wheel", eventHandler: ViewMouseWheelEventHandler): IHandle; on(name: "mouse-wheel", modifiers: string[], eventHandler: ViewMouseWheelEventHandler): IHandle; on(name: "key-down", eventHandler: ViewKeyDownEventHandler): IHandle; on(name: "key-down", modifiers: string[], eventHandler: ViewKeyDownEventHandler): IHandle; on(name: "key-up", eventHandler: ViewKeyUpEventHandler): IHandle; on(name: "key-up", modifiers: string[], eventHandler: ViewKeyUpEventHandler): IHandle; on(name: "pointer-down", eventHandler: ViewPointerDownEventHandler): IHandle; on(name: "pointer-down", modifiers: string[], eventHandler: ViewPointerDownEventHandler): IHandle; on(name: "pointer-move", eventHandler: ViewPointerMoveEventHandler): IHandle; on(name: "pointer-move", modifiers: string[], eventHandler: ViewPointerMoveEventHandler): IHandle; on(name: "pointer-up", eventHandler: ViewPointerUpEventHandler): IHandle; on(name: "pointer-up", modifiers: string[], eventHandler: ViewPointerUpEventHandler): IHandle; on(name: "pointer-enter", eventHandler: ViewPointerEnterEventHandler): IHandle; on(name: "pointer-enter", modifiers: string[], eventHandler: ViewPointerEnterEventHandler): IHandle; on(name: "pointer-leave", eventHandler: ViewPointerLeaveEventHandler): IHandle; on(name: "pointer-leave", modifiers: string[], eventHandler: ViewPointerLeaveEventHandler): IHandle; on(name: "focus", eventHandler: ViewFocusEventHandler): IHandle; on(name: "blur", eventHandler: ViewBlurEventHandler): IHandle; } interface ViewProperties extends DOMContainerProperties, PopupViewProperties { /** * Collection containing a flat list of all the created [LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) related to the basemap, operational layers, and group layers in this view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#allLayerViews) */ allLayerViews?: CollectionProperties; /** * Represents an ongoing view animation initialized by [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#animation) */ animation?: ViewAnimationProperties; /** * Represents the view for a single basemap after it has been added to the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#basemapView) */ basemapView?: BasemapViewProperties; /** * A fatal [error](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html) returned when the view loses its WebGL context. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#fatalError) */ fatalError?: Error; /** * Allows for adding [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) directly to the default graphics in the View. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#graphics) */ graphics?: CollectionProperties; /** * A collection containing a hierarchical list of all the created [LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of the [operational layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#layerViews) */ layerViews?: CollectionProperties; /** * An instance of a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) object to display in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#map) */ map?: MapProperties; /** * Options to configure the navigation behavior of the View. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#navigation) */ navigation?: NavigationProperties; /** * Use the padding property to make the [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#center), and [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#extent), etc. * * @default {left: 0, top: 0, right: 0, bottom: 0} * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#padding) */ padding?: ViewPadding; /** * The spatial reference of the view. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * This property specifies the base colors used by some widgets and components to render graphics and labels. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#theme) */ theme?: ThemeProperties; /** * The view's time extent. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#timeExtent) */ timeExtent?: TimeExtentProperties; } export interface ViewBlurEvent { native: any; target: View; } export interface ViewClickEvent { button: number; buttons: 0 | 1 | 2; mapPoint: Point; native: any; stopPropagation: Function; timestamp: number; type: "click"; x: number; y: number; } export interface ViewDoubleClickEvent { button: number; buttons: 0 | 1 | 2; mapPoint: Point; native: any; stopPropagation: Function; timestamp: number; type: "double-click"; x: number; y: number; } export interface ViewDragEvent { action: "start" | "added" | "update" | "removed" | "end"; angle: number; button: 0 | 1 | 2; buttons: number; native: any; origin: ViewDragEventOrigin; radius: number; stopPropagation: Function; timestamp: number; type: "drag"; x: number; y: number; } export interface ViewFocusEvent { native: any; target: View; } /** * Options for configuring the highlight on [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#highlightOptions), [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlightOptions) or on layer views. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#HighlightOptions) */ export interface HighlightOptions { /** * The color of the highlight fill. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#HighlightOptions) */ color?: Color; /** * The color of the halo surrounding the highlight. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#HighlightOptions) */ haloColor?: Color; /** * The opacity of the highlight halo. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#HighlightOptions) */ haloOpacity?: number; /** * The opacity of the fill (area within the halo). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#HighlightOptions) */ fillOpacity?: number; /** * The color of the highlighted feature's shadow in [3D SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#HighlightOptions) */ shadowColor?: Color; /** * The opacity of the highlighted feature's shadow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#HighlightOptions) */ shadowOpacity?: number; /** * Defines the intensity of the shadow area obtained by overlapping the shadow of the highlighted feature and the shadow of other objects in [3D SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#HighlightOptions) */ shadowDifference?: number; } export interface ViewHoldEvent { button: 0 | 1 | 2; buttons: number; mapPoint: Point; native: any; stopPropagation: Function; timestamp: number; type: "hold"; x: number; y: number; } export interface ViewImmediateClickEvent { button: 0 | 1 | 2; buttons: number; mapPoint: Point; native: any; stopPropagation: Function; timestamp: number; type: "immediate-click"; x: number; y: number; } export interface ViewImmediateDoubleClickEvent { button: 0 | 1 | 2; buttons: number; mapPoint: Point; native: any; stopPropagation: Function; timestamp: number; type: "immediate-double-click"; x: number; y: number; } export interface ViewKeyDownEvent { key: string; native: any; repeat: boolean; stopPropagation: Function; timestamp: number; type: "key-down"; } export interface ViewKeyUpEvent { key: string; native: any; stopPropagation: Function; timestamp: number; type: "key-up"; } export interface ViewLayerviewCreateErrorEvent { error: Error; layer: Layer; } export interface ViewLayerviewCreateEvent { layer: Layer; layerView: LayerView; } export interface ViewLayerviewDestroyEvent { layer: Layer; layerView: LayerView; } export interface ViewMouseWheelEvent { deltaY: number; native: any; stopPropagation: Function; timestamp: number; type: "mouse-wheel"; x: number; y: number; } export interface ViewPointerDownEvent { button: number; buttons: number; native: any; pointerId: number; pointerType: "mouse" | "touch"; stopPropagation: Function; timestamp: number; type: "pointer-down"; x: number; y: number; } export interface ViewPointerEnterEvent { button: number; buttons: number; native: any; pointerId: number; pointerType: "mouse" | "touch"; stopPropagation: Function; timestamp: number; type: "pointer-enter"; x: number; y: number; } export interface ViewPointerLeaveEvent { button: number; buttons: number; native: any; pointerId: number; pointerType: "mouse" | "touch"; stopPropagation: Function; timestamp: number; type: "pointer-leave"; x: number; y: number; } export interface ViewPointerMoveEvent { button: number; buttons: number; native: any; pointerId: number; pointerType: "mouse" | "touch"; stopPropagation: Function; timestamp: number; type: "pointer-move"; x: number; y: number; } export interface ViewPointerUpEvent { button: number; buttons: number; native: any; pointerId: number; pointerType: "mouse" | "touch"; stopPropagation: Function; timestamp: number; type: "pointer-up"; x: number; y: number; } export interface ViewResizeEvent { height: number; oldHeight: number; oldWidth: number; width: number; } export interface ViewPadding { /** * The left padding (in pixels). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#padding) */ left?: number; /** * The top padding (in pixels). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#padding) */ top?: number; /** * The right padding (in pixels). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#padding) */ right?: number; /** * The bottom padding (in pixels). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#padding) */ bottom?: number; } export interface ViewAnimation extends Accessor, corePromise { } export class ViewAnimation { /** * The state of the animation. * * @default running * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ViewAnimation.html#state) */ readonly state: "running" | "finished" | "stopped" | "waiting-for-target"; /** * The target of the animation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ViewAnimation.html#target) */ target: Viewpoint; /** * Contains a [state](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ViewAnimation.html#state) property used for checking the state of the animation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ViewAnimation.html) */ constructor(properties?: ViewAnimationProperties); /** * Finishes the view animation by immediately going to the target and sets the state of the animation to `finished`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ViewAnimation.html#finish) */ finish(): void; /** * Stops the view animation at its current state and sets the state of the animation to `stopped`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ViewAnimation.html#stop) */ stop(): void; } interface ViewAnimationProperties { /** * The target of the animation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ViewAnimation.html#target) */ target?: ViewpointProperties; } export interface ViewDragEventOrigin { x: number; y: number; } export class Search extends Accessor { /** * Indicates whether the place finder is enabled in the web scene or the web map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-Search.html#addressSearchEnabled) */ addressSearchEnabled: boolean; /** * Whether search functionality is enabled in the web scene or the web map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-Search.html#enabled) */ enabled: boolean; /** * The hint provided with the search dialog. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-Search.html#hintText) */ hintText: string; /** * A collection of layers to be included in search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-Search.html#layers) */ layers: Collection; /** * A collection of tables to be included in search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-Search.html#tables) */ tables: Collection; /** * Represents the search parameters set within the web scene or the web map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-Search.html) */ constructor(properties?: SearchProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-Search.html#clone) */ clone(): Search; } interface SearchProperties { /** * Indicates whether the place finder is enabled in the web scene or the web map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-Search.html#addressSearchEnabled) */ addressSearchEnabled?: boolean; /** * Whether search functionality is enabled in the web scene or the web map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-Search.html#enabled) */ enabled?: boolean; /** * The hint provided with the search dialog. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-Search.html#hintText) */ hintText?: string; /** * A collection of layers to be included in search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-Search.html#layers) */ layers?: CollectionProperties; /** * A collection of tables to be included in search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-Search.html#tables) */ tables?: CollectionProperties; } export class SearchLayer extends Accessor { /** * The field to use for search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchLayer.html#field) */ field: SearchLayerField; /** * The id of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchLayer.html#id) */ id: string; /** * The sub layer index. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchLayer.html#subLayer) */ subLayer: number; /** * Represents a layer to be included in search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchLayer.html) */ constructor(properties?: SearchLayerProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchLayer.html#clone) */ clone(): SearchLayer; } interface SearchLayerProperties { /** * The field to use for search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchLayer.html#field) */ field?: SearchLayerFieldProperties; /** * The id of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchLayer.html#id) */ id?: string; /** * The sub layer index. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchLayer.html#subLayer) */ subLayer?: number; } export class SearchLayerField extends Accessor { /** * Whether or not the field is an exact match. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchLayerField.html#exactMatch) */ exactMatch: boolean; /** * The name of the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchLayerField.html#name) */ name: string; /** * The data type of the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchLayerField.html#type) */ type: | "small-integer" | "integer" | "single" | "double" | "long" | "string" | "date" | "oid" | "geometry" | "blob" | "raster" | "guid" | "global-id" | "xml"; /** * Represents the field of a layer to use for search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchLayerField.html) */ constructor(properties?: SearchLayerFieldProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchLayerField.html#clone) */ clone(): SearchLayerField; } interface SearchLayerFieldProperties { /** * Whether or not the field is an exact match. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchLayerField.html#exactMatch) */ exactMatch?: boolean; /** * The name of the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchLayerField.html#name) */ name?: string; /** * The data type of the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchLayerField.html#type) */ type?: | "small-integer" | "integer" | "single" | "double" | "long" | "string" | "date" | "oid" | "geometry" | "blob" | "raster" | "guid" | "global-id" | "xml"; } export class SearchTable extends Accessor { /** * The field to use for search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchTable.html#field) */ field: SearchTableField; /** * The id of the table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchTable.html#id) */ id: string; /** * Represents a table to be included in search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchTable.html) */ constructor(properties?: SearchTableProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchTable.html#clone) */ clone(): SearchTable; } interface SearchTableProperties { /** * The field to use for search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchTable.html#field) */ field?: SearchTableFieldProperties; /** * The id of the table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchTable.html#id) */ id?: string; } export class SearchTableField extends Accessor { /** * Whether or not the field is an exact match. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchTableField.html#exactMatch) */ exactMatch: boolean; /** * The name of the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchTableField.html#name) */ name: string; /** * The data type of the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchTableField.html#type) */ type: | "small-integer" | "integer" | "single" | "double" | "long" | "string" | "date" | "oid" | "geometry" | "blob" | "raster" | "guid" | "global-id" | "xml"; /** * Represents the field of a table to use for search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchTableField.html) */ constructor(properties?: SearchTableFieldProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchTableField.html#clone) */ clone(): SearchTableField; } interface SearchTableFieldProperties { /** * Whether or not the field is an exact match. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchTableField.html#exactMatch) */ exactMatch?: boolean; /** * The name of the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchTableField.html#name) */ name?: string; /** * The data type of the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchTableField.html#type) */ type?: | "small-integer" | "integer" | "single" | "double" | "long" | "string" | "date" | "oid" | "geometry" | "blob" | "raster" | "guid" | "global-id" | "xml"; } export class Viewing extends Accessor { /** * An object specifying the search parameters set within the web scene or web map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-Viewing.html#search) */ search: Search; /** * Represents view-specific properties of application and UI elements for the web map or web scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-Viewing.html) */ constructor(properties?: ViewingProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-Viewing.html#clone) */ clone(): Viewing; } interface ViewingProperties { /** * An object specifying the search parameters set within the web scene or web map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-Viewing.html#search) */ search?: SearchProperties; } export interface GeotriggersInfo extends Accessor, JSONSupport, Clonable { } export class GeotriggersInfo { /** * A list of Geotriggers. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-GeotriggersInfo.html#geotriggers) */ geotriggers: Geotrigger[]; /** * Information relating to a list of Geotriggers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-GeotriggersInfo.html) */ constructor(properties?: GeotriggersInfoProperties); static fromJSON(json: any): GeotriggersInfo; } interface GeotriggersInfoProperties { /** * A list of Geotriggers. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-GeotriggersInfo.html#geotriggers) */ geotriggers?: GeotriggerProperties[]; } export interface DeviceLocationFeed extends Accessor, JSONSupport, Clonable { } export class DeviceLocationFeed { /** * An optional Arcade expression that controls whether a location update will be used by a geotrigger. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-DeviceLocationFeed.html#filterExpression) */ filterExpression: geotriggersInfoExpressionInfo; /** * String indicating the type of Geotrigger feed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-DeviceLocationFeed.html#type) */ readonly type: "device-location"; /** * A Geotrigger feed which uses the device location to provide updates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-DeviceLocationFeed.html) */ constructor(properties?: DeviceLocationFeedProperties); static fromJSON(json: any): DeviceLocationFeed; } interface DeviceLocationFeedProperties { /** * An optional Arcade expression that controls whether a location update will be used by a geotrigger. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-DeviceLocationFeed.html#filterExpression) */ filterExpression?: geotriggersInfoExpressionInfoProperties; } export interface geotriggersInfoExpressionInfo extends Accessor, JSONSupport, Clonable { } export class geotriggersInfoExpressionInfo { /** * Optional expression in the [Arcade expression](https://developers.arcgis.com/arcade/) language. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-ExpressionInfo.html#expression) */ expression: string; /** * Optional return type of the Arcade expression. * * @default string * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-ExpressionInfo.html#returnType) */ returnType: "number" | "string"; /** * Optional title of the expression. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-ExpressionInfo.html#title) */ title: string; /** * Defines a script expression that can be used to compute values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-ExpressionInfo.html) */ constructor(properties?: geotriggersInfoExpressionInfoProperties); static fromJSON(json: any): geotriggersInfoExpressionInfo; } interface geotriggersInfoExpressionInfoProperties { /** * Optional expression in the [Arcade expression](https://developers.arcgis.com/arcade/) language. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-ExpressionInfo.html#expression) */ expression?: string; /** * Optional return type of the Arcade expression. * * @default string * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-ExpressionInfo.html#returnType) */ returnType?: "number" | "string"; /** * Optional title of the expression. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-ExpressionInfo.html#title) */ title?: string; } export interface FeatureFenceParameters extends Accessor, JSONSupport, Clonable { } export class FeatureFenceParameters { /** * An optional buffer distance to apply to fence features in meters. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FeatureFenceParameters.html#bufferDistance) */ bufferDistance: number; /** * An object defining the source for a feature layer to be used as fences. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FeatureFenceParameters.html#fenceSource) */ fenceSource: FeatureLayerSource; /** * An optional filter to reduce the features used for the parameters. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FeatureFenceParameters.html#filter) */ filter: geotriggersInfoFeatureFilter; /** * String indicating the fence parameters type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FeatureFenceParameters.html#type) */ readonly type: "features"; /** * Fence parameters for a Geotrigger that uses feature data from an online feature service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FeatureFenceParameters.html) */ constructor(properties?: FeatureFenceParametersProperties); static fromJSON(json: any): FeatureFenceParameters; } interface FeatureFenceParametersProperties { /** * An optional buffer distance to apply to fence features in meters. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FeatureFenceParameters.html#bufferDistance) */ bufferDistance?: number; /** * An object defining the source for a feature layer to be used as fences. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FeatureFenceParameters.html#fenceSource) */ fenceSource?: FeatureLayerSourceProperties; /** * An optional filter to reduce the features used for the parameters. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FeatureFenceParameters.html#filter) */ filter?: geotriggersInfoFeatureFilterProperties; } export interface geotriggersInfoFeatureFilter extends Accessor, JSONSupport, Clonable { } export class geotriggersInfoFeatureFilter { /** * An optional geometry used to filter the features from a feature table. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FeatureFilter.html#geometry) */ geometry: Geometry; /** * An optional SQL-based definition expression string that narrows the data to be used. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FeatureFilter.html#where) */ where: string; /** * Description of spatial and attribute filters that will be applied to Feature data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FeatureFilter.html) */ constructor(properties?: geotriggersInfoFeatureFilterProperties); static fromJSON(json: any): geotriggersInfoFeatureFilter; } interface geotriggersInfoFeatureFilterProperties { /** * An optional geometry used to filter the features from a feature table. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FeatureFilter.html#geometry) */ geometry?: GeometryProperties; /** * An optional SQL-based definition expression string that narrows the data to be used. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FeatureFilter.html#where) */ where?: string; } export interface FeatureLayerSource extends Accessor, JSONSupport, Clonable { } export class FeatureLayerSource { /** * A unique identifying string that must match the `id` property of a feature layer in an associated map. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FeatureLayerSource.html#layerId) */ layerId: string; /** * A URL to a service that will be used for all queries against the layer. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FeatureLayerSource.html#layerUrl) */ layerUrl: string; /** * String indicating the type of source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FeatureLayerSource.html#type) */ readonly type: "feature-layer"; /** * The source for a feature layer to be used as fences for Geotriggers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FeatureLayerSource.html) */ constructor(properties?: FeatureLayerSourceProperties); static fromJSON(json: any): FeatureLayerSource; } interface FeatureLayerSourceProperties { /** * A unique identifying string that must match the `id` property of a feature layer in an associated map. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FeatureLayerSource.html#layerId) */ layerId?: string; /** * A URL to a service that will be used for all queries against the layer. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FeatureLayerSource.html#layerUrl) */ layerUrl?: string; } export interface FenceGeotrigger extends Geotrigger, JSONSupport, Clonable { } export class FenceGeotrigger { /** * The rule that determines whether a fence polygon has been entered or exited by the geometry from a feed. * * @default enter-contains-and-exit-does-not-intersect * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FenceGeotrigger.html#enterExitRule) */ enterExitRule: | "enter-contains-and-exit-does-not-contain" | "enter-contains-and-exit-does-not-intersect" | "enter-intersects-and-exit-does-not-intersect"; /** * The feed for this Geotrigger. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FenceGeotrigger.html#feed) */ feed: DeviceLocationFeed; /** * Indicates how the geotrigger will use accuracy information from a feed. * * @default use-geometry * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FenceGeotrigger.html#feedAccuracyMode) */ feedAccuracyMode: "use-geometry" | "use-geometry-with-accuracy"; /** * Indicates the type of event that will trigger notifications for the Fence Geotrigger. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FenceGeotrigger.html#fenceNotificationRule) */ fenceNotificationRule: "enter" | "enter-or-exit" | "exit"; /** * An object defining the fences to use for this Geotrigger. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FenceGeotrigger.html#fenceParameters) */ fenceParameters: FeatureFenceParameters; /** * The name for this Geotrigger. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FenceGeotrigger.html#name) */ name: string; /** * Options that control the notification information sent to a client app when a Geotrigger condition is met. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FenceGeotrigger.html#notificationOptions) */ notificationOptions: GeotriggerNotificationOptions; /** * A condition which monitors the dynamic elements of the geotrigger feed for enter/exit against the fences defined by the Fence Parameters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FenceGeotrigger.html) */ constructor(properties?: FenceGeotriggerProperties); static fromJSON(json: any): FenceGeotrigger; } interface FenceGeotriggerProperties extends GeotriggerProperties { /** * The rule that determines whether a fence polygon has been entered or exited by the geometry from a feed. * * @default enter-contains-and-exit-does-not-intersect * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FenceGeotrigger.html#enterExitRule) */ enterExitRule?: | "enter-contains-and-exit-does-not-contain" | "enter-contains-and-exit-does-not-intersect" | "enter-intersects-and-exit-does-not-intersect"; /** * The feed for this Geotrigger. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FenceGeotrigger.html#feed) */ feed?: DeviceLocationFeedProperties; /** * Indicates how the geotrigger will use accuracy information from a feed. * * @default use-geometry * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FenceGeotrigger.html#feedAccuracyMode) */ feedAccuracyMode?: "use-geometry" | "use-geometry-with-accuracy"; /** * Indicates the type of event that will trigger notifications for the Fence Geotrigger. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FenceGeotrigger.html#fenceNotificationRule) */ fenceNotificationRule?: "enter" | "enter-or-exit" | "exit"; /** * An object defining the fences to use for this Geotrigger. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FenceGeotrigger.html#fenceParameters) */ fenceParameters?: FeatureFenceParametersProperties; /** * The name for this Geotrigger. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FenceGeotrigger.html#name) */ name?: string; /** * Options that control the notification information sent to a client app when a Geotrigger condition is met. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-FenceGeotrigger.html#notificationOptions) */ notificationOptions?: GeotriggerNotificationOptionsProperties; } export interface Geotrigger extends Accessor, JSONSupport, Clonable { } export class Geotrigger { /** * String indicating the Geotrigger condition type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-Geotrigger.html#type) */ readonly type: "fence"; /** * A Geotrigger is a condition that will be monitored against dynamic GIS data - for example using a spatial operation to check for enter/exit. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-Geotrigger.html) */ constructor(properties?: GeotriggerProperties); static fromJSON(json: any): Geotrigger; } interface GeotriggerProperties { } export interface GeotriggerNotificationOptions extends Accessor, JSONSupport, Clonable { } export class GeotriggerNotificationOptions { /** * An optional Arcade expression which can be used to configure notification information when the Geotrigger condition is met. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-GeotriggerNotificationOptions.html#expressionInfo) */ expressionInfo: geotriggersInfoExpressionInfo; /** * An optional list of strings indicating the set of possible actions resulting from this Geotrigger. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-GeotriggerNotificationOptions.html#requestedActions) */ requestedActions: string[]; /** * Options that control the notification information sent to a client app client when a Geotrigger condition is met. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-GeotriggerNotificationOptions.html) */ constructor(properties?: GeotriggerNotificationOptionsProperties); static fromJSON(json: any): GeotriggerNotificationOptions; } interface GeotriggerNotificationOptionsProperties { /** * An optional Arcade expression which can be used to configure notification information when the Geotrigger condition is met. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-GeotriggerNotificationOptions.html#expressionInfo) */ expressionInfo?: geotriggersInfoExpressionInfoProperties; /** * An optional list of strings indicating the set of possible actions resulting from this Geotrigger. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-geotriggersInfo-GeotriggerNotificationOptions.html#requestedActions) */ requestedActions?: string[]; } export interface WebMap extends Map, corePromise { } export class WebMap { /** * The applicationProperties contains the viewing properties of the WebMap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#applicationProperties) */ applicationProperties: ApplicationProperties; /** * The name of the application that authored the WebMap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#authoringApp) */ authoringApp: string; /** * The version of the application that authored the WebMap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#authoringAppVersion) */ authoringAppVersion: string; /** * An array of saved geographic extents that allow end users to quickly navigate to a particular area of interest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#bookmarks) */ bookmarks: Collection; /** * When a web map is configured as floor-aware, it has a floorInfo property defined. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#floorInfo) */ floorInfo: MapFloorInfo; /** * Information relating to a list of Geotriggers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#geotriggersInfo) */ geotriggersInfo: GeotriggersInfo; /** * The initial view of the WebMap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#initialViewProperties) */ initialViewProperties: InitialViewProperties; /** * Indicates whether the instance has loaded. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#loaded) */ readonly loaded: boolean; /** * The Error object returned if an error occurred while loading. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#loadError) */ readonly loadError: Error; /** * Represents the status of a [load](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#load) operation. * * @default not-loaded * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#loadStatus) */ readonly loadStatus: "not-loaded" | "loading" | "failed" | "loaded"; /** * The portal item from which the WebMap is loaded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#portalItem) */ portalItem: PortalItem; /** * Provides multiple slides. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#presentation) */ presentation: any; /** * The version of the source document from which the WebMap was read. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#sourceVersion) */ readonly sourceVersion: WebMapSourceVersion; /** * The URL to the thumbnail used for the webmap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#thumbnailUrl) */ thumbnailUrl: string; /** * The utilityNetworks object contains a collection of [UtilityNetworks](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html) saved on the web map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#utilityNetworks) */ utilityNetworks: Collection; /** * The widgets object contains widgets that are exposed to the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#widgets) */ widgets: Widgets; /** * Loads a [WebMap](https://doc.arcgis.com/en/arcgis-online/create-maps/make-your-first-map.htm) from [ArcGIS Online](https://www.arcgis.com/home/) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm) into a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html) */ constructor(properties?: WebMapProperties); /** * Triggers the loading of the WebMap instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#load) */ load(): Promise; /** * Loads all the externally loadable resources associated with the webmap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#loadAll) */ loadAll(): Promise; /** * Saves the webmap to its associated portal item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#save) */ save(options?: WebMapSaveOptions): Promise; /** * Saves the webmap to a new [portal item](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#saveAs) */ saveAs(portalItem: PortalItem | PortalItemProperties, options?: WebMapSaveAsOptions): Promise; /** * Update properties of the WebMap related to the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#updateFrom) */ updateFrom(view: MapView, options?: WebMapUpdateFromOptions): Promise; /** * Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#fromJSON) */ static fromJSON(json: any): any; } interface WebMapProperties extends MapProperties { /** * The applicationProperties contains the viewing properties of the WebMap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#applicationProperties) */ applicationProperties?: ApplicationPropertiesProperties; /** * The name of the application that authored the WebMap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#authoringApp) */ authoringApp?: string; /** * The version of the application that authored the WebMap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#authoringAppVersion) */ authoringAppVersion?: string; /** * An array of saved geographic extents that allow end users to quickly navigate to a particular area of interest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#bookmarks) */ bookmarks?: CollectionProperties; /** * When a web map is configured as floor-aware, it has a floorInfo property defined. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#floorInfo) */ floorInfo?: MapFloorInfoProperties; /** * Information relating to a list of Geotriggers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#geotriggersInfo) */ geotriggersInfo?: GeotriggersInfoProperties; /** * The initial view of the WebMap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#initialViewProperties) */ initialViewProperties?: InitialViewPropertiesProperties; /** * The portal item from which the WebMap is loaded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#portalItem) */ portalItem?: PortalItemProperties; /** * Provides multiple slides. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#presentation) */ presentation?: any; /** * The URL to the thumbnail used for the webmap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#thumbnailUrl) */ thumbnailUrl?: string; /** * The utilityNetworks object contains a collection of [UtilityNetworks](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html) saved on the web map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#utilityNetworks) */ utilityNetworks?: CollectionProperties; /** * The widgets object contains widgets that are exposed to the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#widgets) */ widgets?: Widgets; } export class ApplicationProperties extends Accessor { /** * View-specific properties of application and UI elements for the web map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-ApplicationProperties.html#viewing) */ viewing: Viewing; /** * Represents configuration of application and UI elements of the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-ApplicationProperties.html) */ constructor(properties?: ApplicationPropertiesProperties); } interface ApplicationPropertiesProperties { /** * View-specific properties of application and UI elements for the web map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-ApplicationProperties.html#viewing) */ viewing?: ViewingProperties; } export interface ColorBackground extends Accessor, JSONSupport { } export class ColorBackground { /** * The color of the background. * * @default black * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-background-ColorBackground.html#color) */ color: Color; /** * Represents the background color of the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html) when displayed in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-background-ColorBackground.html) */ constructor(properties?: ColorBackgroundProperties); /** * Creates a deep clone of the object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-background-ColorBackground.html#clone) */ clone(): ColorBackground; static fromJSON(json: any): ColorBackground; } interface ColorBackgroundProperties { /** * The color of the background. * * @default black * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-background-ColorBackground.html#color) */ color?: Color | number[] | string; } export interface Bookmark extends Accessor, JSONSupport, Identifiable { } export class Bookmark { /** * The name of the bookmark item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html#name) */ name: string; /** * The URL for a thumbnail image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html#thumbnail) */ thumbnail: BookmarkThumbnail; /** * The time extent of the bookmark item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html#timeExtent) */ timeExtent: TimeExtent; /** * The viewpoint of the bookmark item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html#viewpoint) */ viewpoint: Viewpoint; /** * A bookmark is a saved map extent that allows end users to quickly navigate to a particular area of interest using the [Bookmarks](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) */ constructor(properties?: BookmarkProperties); static fromJSON(json: any): Bookmark; } interface BookmarkProperties { /** * The name of the bookmark item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html#name) */ name?: string; /** * The URL for a thumbnail image. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html#thumbnail) */ thumbnail?: BookmarkThumbnail; /** * The time extent of the bookmark item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html#timeExtent) */ timeExtent?: TimeExtentProperties; /** * The viewpoint of the bookmark item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html#viewpoint) */ viewpoint?: ViewpointProperties; } export interface BookmarkThumbnail { /** * URL to a thumbnail to display. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html#thumbnail) */ url?: string; } export interface InitialViewProperties extends Accessor, Clonable { } export class InitialViewProperties { /** * The background color of the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-InitialViewProperties.html#background) */ background: ColorBackground; /** * The spatial reference of the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-InitialViewProperties.html#spatialReference) */ spatialReference: SpatialReference; /** * The initial time zone of the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-InitialViewProperties.html#timeZone) */ timeZone: string; /** * The initial viewpoint of the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-InitialViewProperties.html#viewpoint) */ viewpoint: Viewpoint; /** * Represents the initial viewing state of the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html) when displayed in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-InitialViewProperties.html) */ constructor(properties?: InitialViewPropertiesProperties); } interface InitialViewPropertiesProperties { /** * The background color of the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-InitialViewProperties.html#background) */ background?: ColorBackgroundProperties; /** * The spatial reference of the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-InitialViewProperties.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * The initial time zone of the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-InitialViewProperties.html#timeZone) */ timeZone?: string; /** * The initial viewpoint of the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-InitialViewProperties.html#viewpoint) */ viewpoint?: ViewpointProperties; } /** * Floor filtering is controlled by a configurable [floor filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#FloorFilter) */ export interface WebMapFloorFilter { /** * Indicates whether the FloorFilter is active and filtering the displayed content according to the [FloorFilter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html) selection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#FloorFilter) */ enabled: boolean; /** * Indicates whether the levels list is showing the long names from longNameField. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#FloorFilter) */ longNames: boolean; /** * Indicates whether the floor filter has been minimized to show only the levels list. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#FloorFilter) */ minimized: boolean; /** * Indicates whether the levels portion of the floor filter has been pinned to show the levels list. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#FloorFilter) */ pinnedLevels: boolean; /** * Contains the site ID for the initially selected [site](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#site) in the floor filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#FloorFilter) */ site: string; /** * Contains the facility ID for the initially selected [facility](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#facility) in the floor filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#FloorFilter) */ facility: string; /** * Contains the level ID for the initially selected floor, which is used when filtering layers by their configured floor-aware properties. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#FloorFilter) */ level: string; } /** * Time animation is controlled by a configurable [time slider](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#TimeSlider) */ export interface WebMapTimeSlider { /** * The current time extent of the time slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#TimeSlider) */ currentTimeExtent: TimeExtent; /** * The temporal extent for the entire slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#TimeSlider) */ fullTimeExtent: TimeExtent; /** * When `true`, the time slider will play its animation in a loop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#TimeSlider) */ loop: boolean; /** * The number of stops. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#TimeSlider) */ numStops: number; /** * The thumb count. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#TimeSlider) */ numThumbs: number; /** * An array of dates for the time slider widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#TimeSlider) */ stops: Date[]; /** * The time rate in milliseconds between animation steps. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#TimeSlider) */ stopDelay: number; /** * Defines regularly spaced stops on the time slider from a [TimeInterval](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeInterval.html) object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#TimeSlider) */ stopInterval: TimeInterval; } export interface WebMapSaveAsOptions { /** * The folder in which to save the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#saveAs) */ folder?: PortalFolder; /** * Allow the webmap to be saved even in the case it contains unsupported content (layers, renderers, symbols). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#saveAs) */ ignoreUnsupported?: boolean; } export interface WebMapSaveOptions { /** * When `true`, the webmap will save even if it contains unsupported content (layers, renderers, symbols). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#save) */ ignoreUnsupported?: boolean; } export interface WebMapSourceVersion { /** * The major version of the WebMap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#sourceVersion) */ major: number; /** * The minor version of the WebMap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#sourceVersion) */ minor: number; } export interface WebMapUpdateFromOptions { /** * When `true`, the view's background will not be updated for the webmap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#updateFrom) */ backgroundExcluded?: boolean; /** * When `true`, the initial [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-InitialViewProperties.html#viewpoint) of the view will not be updated for the webmap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#updateFrom) */ viewpointExcluded?: boolean; /** * When `true`, the view's scale will be updated for the webmap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#updateFrom) */ scalePreserved?: boolean; /** * When `true`, the thumbnail will not be updated for the webmap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#updateFrom) */ thumbnailExcluded?: boolean; /** * The size of the thumbnail. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#updateFrom) */ thumbnailSize?: WebMapUpdateFromOptionsThumbnailSize; /** * When `true`, the webmap's [widgets](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#widgets) property will not be updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#updateFrom) */ widgetsExcluded?: boolean; } export interface WebMapUpdateFromOptionsThumbnailSize { /** * The width of the thumbnail. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#updateFrom) */ width: number; /** * The height of the thumbnail. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#updateFrom) */ height: number; } /** * The widgets object contains widgets that are exposed to the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#Widgets) */ export interface Widgets { /** * Time animation is controlled by a configurable [time slider](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#Widgets) */ timeSlider: WebMapTimeSlider; /** * Floor filtering is controlled by a configurable [floor filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#Widgets) */ floorFilter: WebMapFloorFilter; } export interface WebScene extends Map, corePromise { } export class WebScene { /** * Configuration of application and UI elements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#applicationProperties) */ applicationProperties: websceneApplicationProperties; /** * The name of the application that authored the WebScene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#authoringApp) */ authoringApp: string; /** * The version of the application that authored the WebScene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#authoringAppVersion) */ authoringAppVersion: string; /** * *This property only applies to local scenes.* Represents an optional clipping area used to define the bounds or [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of a local scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#clippingArea) */ clippingArea: Extent; /** * *This property only applies to local scenes.* Determines whether clipping using the [clippingArea](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#clippingArea) is enabled. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#clippingEnabled) */ clippingEnabled: boolean; /** * When a web scene is configured as floor-aware, it has a floorInfo property defined. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#floorInfo) */ floorInfo: MapFloorInfo; /** * The height model info of the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#heightModelInfo) */ heightModelInfo: HeightModelInfo; /** * The initial view of the WebScene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#initialViewProperties) */ initialViewProperties: websceneInitialViewProperties; /** * Indicates whether the instance has loaded. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#loaded) */ readonly loaded: boolean; /** * The Error object returned if an error occurred while loading. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#loadError) */ readonly loadError: Error; /** * Represents the status of a [load](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#load) operation. * * @default not-loaded * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#loadStatus) */ readonly loadStatus: "not-loaded" | "loading" | "failed" | "loaded"; /** * The portal item from which the WebScene is loaded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#portalItem) */ portalItem: PortalItem; /** * Provides a [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of slides that act as bookmarks for saving predefined [viewpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) and visible layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#presentation) */ presentation: Presentation; /** * The version of the source document from which the WebScene was read. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#sourceVersion) */ readonly sourceVersion: WebSceneSourceVersion; /** * The URL to the thumbnail used for the web scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#thumbnailUrl) */ thumbnailUrl: string; /** * The latest supported webscene spec version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#version) */ static readonly version: string; /** * The web scene is the core element of 3D mapping across ArcGIS. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) */ constructor(properties?: WebSceneProperties); /** * Triggers the loading of the WebScene instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#load) */ load(): Promise; /** * Loads all the externally loadable resources associated with the webscene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#loadAll) */ loadAll(): Promise; /** * Saves the webscene to its associated portal item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#save) */ save(options?: WebSceneSaveOptions): Promise; /** * Saves the webscene to a new portal item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#saveAs) */ saveAs(portalItem: PortalItem | PortalItemProperties, options?: WebSceneSaveAsOptions): Promise; /** * Converts an instance of this class to its ArcGIS portal JSON representation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#toJSON) */ toJSON(): any; /** * Update properties of the WebScene related to the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#updateFrom) */ updateFrom(view: SceneView, options?: WebSceneUpdateFromOptions): Promise; /** * Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#fromJSON) */ static fromJSON(json: any): WebScene; } interface WebSceneProperties extends MapProperties { /** * Configuration of application and UI elements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#applicationProperties) */ applicationProperties?: websceneApplicationPropertiesProperties; /** * The name of the application that authored the WebScene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#authoringApp) */ authoringApp?: string; /** * The version of the application that authored the WebScene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#authoringAppVersion) */ authoringAppVersion?: string; /** * *This property only applies to local scenes.* Represents an optional clipping area used to define the bounds or [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of a local scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#clippingArea) */ clippingArea?: ExtentProperties; /** * *This property only applies to local scenes.* Determines whether clipping using the [clippingArea](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#clippingArea) is enabled. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#clippingEnabled) */ clippingEnabled?: boolean; /** * When a web scene is configured as floor-aware, it has a floorInfo property defined. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#floorInfo) */ floorInfo?: MapFloorInfoProperties; /** * The height model info of the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#heightModelInfo) */ heightModelInfo?: HeightModelInfoProperties; /** * The initial view of the WebScene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#initialViewProperties) */ initialViewProperties?: websceneInitialViewPropertiesProperties; /** * The portal item from which the WebScene is loaded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#portalItem) */ portalItem?: PortalItemProperties; /** * Provides a [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of slides that act as bookmarks for saving predefined [viewpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) and visible layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#presentation) */ presentation?: PresentationProperties; /** * The URL to the thumbnail used for the web scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#thumbnailUrl) */ thumbnailUrl?: string; } export class websceneApplicationProperties extends Accessor { /** * View-specific properties of application and UI elements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-ApplicationProperties.html#viewing) */ viewing: Viewing; /** * Represents configuration of application and UI elements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-ApplicationProperties.html) */ constructor(properties?: websceneApplicationPropertiesProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-ApplicationProperties.html#clone) */ clone(): websceneApplicationProperties; } interface websceneApplicationPropertiesProperties { /** * View-specific properties of application and UI elements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-ApplicationProperties.html#viewing) */ viewing?: ViewingProperties; } export interface Background extends Accessor, JSONSupport { } export class Background { /** * The background of a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) that lies behind the sky, atmosphere and stars. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-background-Background.html) */ constructor(properties?: BackgroundProperties); /** * Creates a deep clone of the Background. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-background-Background.html#clone) */ clone(): Background; static fromJSON(json: any): Background; } interface BackgroundProperties { } export interface backgroundColorBackground extends Background, JSONSupport { } export class backgroundColorBackground { /** * The color of the background. * * @default black * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-background-ColorBackground.html#color) */ color: Color; /** * This type of [Background](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-background-Background.html) allows to set a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) as the background of a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-background-ColorBackground.html) */ constructor(properties?: backgroundColorBackgroundProperties); /** * Creates a deep clone of the object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-background-ColorBackground.html#clone) */ clone(): backgroundColorBackground; static fromJSON(json: any): backgroundColorBackground; } interface backgroundColorBackgroundProperties extends BackgroundProperties { /** * The color of the background. * * @default black * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-background-ColorBackground.html#color) */ color?: Color | number[] | string; } export class Environment extends Accessor { /** * Specifies whether the atmosphere should be displayed. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html#atmosphereEnabled) */ atmosphereEnabled: boolean; /** * Specifies how the background of the scene (which lies behind sky, stars and atmosphere) should be displayed. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html#background) */ background: Background; /** * Settings for defining the lighting of the scene. * * @default SunLighting * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html#lighting) */ lighting: SunLighting | VirtualLighting; /** * Specifies whether stars should be displayed in the sky. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html#starsEnabled) */ starsEnabled: boolean; /** * Indicates the type of weather visualization in the scene. * * @default SunnyWeather * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html#weather) */ weather: SunnyWeather | CloudyWeather | RainyWeather | SnowyWeather | FoggyWeather; /** * Represents settings that affect the environment in which the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) is displayed (such as lighting). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html) */ constructor(properties?: EnvironmentProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html#clone) */ clone(): Environment; } interface EnvironmentProperties { /** * Specifies whether the atmosphere should be displayed. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html#atmosphereEnabled) */ atmosphereEnabled?: boolean; /** * Specifies how the background of the scene (which lies behind sky, stars and atmosphere) should be displayed. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html#background) */ background?: BackgroundProperties; /** * Settings for defining the lighting of the scene. * * @default SunLighting * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html#lighting) */ lighting?: (SunLightingProperties & { type?: "sun" }) | (VirtualLightingProperties & { type: "virtual" }); /** * Specifies whether stars should be displayed in the sky. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html#starsEnabled) */ starsEnabled?: boolean; /** * Indicates the type of weather visualization in the scene. * * @default SunnyWeather * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html#weather) */ weather?: | (SunnyWeatherProperties & { type: "sunny" }) | (CloudyWeatherProperties & { type: "cloudy" }) | (RainyWeatherProperties & { type: "rainy" }) | (SnowyWeatherProperties & { type: "snowy" }) | (FoggyWeatherProperties & { type: "foggy" }); } export class websceneInitialViewProperties extends Accessor { /** * The initial environment settings of the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#environment) */ environment: Environment; /** * The spatial reference of the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#spatialReference) */ spatialReference: SpatialReference; /** * The viewing mode of the scene. * * @default global * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#viewingMode) */ viewingMode: "global" | "local"; /** * The initial viewpoint of the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#viewpoint) */ viewpoint: Viewpoint; /** * Represents the initial viewing state of the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) when displayed in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html) */ constructor(properties?: websceneInitialViewPropertiesProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#clone) */ clone(): websceneInitialViewProperties; } interface websceneInitialViewPropertiesProperties { /** * The initial environment settings of the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#environment) */ environment?: EnvironmentProperties; /** * The spatial reference of the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * The viewing mode of the scene. * * @default global * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#viewingMode) */ viewingMode?: "global" | "local"; /** * The initial viewpoint of the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#viewpoint) */ viewpoint?: ViewpointProperties; } export class Lighting extends websceneSunLighting { /** * The lighting object is part of the [webscene/Environment](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html) and contains information relating to how a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) is lit. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Lighting.html) */ constructor(properties?: LightingProperties); /** * Creates a deep clone of this object. * * @deprecated since version 4.24 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Lighting.html#clone) */ clone(): Lighting; } interface LightingProperties extends websceneSunLightingProperties { } export class Presentation extends Accessor { /** * A collection of [slides](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html) that bookmark [viewpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html), visible layers, and other settings previously defined in a [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html#slides) */ slides: Collection; /** * A presentation contains a [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [slides](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html) that allows users to quickly navigate to predefined settings of a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html) */ constructor(properties?: PresentationProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html#clone) */ clone(): Presentation; } interface PresentationProperties { /** * A collection of [slides](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html) that bookmark [viewpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html), visible layers, and other settings previously defined in a [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html#slides) */ slides?: CollectionProperties; } export class Slide extends Accessor { /** * The basemap of the scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#basemap) */ basemap: Basemap; /** * The description of the slide. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#description) */ description: SlideDescription; /** * Represents settings that affect the environment in which the WebScene is displayed (such as lighting). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#environment) */ environment: SlideEnvironment; /** * Ground properties for this slide. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#ground) */ ground: SlideGround; /** * The visibility of a slide in a presentation. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#hidden) */ hidden: boolean; /** * The unique id of a slide within the [slides property](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html#slides) of a [Presentation](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#id) */ id: string; /** * A data URI encoded thumbnail. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#thumbnail) */ thumbnail: SlideThumbnail; /** * The title of the slide. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#title) */ title: SlideTitle; /** * The viewpoint of the slide. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#viewpoint) */ viewpoint: Viewpoint; /** * The visible layers of the scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#visibleLayers) */ visibleLayers: Collection; /** * A slide stores a snapshot of several pre-set properties of the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) and [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html), such as the [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#basemap), [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#viewpoint) and [visible layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#visibleLayers). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html) */ constructor(properties?: SlideProperties); /** * Applies a slide's settings to a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#applyTo) */ applyTo(view: SceneView, optionsWithDefaults?: any): Promise; /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#clone) */ clone(): Slide; /** * Updates a slide from a [WebScene's slides](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html#slides). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#updateFrom) */ updateFrom(view: SceneView, options?: SlideUpdateFromOptions): Promise; /** * Creates a slide from a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html), which may be added to the [slides](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html#slides) in the WebScene's [presentation](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#presentation). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#createFrom) */ static createFrom(view: SceneView, options?: SlideCreateFromOptions): Promise; } interface SlideProperties { /** * The basemap of the scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#basemap) */ basemap?: BasemapProperties | string; /** * The description of the slide. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#description) */ description?: SlideDescriptionProperties | string; /** * Represents settings that affect the environment in which the WebScene is displayed (such as lighting). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#environment) */ environment?: SlideEnvironmentProperties; /** * Ground properties for this slide. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#ground) */ ground?: SlideGroundProperties; /** * The visibility of a slide in a presentation. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#hidden) */ hidden?: boolean; /** * The unique id of a slide within the [slides property](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html#slides) of a [Presentation](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#id) */ id?: string; /** * A data URI encoded thumbnail. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#thumbnail) */ thumbnail?: SlideThumbnailProperties | string; /** * The title of the slide. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#title) */ title?: SlideTitleProperties | string; /** * The viewpoint of the slide. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#viewpoint) */ viewpoint?: ViewpointProperties; /** * The visible layers of the scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#visibleLayers) */ visibleLayers?: CollectionProperties; } export interface SlideCreateFromOptions { /** * Screenshot options to use. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#createFrom) */ screenshot?: SlideCreateFromOptionsScreenshot; } export interface SlideCreateFromOptionsScreenshot { /** * The image format. * * @default png * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#createFrom) */ format?: string; /** * The image quality (due to compression). * * @default 80 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#createFrom) */ quality?: number; /** * The image width. * * @default 120 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#createFrom) */ width?: number; /** * The image height. * * @default 75 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#createFrom) */ height?: number; } export interface SlideDescriptionProperties { /** * The description. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#description) */ text?: string; } export interface SlideDescription extends AnonymousAccessor { /** * The description. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#description) */ text?: string; } export interface SlideEnvironmentProperties { /** * Settings for defining the lighting of the scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#environment) */ lighting?: | (websceneSunLightingProperties & { type?: "sun" }) | (websceneVirtualLightingProperties & { type: "virtual" }); } export interface SlideEnvironment extends AnonymousAccessor { /** * Settings for defining the lighting of the scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#environment) */ lighting?: websceneSunLighting | websceneVirtualLighting; } export interface SlideGroundProperties { /** * Ground opacity * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#ground) */ opacity?: number; } export interface SlideGround extends AnonymousAccessor { /** * Ground opacity * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#ground) */ opacity?: number; } export interface SlideThumbnailProperties { /** * The URI pointing to the thumbnail image representing the slide. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#thumbnail) */ url?: string; } export interface SlideThumbnail extends AnonymousAccessor { /** * The URI pointing to the thumbnail image representing the slide. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#thumbnail) */ url?: string; } export interface SlideTitleProperties { /** * The title. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#title) */ text?: string; } export interface SlideTitle extends AnonymousAccessor { /** * The title. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#title) */ text?: string; } export interface SlideUpdateFromOptions { /** * Screenshot options to use. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#updateFrom) */ screenshot: SlideUpdateFromOptionsScreenshot; } export interface SlideUpdateFromOptionsScreenshot { /** * The image format. * * @default png * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#updateFrom) */ format?: string; /** * The image quality (due to compression). * * @default 80 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#updateFrom) */ quality?: number; /** * The image width. * * @default 120 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#updateFrom) */ width?: number; /** * The image height. * * @default 75 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#updateFrom) */ height?: number; } export interface SlideVisibleLayersProperties { /** * The ID of a [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#id) in the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#layers) or [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#layers) that is made `visible` in the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) when the slide is applied to the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#visibleLayers) */ id?: string; /** * The service ids of the visible sublayers on the layer specified by the layer id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#visibleLayers) */ sublayerIds?: number[]; } export interface SlideVisibleLayers extends AnonymousAccessor { /** * The ID of a [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#id) in the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#layers) or [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#layers) that is made `visible` in the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) when the slide is applied to the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#visibleLayers) */ id: string; /** * The service ids of the visible sublayers on the layer specified by the layer id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#visibleLayers) */ sublayerIds: number[]; } export class websceneSunLighting extends Accessor { /** * The current date and time of the simulated sun. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-SunLighting.html#date) */ date: Date; /** * Indicates whether to show shadows cast by the sun. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-SunLighting.html#directShadowsEnabled) */ directShadowsEnabled: boolean; /** * The UTC time zone offset in hours that should be displayed in the UI to represent the date. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-SunLighting.html#displayUTCOffset) */ displayUTCOffset: number; /** * Indicates that the light source is simulated position of the sun. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-SunLighting.html#type) */ readonly type: "sun"; /** * The sun lighting object is part of the [webscene/Environment](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html) and contains information relating to how a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) is lit by the sun. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-SunLighting.html) */ constructor(properties?: websceneSunLightingProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-SunLighting.html#clone) */ clone(): websceneSunLighting; } interface websceneSunLightingProperties { /** * The current date and time of the simulated sun. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-SunLighting.html#date) */ date?: DateProperties; /** * Indicates whether to show shadows cast by the sun. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-SunLighting.html#directShadowsEnabled) */ directShadowsEnabled?: boolean; /** * The UTC time zone offset in hours that should be displayed in the UI to represent the date. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-SunLighting.html#displayUTCOffset) */ displayUTCOffset?: number; } export class websceneVirtualLighting extends Accessor { /** * Indicates whether to show shadows cast by the light source. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-VirtualLighting.html#directShadowsEnabled) */ directShadowsEnabled: boolean; /** * Indicates that the light source is virtual light. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-VirtualLighting.html#type) */ readonly type: "virtual"; /** * The virtual lighting object is part of the [webscene/Environment](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html) and contains information relating to how a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) is lit with a virtual light. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-VirtualLighting.html) */ constructor(properties?: websceneVirtualLightingProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-VirtualLighting.html#clone) */ clone(): websceneVirtualLighting; } interface websceneVirtualLightingProperties { /** * Indicates whether to show shadows cast by the light source. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-VirtualLighting.html#directShadowsEnabled) */ directShadowsEnabled?: boolean; } export interface WebSceneSaveAsOptions { /** * the folder in which to save the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#saveAs) */ folder?: PortalFolder; /** * allow the scene to be saved even in the case it contains unsupported content (layers, renderers, symbols). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#saveAs) */ ignoreUnsupported?: boolean; } export interface WebSceneSaveOptions { /** * When `true`, the scene will save even if it contains unsupported content (layers, renderers, symbols). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#save) */ ignoreUnsupported?: boolean; } export interface WebSceneSourceVersion { /** * The major version of the WebScene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#sourceVersion) */ major: number; /** * The minor version of the WebScene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#sourceVersion) */ minor: number; } export interface WebSceneUpdateFromOptions { /** * Do not update the initial environment from the view, defaults to false. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#updateFrom) */ environmentExcluded?: boolean; /** * Do not update the initial viewpoint from the view, defaults to false. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#updateFrom) */ viewpointExcluded?: boolean; /** * Do not update the thumbnail from the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#updateFrom) */ thumbnailExcluded?: boolean; /** * The size of the thumbnail. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#updateFrom) */ thumbnailSize?: WebSceneUpdateFromOptionsThumbnailSize; } export interface WebSceneUpdateFromOptionsThumbnailSize { /** * The width of the thumbnail. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#updateFrom) */ width: number; /** * The height of the thumbnail. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#updateFrom) */ height: number; } export class AreaMeasurement2D extends Widget { /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/AreaMeasurement2D#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#iconClass) */ iconClass: string; /** * Unit system (imperial, metric) or specific unit used for displaying the area values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#unit) */ unit: SystemOrAreaUnit; /** * List of available units and unit systems (imperial, metric) for displaying the area values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#unitOptions) */ unitOptions: SystemOrAreaUnit[]; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#view) */ view: MapView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#viewModel) */ viewModel: AreaMeasurement2DViewModel; /** * The AreaMeasurement2D widget calculates and displays the area and perimeter of a polygon in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html) */ constructor(properties?: AreaMeasurement2DProperties); } interface AreaMeasurement2DProperties extends WidgetProperties { /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/AreaMeasurement2D#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#iconClass) */ iconClass?: string; /** * Unit system (imperial, metric) or specific unit used for displaying the area values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#unit) */ unit?: | "imperial" | "metric" | "square-millimeters" | "square-centimeters" | "square-decimeters" | "square-meters" | "square-kilometers" | "square-inches" | "square-feet" | "square-yards" | "square-miles" | "square-us-feet" | "acres" | "ares" | "hectares"; /** * List of available units and unit systems (imperial, metric) for displaying the area values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#unitOptions) */ unitOptions?: ( | "imperial" | "metric" | "square-millimeters" | "square-centimeters" | "square-decimeters" | "square-meters" | "square-kilometers" | "square-inches" | "square-feet" | "square-yards" | "square-miles" | "square-us-feet" | "acres" | "ares" | "hectares" )[]; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#view) */ view?: MapViewProperties; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#viewModel) */ viewModel?: AreaMeasurement2DViewModel; } export class AreaMeasurement2DViewModel { /** * Threshold (in meters) which determines the method for computing and displaying areas and perimeters in non-Web Mercator projected coordinate systems (PCS). * * @default null * @deprecated since version 4.29. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#geodesicDistanceThreshold) */ geodesicDistanceThreshold: number; /** * The area and perimeter of the measurement polygon in square meters and meters respectively. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#measurement) */ readonly measurement: AreaMeasurement2DViewModelMeasurement; /** * This property returns the locale specific representation of the area and perimeter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#measurementLabel) */ readonly measurementLabel: AreaMeasurement2DViewModelMeasurementLabel; /** * The ViewModel's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#state) */ readonly state: "disabled" | "ready" | "measuring" | "measured"; /** * Unit system (imperial, metric) or specific unit used for displaying the area values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#unit) */ unit: SystemOrAreaUnit; /** * List of available units and unit systems (imperial, metric) for displaying the area values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#unitOptions) */ unitOptions: SystemOrAreaUnit[]; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#view) */ view: MapView; constructor(properties?: any); /** * Clears the current measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#clear) */ clear(): void; /** * Starts a new measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#start) */ start(): void; } export interface AreaMeasurement2DViewModelMeasurement { /** * The area (m²). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#measurement) */ area: number; /** * The perimeter (m). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#measurement) */ perimeter: number; /** * Measurement area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#measurement) */ geometry: any; } export interface AreaMeasurement2DViewModelMeasurementLabel { /** * The area (m²). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#measurementLabel) */ area: number; /** * The perimeter (m). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#measurementLabel) */ perimeter: number; } export class AreaMeasurement3D extends Widget { /** * The area measurement analysis object being created or modified by the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#analysis) */ readonly analysis: AreaMeasurementAnalysis; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/AreaMeasurement3D#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#iconClass) */ iconClass: string; /** * Unit system (imperial, metric) or specific unit used for displaying the area values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#unit) */ unit: SystemOrAreaUnit; /** * List of available units and unit systems (imperial, metric) for displaying the area values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#unitOptions) */ unitOptions: SystemOrAreaUnit[]; /** * A reference to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#view) */ view: SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#viewModel) */ viewModel: AreaMeasurement3DViewModel; /** * The AreaMeasurement3D widget calculates and displays the area and perimeter of a polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html) */ constructor(properties?: AreaMeasurement3DProperties); } interface AreaMeasurement3DProperties extends WidgetProperties { /** * The area measurement analysis object being created or modified by the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#analysis) */ analysis?: AreaMeasurementAnalysisProperties; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/AreaMeasurement3D#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#iconClass) */ iconClass?: string; /** * Unit system (imperial, metric) or specific unit used for displaying the area values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#unit) */ unit?: | "imperial" | "metric" | "square-millimeters" | "square-centimeters" | "square-decimeters" | "square-meters" | "square-kilometers" | "square-inches" | "square-feet" | "square-yards" | "square-miles" | "square-us-feet" | "acres" | "ares" | "hectares"; /** * List of available units and unit systems (imperial, metric) for displaying the area values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#unitOptions) */ unitOptions?: ( | "imperial" | "metric" | "square-millimeters" | "square-centimeters" | "square-decimeters" | "square-meters" | "square-kilometers" | "square-inches" | "square-feet" | "square-yards" | "square-miles" | "square-us-feet" | "acres" | "ares" | "hectares" )[]; /** * A reference to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#view) */ view?: SceneViewProperties; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#viewModel) */ viewModel?: AreaMeasurement3DViewModelProperties; } export class AreaMeasurement3DViewModel extends Accessor { /** * The area measurement analysis object being created or modified by the view model. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#analysis) */ readonly analysis: AreaMeasurementAnalysis; /** * The current measurement of the area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#measurement) */ readonly measurement: AreaMeasurement3DViewModelMeasurement; /** * The view model's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#state) */ readonly state: "disabled" | "ready" | "measuring" | "measured"; /** * Unit system (imperial, metric) or specific unit used for displaying the area values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#unit) */ unit: SystemOrAreaUnit; /** * List of available units and unit systems (imperial, metric) for displaying the area values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#unitOptions) */ unitOptions: SystemOrAreaUnit[]; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#view) */ view: SceneView; /** * Provides the logic for the [AreaMeasurement3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html) */ constructor(properties?: AreaMeasurement3DViewModelProperties); /** * Clears the current measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#clear) */ clear(): void; /** * Starts a new measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#start) */ start(): void; } interface AreaMeasurement3DViewModelProperties { /** * The area measurement analysis object being created or modified by the view model. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#analysis) */ analysis?: AreaMeasurementAnalysisProperties; /** * Unit system (imperial, metric) or specific unit used for displaying the area values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#unit) */ unit?: | "imperial" | "metric" | "square-millimeters" | "square-centimeters" | "square-decimeters" | "square-meters" | "square-kilometers" | "square-inches" | "square-feet" | "square-yards" | "square-miles" | "square-us-feet" | "acres" | "ares" | "hectares"; /** * List of available units and unit systems (imperial, metric) for displaying the area values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#unitOptions) */ unitOptions?: ( | "imperial" | "metric" | "square-millimeters" | "square-centimeters" | "square-decimeters" | "square-meters" | "square-kilometers" | "square-inches" | "square-feet" | "square-yards" | "square-miles" | "square-us-feet" | "acres" | "ares" | "hectares" )[]; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#view) */ view?: SceneViewProperties; } export interface AreaMeasurement3DViewModelMeasurement { /** * Describes the mode in which the measurement is computed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#measurement) */ mode: "euclidean" | "geodesic"; /** * Area of the polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#measurement) */ area: AreaMeasurement3DViewModelMeasurementValue; /** * Perimeter length of the polygon. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#measurement) */ perimeterLength: AreaMeasurement3DViewModelMeasurementValue; } /** * Measurement value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#MeasurementValue) */ export interface AreaMeasurement3DViewModelMeasurementValue { /** * Textual representation of the measured value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#MeasurementValue) */ text: string; /** * State of the measured value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#MeasurementValue) */ state: string; } export class Attachments extends Widget { /** * Configures the attachment editing functionality that can be performed by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#capabilities) */ capabilities: AttachmentsCapabilities; /** * A string value indicating how to display an attachment. * * @default "auto" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#displayType) */ displayType: "auto" | "preview" | "list"; /** * The graphic for the attachments. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#graphic) */ graphic: Graphic; /** * Indicates whether there is currently an attachment being added, updated or deleted. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#submitting) */ readonly submitting: boolean; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#viewModel) */ viewModel: AttachmentsViewModel; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#visibleElements) */ visibleElements: AttachmentsVisibleElements; /** * This widget allows users to view and edit attachments associated with a feature and is considered a standalone experience that can be utilized in widgets such [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) and [Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html) */ constructor(properties?: AttachmentsProperties); } interface AttachmentsProperties extends WidgetProperties { /** * Configures the attachment editing functionality that can be performed by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#capabilities) */ capabilities?: AttachmentsCapabilities; /** * A string value indicating how to display an attachment. * * @default "auto" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#displayType) */ displayType?: "auto" | "preview" | "list"; /** * The graphic for the attachments. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#graphic) */ graphic?: GraphicProperties; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#viewModel) */ viewModel?: AttachmentsViewModelProperties; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#visibleElements) */ visibleElements?: AttachmentsVisibleElements; } export class AttachmentsViewModel extends Accessor { /** * The current [AttachmentInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html) being edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html#activeAttachmentInfo) */ activeAttachmentInfo: AttachmentInfo; /** * A collection of [AttachmentInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html) defined on a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html#attachmentInfos) */ readonly attachmentInfos: AttachmentInfo[]; /** * Configures the attachment editing functionality that can be performed by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html#capabilities) */ capabilities: AttachmentsCapabilities; /** * The graphic for the attachments. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html#graphic) */ graphic: Graphic; /** * The current mode performed by the user. * * @default "view" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html#mode) */ mode: "view" | "add" | "edit"; /** * The current state of the widget. * * @default "ready" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html#state) */ readonly state: "ready" | "disabled" | "loading"; /** * Defines whether or not the feature supports resizing attachments. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html#supportsResizeAttachments) */ supportsResizeAttachments: boolean; /** * Provides the logic for the [Attachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html) */ constructor(properties?: AttachmentsViewModelProperties); /** * Queries for the attachments on a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html#getAttachments) */ getAttachments(): Promise; } interface AttachmentsViewModelProperties { /** * The current [AttachmentInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html) being edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html#activeAttachmentInfo) */ activeAttachmentInfo?: AttachmentInfoProperties; /** * Configures the attachment editing functionality that can be performed by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html#capabilities) */ capabilities?: AttachmentsCapabilities; /** * The graphic for the attachments. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html#graphic) */ graphic?: GraphicProperties; /** * The current mode performed by the user. * * @default "view" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html#mode) */ mode?: "view" | "add" | "edit"; /** * Defines whether or not the feature supports resizing attachments. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html#supportsResizeAttachments) */ supportsResizeAttachments?: boolean; } /** * An object that specifies the available attachments capabilities. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html#AttachmentsCapabilities) */ export interface AttachmentsCapabilities { /** * Indicates whether to allow attachment editing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html#AttachmentsCapabilities) */ editing?: boolean; /** * Describes the configurable attachments operations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html#AttachmentsCapabilities) */ operations?: AttachmentsCapabilitiesOperations[]; } export interface AttachmentsCapabilitiesOperations { /** * Indicates whether to allow adding attachments. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html#AttachmentsCapabilities) */ add?: boolean; /** * Indicates whether to allow updating an existing attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html#AttachmentsCapabilities) */ update?: boolean; /** * Indicates whether to allow deleting an existing attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html#AttachmentsCapabilities) */ delete?: boolean; } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#VisibleElements) */ export interface AttachmentsVisibleElements { /** * Indicates whether to display the `Add` button which prompts the dialog to add a new attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#VisibleElements) */ addButton?: boolean; /** * Indicates whether to display the `add` button after selecting the attachment to add. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#VisibleElements) */ addSubmitButton?: boolean; /** * Indicates whether to display the `cancel` button after selecting the attachment to add. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#VisibleElements) */ cancelAddButton?: boolean; /** * Indicates whether to display the `cancel` button after selecting an attachment to update an existing attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#VisibleElements) */ cancelUpdateButton?: boolean; /** * Indicates whether to display the `delete` button to delete an existing attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#VisibleElements) */ deleteButton?: boolean; /** * Indicates whether to display an error message if adding or updating an attachment results in errors. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#VisibleElements) */ errorMessage?: boolean; /** * Indicates whether to display a progress bar when adding an attachment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#VisibleElements) */ progressBar?: boolean; /** * Indicates whether to display an `update` button to allow updating on existing attachments. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#VisibleElements) */ updateButton?: boolean; } export class Attribution extends Widget { /** * Full attribution text. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html#attributionText) */ readonly attributionText: string; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Attribution#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html#iconClass) */ iconClass: string; /** * Text used to split attribution by [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) * * @default | * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html#itemDelimiter) */ itemDelimiter: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html#viewModel) */ viewModel: AttributionViewModel; /** * The Attribution widget displays attribution text for the layers in a map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html) */ constructor(properties?: AttributionProperties); } interface AttributionProperties extends WidgetProperties { /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Attribution#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html#iconClass) */ iconClass?: string; /** * Text used to split attribution by [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) * * @default | * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html#itemDelimiter) */ itemDelimiter?: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html#viewModel) */ viewModel?: AttributionViewModelProperties; } export class AttributionViewModel extends Accessor { /** * A collection of [AttributionItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution-AttributionViewModel.html#AttributionItem)s. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution-AttributionViewModel.html#items) */ readonly items: Collection; /** * The view model's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution-AttributionViewModel.html#state) */ readonly state: "disabled" | "ready" | "loading"; /** * The view from which the view model will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution-AttributionViewModel.html#view) */ view: MapView | SceneView; /** * Provides the logic for the [Attribution](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution-AttributionViewModel.html) */ constructor(properties?: AttributionViewModelProperties); } interface AttributionViewModelProperties { /** * The view from which the view model will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution-AttributionViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } /** * The following properties define an attribution item that contains the attribution text for a layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution-AttributionViewModel.html#AttributionItem) */ export interface AttributionItem { /** * The attribution text. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution-AttributionViewModel.html#AttributionItem) */ text: string; /** * The layer that has the attribution text. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution-AttributionViewModel.html#AttributionItem) */ layer: Layer; } export class BasemapGallery extends Widget { /** * The map's [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#activeBasemap) */ activeBasemap: Basemap; /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#disabled) */ disabled: boolean; /** * Indicates the heading level to use for the message "No basemaps available" when no basemaps are available in the BasemapGallery. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#headingLevel) */ headingLevel: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/BasemapGallery#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#iconClass) */ iconClass: string; /** * The source for basemaps that the widget will display. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#source) */ source: LocalBasemapsSource | PortalBasemapsSource; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#viewModel) */ viewModel: BasemapGalleryViewModel; /** * The BasemapGallery widget displays a collection of images representing basemaps from ArcGIS.com or a user-defined set of map or image services. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html) */ constructor(properties?: BasemapGalleryProperties); } interface BasemapGalleryProperties extends WidgetProperties { /** * The map's [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#activeBasemap) */ activeBasemap?: BasemapProperties; /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#disabled) */ disabled?: boolean; /** * Indicates the heading level to use for the message "No basemaps available" when no basemaps are available in the BasemapGallery. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#headingLevel) */ headingLevel?: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/BasemapGallery#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#iconClass) */ iconClass?: string; /** * The source for basemaps that the widget will display. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#source) */ source?: | LocalBasemapsSourceProperties | PortalBasemapsSourceProperties | CollectionProperties | BasemapProperties[] | PortalProperties; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#viewModel) */ viewModel?: BasemapGalleryViewModelProperties; } export class BasemapGalleryViewModel extends Accessor { /** * The map's [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#activeBasemap) */ activeBasemap: Basemap; /** * A collection of [BasemapGalleryItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-BasemapGalleryItem.html)s representing basemaps. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#items) */ items: Collection; /** * The source for basemaps that the widget will display. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#source) */ source: LocalBasemapsSource | PortalBasemapsSource; /** * The view model's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#state) */ readonly state: "ready" | "disabled"; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#view) */ view: MapView | SceneView; /** * Provides the logic for the [BasemapGallery](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html) */ constructor(properties?: BasemapGalleryViewModelProperties); /** * A convenience function to check basemap equality. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#basemapEquals) */ basemapEquals(basemap1: Basemap, basemap2: Basemap): boolean; } interface BasemapGalleryViewModelProperties { /** * The map's [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#activeBasemap) */ activeBasemap?: BasemapProperties; /** * A collection of [BasemapGalleryItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-BasemapGalleryItem.html)s representing basemaps. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#items) */ items?: CollectionProperties; /** * The source for basemaps that the widget will display. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#source) */ source?: | LocalBasemapsSourceProperties | PortalBasemapsSourceProperties | CollectionProperties | BasemapProperties[] | PortalProperties; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } export class BasemapGalleryItem extends Accessor { /** * The item's associated basemap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-BasemapGalleryItem.html#basemap) */ basemap: Basemap; /** * The Error object returned if an error occurred. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-BasemapGalleryItem.html#error) */ readonly error: Error; /** * The item's state. * * @default loading * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-BasemapGalleryItem.html#state) */ readonly state: "loading" | "ready" | "error"; /** * The view associated with this item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-BasemapGalleryItem.html#view) */ view: MapView | SceneView; /** * The BasemapGalleryItem class represents one of the [items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#items) in the [BasemapGallery](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-BasemapGalleryItem.html) */ constructor(properties?: BasemapGalleryItemProperties); } interface BasemapGalleryItemProperties { /** * The item's associated basemap. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-BasemapGalleryItem.html#basemap) */ basemap?: BasemapProperties; /** * The view associated with this item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-BasemapGalleryItem.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } export class LocalBasemapsSource extends Accessor { /** * A collection of [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html)s. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-LocalBasemapsSource.html#basemaps) */ basemaps: Collection; /** * The source's state. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-LocalBasemapsSource.html#state) */ readonly state: string; /** * The LocalBasemapsSource class is a Collection-driven [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#source) in the [BasemapGalleryViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html) or [BasemapGallery](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-LocalBasemapsSource.html) */ constructor(properties?: LocalBasemapsSourceProperties); } interface LocalBasemapsSourceProperties { /** * A collection of [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html)s. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-LocalBasemapsSource.html#basemaps) */ basemaps?: CollectionProperties; } export class PortalBasemapsSource extends LocalBasemapsSource { /** * Function used to filter basemaps after being fetched from the Portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-PortalBasemapsSource.html#filterFunction) */ filterFunction: BasemapFilter; /** * The Portal from which to fetch basemaps. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-PortalBasemapsSource.html#portal) */ portal: Portal; /** * An object with key-value pairs used to create a custom basemap gallery group query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-PortalBasemapsSource.html#query) */ query: any | string; /** * The source's state. * * @default not-loaded * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-PortalBasemapsSource.html#state) */ readonly state: "not-loaded" | "loading" | "ready"; /** * Callback for updating basemaps after being fetched and filtered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-PortalBasemapsSource.html#updateBasemapsCallback) */ updateBasemapsCallback: UpdateBasemapsCallback; /** * The PortalBasemapsSource class is a Portal-driven [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#source) in the [BasemapGalleryViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html) or [BasemapGallery](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-PortalBasemapsSource.html) */ constructor(properties?: PortalBasemapsSourceProperties); /** * Refreshes basemaps by fetching them from the Portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-PortalBasemapsSource.html#refresh) */ refresh(): Promise; } interface PortalBasemapsSourceProperties extends LocalBasemapsSourceProperties { /** * Function used to filter basemaps after being fetched from the Portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-PortalBasemapsSource.html#filterFunction) */ filterFunction?: BasemapFilter; /** * The Portal from which to fetch basemaps. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-PortalBasemapsSource.html#portal) */ portal?: PortalProperties; /** * An object with key-value pairs used to create a custom basemap gallery group query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-PortalBasemapsSource.html#query) */ query?: any | string; /** * Callback for updating basemaps after being fetched and filtered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-PortalBasemapsSource.html#updateBasemapsCallback) */ updateBasemapsCallback?: UpdateBasemapsCallback; } export type BasemapFilter = (item: Basemap, index: number, array: Basemap[]) => boolean | Promise; export type UpdateBasemapsCallback = (items: Basemap[]) => Basemap[] | Promise; export class BasemapLayerList extends Widget { /** * The value of the filter input text string if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) is true. * * @default "" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#baseFilterText) */ baseFilterText: string; /** * A collection of [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html)s representing the [baseLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#baseLayers). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#baseItems) */ readonly baseItems: Collection; /** * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) representing a base layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#baseListItemCreatedFunction) */ baseListItemCreatedFunction: ListItemCreatedHandler; /** * The current basemap's title. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#basemapTitle) */ basemapTitle: string; /** * Indicates whether the widget is collapsed. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#collapsed) */ collapsed: boolean; /** * Indicates whether [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) may be reordered within the list by dragging and dropping. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#dragEnabled) */ dragEnabled: boolean; /** * Indicates whether the basemap’s title, layer order and layer grouping can be edited by the user. * * @default false * @deprecated since 4.29. Use {@link module:esri/widgets/BasemapLayerList#selectionMode selectionMode}, {@link module:esri/widgets/BasemapLayerList#VisibleElements visibleElements.editTitleButton}, and {@link module:esri/widgets/BasemapLayerList#dragEnabled dragEnabled} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#editingEnabled) */ editingEnabled: boolean; /** * Indicates whether the form to edit the basemap's title is currently visible. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#editingTitle) */ editingTitle: boolean; /** * Placeholder text used in the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) is true. * * @default "" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#filterPlaceholder) */ filterPlaceholder: string; /** * Indicates the heading level to use for the widget title (i.e. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#headingLevel) */ headingLevel: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/BasemapLayerList#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#iconClass) */ iconClass: string; /** * The minimum number of list items required to display the visibleElements.filter input box. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#minFilterItems) */ minFilterItems: number; /** * Indicates whether more than one list item may be selected by the user at a single time. * * @default false * @deprecated since 4.29. Use {@link module:esri/widgets/BasemapLayerList#selectionMode selectionMode} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#multipleSelectionEnabled) */ multipleSelectionEnabled: boolean; /** * The value of the filter input text string if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) is true. * * @default "" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#referenceFilterText) */ referenceFilterText: string; /** * A collection of [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html)s representing the [referenceLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#referenceLayers). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#referenceItems) */ readonly referenceItems: Collection; /** * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) representing a reference layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#referenceListItemCreatedFunction) */ referenceListItemCreatedFunction: ListItemCreatedHandler; /** * A collection of selected [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html)s representing basemap layers selected by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#selectedItems) */ selectedItems: Collection; /** * Specifies the selection mode. * * @default "none" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#selectionMode) */ selectionMode: "multiple" | "none" | "single" | "single-persist"; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#viewModel) */ viewModel: BasemapLayerListViewModel; /** * Determines the icons used to indicate visibility. * * @default "default" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibilityAppearance) */ visibilityAppearance: "default" | "checkbox"; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) */ visibleElements: BasemapLayerListVisibleElements; /** * The BasemapLayerList widget provides a way to display a list of [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) layers and switch on/off their visibility. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html) */ constructor(properties?: BasemapLayerListProperties); /** * Triggers the [trigger-action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#event-trigger-action) event and executes the given [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [action toggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#triggerAction) */ triggerAction(action: ActionButton | ActionToggle, item: ListItem): void; on(name: "trigger-action", eventHandler: BasemapLayerListTriggerActionEventHandler): IHandle; } interface BasemapLayerListProperties extends WidgetProperties { /** * The value of the filter input text string if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) is true. * * @default "" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#baseFilterText) */ baseFilterText?: string; /** * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) representing a base layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#baseListItemCreatedFunction) */ baseListItemCreatedFunction?: ListItemCreatedHandler; /** * The current basemap's title. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#basemapTitle) */ basemapTitle?: string; /** * Indicates whether the widget is collapsed. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#collapsed) */ collapsed?: boolean; /** * Indicates whether [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) may be reordered within the list by dragging and dropping. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#dragEnabled) */ dragEnabled?: boolean; /** * Indicates whether the basemap’s title, layer order and layer grouping can be edited by the user. * * @default false * @deprecated since 4.29. Use {@link module:esri/widgets/BasemapLayerList#selectionMode selectionMode}, {@link module:esri/widgets/BasemapLayerList#VisibleElements visibleElements.editTitleButton}, and {@link module:esri/widgets/BasemapLayerList#dragEnabled dragEnabled} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#editingEnabled) */ editingEnabled?: boolean; /** * Indicates whether the form to edit the basemap's title is currently visible. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#editingTitle) */ editingTitle?: boolean; /** * Placeholder text used in the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) is true. * * @default "" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#filterPlaceholder) */ filterPlaceholder?: string; /** * Indicates the heading level to use for the widget title (i.e. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#headingLevel) */ headingLevel?: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/BasemapLayerList#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#iconClass) */ iconClass?: string; /** * The minimum number of list items required to display the visibleElements.filter input box. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#minFilterItems) */ minFilterItems?: number; /** * Indicates whether more than one list item may be selected by the user at a single time. * * @default false * @deprecated since 4.29. Use {@link module:esri/widgets/BasemapLayerList#selectionMode selectionMode} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#multipleSelectionEnabled) */ multipleSelectionEnabled?: boolean; /** * The value of the filter input text string if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) is true. * * @default "" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#referenceFilterText) */ referenceFilterText?: string; /** * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) representing a reference layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#referenceListItemCreatedFunction) */ referenceListItemCreatedFunction?: ListItemCreatedHandler; /** * A collection of selected [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html)s representing basemap layers selected by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#selectedItems) */ selectedItems?: CollectionProperties; /** * Specifies the selection mode. * * @default "none" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#selectionMode) */ selectionMode?: "multiple" | "none" | "single" | "single-persist"; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#viewModel) */ viewModel?: BasemapLayerListViewModelProperties; /** * Determines the icons used to indicate visibility. * * @default "default" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibilityAppearance) */ visibilityAppearance?: "default" | "checkbox"; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) */ visibleElements?: BasemapLayerListVisibleElements; } export class BasemapLayerListViewModel extends Accessor { /** * A collection of [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html)s representing the [baseLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#baseLayers). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList-BasemapLayerListViewModel.html#baseItems) */ readonly baseItems: Collection; /** * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList-BasemapLayerListViewModel.html#baseListItemCreatedFunction) */ baseListItemCreatedFunction: ListItemCreatedHandler; /** * The current basemap's title. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList-BasemapLayerListViewModel.html#basemapTitle) */ basemapTitle: string; /** * Whether to provide an indication if a layer is being published in the [BasemapLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList-BasemapLayerListViewModel.html#checkPublishStatusEnabled) */ checkPublishStatusEnabled: boolean; /** * A collection of [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html)s representing the [referenceLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#referenceLayers). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList-BasemapLayerListViewModel.html#referenceItems) */ readonly referenceItems: Collection; /** * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) representing reference layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList-BasemapLayerListViewModel.html#referenceListItemCreatedFunction) */ referenceListItemCreatedFunction: ListItemCreatedHandler; /** * The view model's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList-BasemapLayerListViewModel.html#state) */ readonly state: "ready" | "loading" | "disabled"; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList-BasemapLayerListViewModel.html#view) */ view: MapView | SceneView; /** * Provides logic for the [BasemapLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList-BasemapLayerListViewModel.html) */ constructor(properties?: BasemapLayerListViewModelProperties); /** * Triggers the [trigger-action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList-BasemapLayerListViewModel.html#event-trigger-action) event and executes the given [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [action toggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList-BasemapLayerListViewModel.html#triggerAction) */ triggerAction(action: ActionButton | ActionToggle, item: ListItem): void; } interface BasemapLayerListViewModelProperties { /** * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList-BasemapLayerListViewModel.html#baseListItemCreatedFunction) */ baseListItemCreatedFunction?: ListItemCreatedHandler; /** * The current basemap's title. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList-BasemapLayerListViewModel.html#basemapTitle) */ basemapTitle?: string; /** * Whether to provide an indication if a layer is being published in the [BasemapLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList-BasemapLayerListViewModel.html#checkPublishStatusEnabled) */ checkPublishStatusEnabled?: boolean; /** * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) representing reference layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList-BasemapLayerListViewModel.html#referenceListItemCreatedFunction) */ referenceListItemCreatedFunction?: ListItemCreatedHandler; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList-BasemapLayerListViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } export type ListItemCreatedHandler = (event: any) => void; export interface BasemapLayerListTriggerActionEvent { action: ActionButton | ActionToggle; item: ListItem; } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#VisibleElements) */ export interface BasemapLayerListVisibleElements { /** * Indicates whether to the base layers will be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#VisibleElements) */ baseLayers?: boolean; /** * **Since 4.29** Indicates whether to display a close button in the header. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#VisibleElements) */ closeButton?: boolean; /** * **Since 4.29** Indicates whether to display a collapse button in the header. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#VisibleElements) */ collapseButton?: boolean; /** * **Since 4.29** Indicates whether to display a button in the header to edit the basemap title. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#VisibleElements) */ editTitleButton?: boolean; /** * **Since 4.25** Indicates whether layer load errors will be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#VisibleElements) */ errors?: boolean; /** * **Since 4.29** Indicates whether to display a filter input box when then number of list items is equal to or greater than the value set in [minFilterItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#minFilterItems), allowing users to filter layers by their title. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#VisibleElements) */ filter?: boolean; /** * **Since 4.29** Determines whether the widget should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#VisibleElements) */ flow?: boolean; /** * **Since 4.29** Indicates whether the widget displays a heading. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#VisibleElements) */ heading?: boolean; /** * Indicates whether to the reference layers will be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#VisibleElements) */ referenceLayers?: boolean; /** * Indicates whether the status indicators will be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#VisibleElements) */ statusIndicators?: boolean; /** * **Since 4.29** Indicates whether temporary layer indicators will be displayed for layers with [layer.persistenceEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#persistenceEnabled) set to `false`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#VisibleElements) */ temporaryLayerIndicators?: boolean; } export class BasemapToggle extends Widget { /** * The map's [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#activeBasemap) */ readonly activeBasemap: Basemap; /** * The next basemap for toggling. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#nextBasemap) */ nextBasemap: Basemap; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#viewModel) */ viewModel: BasemapToggleViewModel; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#visibleElements) */ visibleElements: BasemapToggleVisibleElements; /** * The BasemapToggle provides a widget which allows an end-user to switch between two basemaps. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html) */ constructor(properties?: BasemapToggleProperties); /** * Toggles to the [next basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#nextBasemap). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#toggle) */ toggle(): Promise; } interface BasemapToggleProperties extends WidgetProperties { /** * The next basemap for toggling. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#nextBasemap) */ nextBasemap?: BasemapProperties | string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#viewModel) */ viewModel?: BasemapToggleViewModelProperties; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#visibleElements) */ visibleElements?: BasemapToggleVisibleElements; } export class BasemapToggleViewModel extends Accessor { /** * The map's [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html#activeBasemap) */ readonly activeBasemap: Basemap; /** * The next basemap for toggling. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html#nextBasemap) */ nextBasemap: Basemap; /** * The view model's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html#state) */ readonly state: "ready" | "disabled"; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html#view) */ view: MapView | SceneView; /** * Provides the logic for the [BasemapToggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html) */ constructor(properties?: BasemapToggleViewModelProperties); /** * Helper method to find a basemap's thumbnail URL. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html#getThumbnailUrl) */ getThumbnailUrl(basemap: Basemap): string; /** * Toggles to the [next basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html#nextBasemap). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html#toggle) */ toggle(): Promise; } interface BasemapToggleViewModelProperties { /** * The next basemap for toggling. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html#nextBasemap) */ nextBasemap?: BasemapProperties | string; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#VisibleElements) */ export interface BasemapToggleVisibleElements { /** * Indicates whether to the title will be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#VisibleElements) */ title?: boolean; } export interface Bookmarks extends Widget, GoTo { } export class Bookmarks { /** * A collection of [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html)s. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#bookmarks) */ bookmarks: Collection; /** * Specifies how new bookmarks will be created if [visibleElements.addBookmarkButton](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#VisibleElements) is set to `true`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#defaultCreateOptions) */ defaultCreateOptions: BookmarkOptions; /** * Specifies how bookmarks will be edited, if [visibleElements.editBookmarkButton](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#VisibleElements) is set to `true`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#defaultEditOptions) */ defaultEditOptions: BookmarkOptions; /** * When true, the widget is visually withdrawn and cannot be interacted with. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#disabled) */ disabled: boolean; /** * Indicates if a Bookmark is able to be dragged in order to update its position in the list. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#dragEnabled) */ dragEnabled: boolean; /** * Indicates whether the bookmarks are able to be edited. * * @default false * @deprecated since 4.29. Use {@link module:esri/widgets/Bookmarks#VisibleElements visibleElements.editBookmarkButton}, {@link module:esri/widgets/Bookmarks#VisibleElements visibleElements.addBookmarkButton}, and {@link module:esri/widgets/Bookmarks#dragEnabled dragEnabled} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#editingEnabled) */ editingEnabled: boolean; /** * Defines the text used as a placeholder when visibleElements.filter is set to `true`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#filterPlaceholder) */ filterPlaceholder: string; /** * Defines the text used to filter the bookmarks when visibleElements.filter is set to `true`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#filterText) */ filterText: string; /** * Indicates the heading level to use for the message "No bookmarks" when no bookmarks are available in this widget. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#headingLevel) */ headingLevel: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Bookmarks#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#iconClass) */ iconClass: string; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#viewModel) */ viewModel: BookmarksViewModel; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#visibleElements) */ visibleElements: BookmarksVisibleElements; /** * The Bookmarks widget allows end users to quickly navigate to a particular area of interest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html) */ constructor(properties?: BookmarksProperties); /** * Zoom to a specific bookmark. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#goTo) */ goTo(Bookmark: Bookmark): Promise; on(name: "bookmark-select", eventHandler: BookmarksBookmarkSelectEventHandler): IHandle; on(name: "bookmark-edit", eventHandler: BookmarksBookmarkEditEventHandler): IHandle; } interface BookmarksProperties extends WidgetProperties, GoToProperties { /** * A collection of [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html)s. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#bookmarks) */ bookmarks?: CollectionProperties; /** * Specifies how new bookmarks will be created if [visibleElements.addBookmarkButton](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#VisibleElements) is set to `true`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#defaultCreateOptions) */ defaultCreateOptions?: BookmarkOptions; /** * Specifies how bookmarks will be edited, if [visibleElements.editBookmarkButton](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#VisibleElements) is set to `true`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#defaultEditOptions) */ defaultEditOptions?: BookmarkOptions; /** * When true, the widget is visually withdrawn and cannot be interacted with. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#disabled) */ disabled?: boolean; /** * Indicates if a Bookmark is able to be dragged in order to update its position in the list. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#dragEnabled) */ dragEnabled?: boolean; /** * Indicates whether the bookmarks are able to be edited. * * @default false * @deprecated since 4.29. Use {@link module:esri/widgets/Bookmarks#VisibleElements visibleElements.editBookmarkButton}, {@link module:esri/widgets/Bookmarks#VisibleElements visibleElements.addBookmarkButton}, and {@link module:esri/widgets/Bookmarks#dragEnabled dragEnabled} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#editingEnabled) */ editingEnabled?: boolean; /** * Defines the text used as a placeholder when visibleElements.filter is set to `true`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#filterPlaceholder) */ filterPlaceholder?: string; /** * Defines the text used to filter the bookmarks when visibleElements.filter is set to `true`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#filterText) */ filterText?: string; /** * Indicates the heading level to use for the message "No bookmarks" when no bookmarks are available in this widget. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#headingLevel) */ headingLevel?: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Bookmarks#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#iconClass) */ iconClass?: string; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#viewModel) */ viewModel?: BookmarksViewModelProperties; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#visibleElements) */ visibleElements?: BookmarksVisibleElements; } export interface BookmarksViewModel extends Accessor, GoTo { } export class BookmarksViewModel { /** * Defines the abilities of the widget. * * @deprecated since 4.27. Use {@link module:esri/widgets/Bookmarks/BookmarksViewModel#capabilities capabilities} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#abilities) */ abilities: BookmarksCapabilities; /** * The [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) that is being navigated to. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#activeBookmark) */ readonly activeBookmark: Bookmark; /** * A collection of [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html)s. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#bookmarks) */ bookmarks: Collection; /** * Defines the capabilities of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#capabilities) */ capabilities: BookmarksCapabilities; /** * Specifies how new bookmarks will be created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#defaultCreateOptions) */ defaultCreateOptions: BookmarkOptions; /** * Specifies how bookmarks will be edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#defaultEditOptions) */ defaultEditOptions: BookmarkOptions; /** * The view model's state. * * @default ready * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#state) */ readonly state: "loading" | "ready"; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#view) */ view: MapView | SceneView; /** * Provides the logic for the [Bookmarks](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html) */ constructor(properties?: BookmarksViewModelProperties); /** * Creates a new bookmark from the [defaultCreateOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#defaultCreateOptions), unless otherwise specified. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#createBookmark) */ createBookmark(options?: BookmarkOptions): Promise; /** * Edits the given bookmark. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#editBookmark) */ editBookmark(bookmark: Bookmark, options?: BookmarkOptions): Promise; /** * Zoom to a specific bookmark. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#goTo) */ goTo(bookmark: Bookmark): Promise; } interface BookmarksViewModelProperties extends GoToProperties { /** * Defines the abilities of the widget. * * @deprecated since 4.27. Use {@link module:esri/widgets/Bookmarks/BookmarksViewModel#capabilities capabilities} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#abilities) */ abilities?: BookmarksCapabilities; /** * A collection of [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html)s. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#bookmarks) */ bookmarks?: CollectionProperties; /** * Defines the capabilities of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#capabilities) */ capabilities?: BookmarksCapabilities; /** * Specifies how new bookmarks will be created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#defaultCreateOptions) */ defaultCreateOptions?: BookmarkOptions; /** * Specifies how bookmarks will be edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#defaultEditOptions) */ defaultEditOptions?: BookmarkOptions; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } /** * Specifies how bookmarks will be created or modified. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#BookmarkOptions) */ export interface BookmarkOptions { /** * Indicates whether a screenshot is taken when a new bookmark is created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#BookmarkOptions) */ takeScreenshot?: boolean; /** * _Since 4.17_ Indicates whether the viewpoint of the current view will become the [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html#viewpoint) of a newly created or modified bookmark. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#BookmarkOptions) */ captureViewpoint?: boolean; /** * _Since 4.17_ Indicates whether the rotation of the current view will be saved in the [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html#viewpoint) of a newly created or modified bookmark. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#BookmarkOptions) */ captureRotation?: boolean; /** * _Since 4.17_ Indicates whether the scale of the current view will be saved in the [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html#viewpoint) of a newly created or modified bookmark. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#BookmarkOptions) */ captureScale?: boolean; /** * _Since 4.22_ Indicates whether the time extent of the current view will be saved in the [timeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html#timeExtent) of a newly created or modified bookmark. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#BookmarkOptions) */ captureTimeExtent?: boolean; /** * An object that specifies the settings of the screenshot that will be used to create the bookmark's [thumbnail](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html#thumbnail). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#BookmarkOptions) */ screenshotSettings?: BookmarkOptionsScreenshotSettings; } /** * Specifies the abilities for the Bookmarks widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#BookmarksCapabilities) */ export interface BookmarksCapabilities { /** * Indicates whether the time capability is enabled in the Bookmarks widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#BookmarksCapabilities) */ time?: boolean; } export interface BookmarkOptionsScreenshotSettings { /** * The width (in pixels) of the screenshot. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#BookmarkOptions) */ width?: number; /** * The height (in pixels) of the screenshot. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#BookmarkOptions) */ height?: number; /** * Used to take a screenshot of a subregion of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#BookmarkOptions) */ area?: BookmarkOptionsScreenshotSettingsArea; /** * An optional list of layers to be included in the screenshot. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#BookmarkOptions) */ layers?: Layer[]; } export interface BookmarkOptionsScreenshotSettingsArea { /** * The x value of the screenshot area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#BookmarkOptions) */ x?: number; /** * The y value of the screenshot area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#BookmarkOptions) */ y?: number; /** * The width of the screenshot area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#BookmarkOptions) */ width?: number; /** * The height of the screenshot area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#BookmarkOptions) */ height?: number; } export interface BookmarksBookmarkEditEvent { bookmark: Bookmark; } export interface BookmarksBookmarkSelectEvent { bookmark: Bookmark; } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#VisibleElements) */ export interface BookmarksVisibleElements { /** * _Deprecated since 4.29. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#VisibleElements) */ addBookmark?: boolean; /** * _Since 4.29._ Indicates whether the button to add a new bookmark displays. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#VisibleElements) */ addBookmarkButton?: boolean; /** * _Since 4.29._ Indicates whether to display a close button at the top of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#VisibleElements) */ closeButton?: boolean; /** * _Since 4.29._ Indicates whether to display a collapse button at the top of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#VisibleElements) */ collapseButton?: boolean; /** * _Since 4.29._ Indicates whether the button to edit a bookmark displays. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#VisibleElements) */ editBookmarkButton?: boolean; /** * _Since 4.29._ Indicates whether the bookmarks filter displays. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#VisibleElements) */ filter?: boolean; /** * _Since 4.29._ Determines whether the widget should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#VisibleElements) */ flow?: boolean; /** * _Since 4.29._ Indicates whether to display the widget heading. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#VisibleElements) */ heading?: boolean; /** * _Since 4.13._ Indicates whether the thumbnail associated with the bookmark displays. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#VisibleElements) */ thumbnail?: boolean; /** * _Since 4.22._ Indicates whether the time (`h:m:s`) is displayed alongside the date if the bookmark has a [time extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html#timeExtent) defined. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#VisibleElements) */ time?: boolean; } export class BuildingExplorer extends Widget { /** * Indicates the heading level to use for the headings in the widget. * * @default 3 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#headingLevel) */ headingLevel: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/BuildingExplorer#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#iconClass) */ iconClass: 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 widget for exploration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#layers) */ layers: Collection; /** * A reference to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#view) */ view: SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#viewModel) */ viewModel: BuildingExplorerViewModel; /** * This property provides the ability to display or hide the individual elements of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#visibleElements) */ visibleElements: BuildingExplorerVisibleElements; /** * The BuildingExplorer widget is used to filter and explore the various components of [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html) */ constructor(properties?: BuildingExplorerProperties); } interface BuildingExplorerProperties extends WidgetProperties { /** * Indicates the heading level to use for the headings in the widget. * * @default 3 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#headingLevel) */ headingLevel?: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/BuildingExplorer#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#iconClass) */ iconClass?: 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 widget for exploration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#layers) */ layers?: CollectionProperties; /** * A reference to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#view) */ view?: SceneViewProperties; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#viewModel) */ viewModel?: BuildingExplorerViewModelProperties; /** * This property provides the ability to display or hide the individual elements of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#visibleElements) */ visibleElements?: BuildingExplorerVisibleElements; } export class BuildingExplorerViewModel extends Accessor { /** * A collection of layers of type [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html) that are added to the widget for exploration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingExplorerViewModel.html#layers) */ layers: Collection; /** * 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: 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: BuildingPhase; /** * The current state of the view model that can be used for rendering the UI of the widget. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingExplorerViewModel.html#state) */ readonly state: "disabled" | "loading" | "ready" | "failed"; /** * The view in which the BuildingExplorer is used. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingExplorerViewModel.html#view) */ view: SceneView; /** * Provides the logic for the [BuildingExplorer](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingExplorerViewModel.html) */ constructor(properties?: BuildingExplorerViewModelProperties); } interface BuildingExplorerViewModelProperties { /** * A collection of layers of type [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html) that are added to the widget for exploration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingExplorerViewModel.html#layers) */ layers?: CollectionProperties; /** * The view in which the BuildingExplorer is used. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingExplorerViewModel.html#view) */ view?: SceneViewProperties; } export class BuildingLevel extends Accessor { /** * List of all the values which are allowed for the filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingLevel.html#allowedValues) */ readonly allowedValues: number[]; /** * Whether the filter is enabled. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingLevel.html#enabled) */ readonly enabled: boolean; /** * Whether the next value can be selected. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingLevel.html#hasNext) */ readonly hasNext: boolean; /** * Whether the previous value can be selected. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingLevel.html#hasPrevious) */ readonly hasPrevious: boolean; /** * The maximum value allowed for the filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingLevel.html#max) */ readonly max: number; /** * The minimum value allowed for the filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingLevel.html#min) */ readonly min: number; /** * The value which is currently set on the filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingLevel.html#value) */ readonly value: number; /** * Provides information for the building level filter, such as the value selected by the user or the minimum and maximum allowed values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingLevel.html) */ constructor(properties?: BuildingLevelProperties); /** * Removes the filter by setting [enabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingLevel.html#enabled) to `false`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingLevel.html#clear) */ clear(): void; /** * If the field that is used for filtering has a coded value domain, the label for the value can be used to be displayed in a tooltip or in the widget UI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingLevel.html#getValueLabel) */ getValueLabel(value: number): string | null; /** * Selects the next value, if available. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingLevel.html#next) */ next(): void; /** * Selects the previous value, if available. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingLevel.html#previous) */ previous(): void; /** * Selects the specified value for the filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingLevel.html#select) */ select(value: number): void; } interface BuildingLevelProperties { } export class BuildingPhase extends Accessor { /** * List of all the values which are allowed for the filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingPhase.html#allowedValues) */ readonly allowedValues: number[]; /** * Whether the filter is enabled. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingPhase.html#enabled) */ readonly enabled: boolean; /** * Whether the next value can be selected. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingPhase.html#hasNext) */ readonly hasNext: boolean; /** * Whether the previous value can be selected. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingPhase.html#hasPrevious) */ readonly hasPrevious: boolean; /** * The maximum value allowed for the filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingPhase.html#max) */ readonly max: number; /** * The minimum value allowed for the filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingPhase.html#min) */ readonly min: number; /** * The value which is currently set on the filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingPhase.html#value) */ readonly value: number; /** * BuildingPhase provides information for the construction phase filter, such as the value selected by the user or the minimum and maximum allowed values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingPhase.html) */ constructor(properties?: BuildingPhaseProperties); /** * Removes the filter by setting [enabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingPhase.html#enabled) to `false`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingPhase.html#clear) */ clear(): void; /** * If the field that is used for filtering has a coded value domain, the label for the value can be used to be displayed in a tooltip or in the widget UI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingPhase.html#getValueLabel) */ getValueLabel(value: number): string | null; /** * Selects the next value, if available. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingPhase.html#next) */ next(): void; /** * Selects the previous value, if available. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingPhase.html#previous) */ previous(): void; /** * Selects the specified value for the filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingPhase.html#select) */ select(value: number): void; } interface BuildingPhaseProperties { } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#VisibleElements) */ export interface BuildingExplorerVisibleElements { /** * When set to `false`, the building levels filter is not displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#VisibleElements) */ levels?: boolean; /** * When set to `false`, the construction phases filter is not displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#VisibleElements) */ phases?: boolean; /** * When set to `false`, the disciplines and categories sublayer list is not displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#VisibleElements) */ disciplines?: boolean; } export interface Compass extends Widget, GoTo { } export class Compass { /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Compass#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass.html#iconClass) */ iconClass: string; /** * The view in which the Compass obtains and indicates camera [heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading), using a (SceneView) or [rotation](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#rotation) (MapView). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass.html#viewModel) */ viewModel: CompassViewModel; /** * The Compass widget indicates where north is in relation to the current view [rotation](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#rotation) or [camera heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass.html) */ constructor(properties?: CompassProperties); /** * If working in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html), sets the view's [rotation](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#rotation) to `0`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass.html#reset) */ reset(): void; } interface CompassProperties extends WidgetProperties, GoToProperties { /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Compass#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass.html#iconClass) */ iconClass?: string; /** * The view in which the Compass obtains and indicates camera [heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading), using a (SceneView) or [rotation](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#rotation) (MapView). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass.html#viewModel) */ viewModel?: CompassViewModelProperties; } export interface CompassViewModel extends Accessor, GoTo { } export class CompassViewModel { /** * The orientation axes (x, y, z). * * @default { x: 0, y: 0, z: 0 } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass-CompassViewModel.html#orientation) */ orientation: any; /** * The view model's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass-CompassViewModel.html#state) */ readonly state: "compass" | "rotation" | "disabled"; /** * The view in which the Compass obtains and indicates camera [heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading), using a (SceneView) or [rotation](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#rotation) (MapView). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass-CompassViewModel.html#view) */ view: MapView | SceneView; /** * Provides the logic for the [Compass](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass-CompassViewModel.html) */ constructor(properties?: CompassViewModelProperties); /** * If working in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html), sets the view's [rotation](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#rotation) is to `0`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass-CompassViewModel.html#reset) */ reset(): void; } interface CompassViewModelProperties extends GoToProperties { /** * The orientation axes (x, y, z). * * @default { x: 0, y: 0, z: 0 } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass-CompassViewModel.html#orientation) */ orientation?: any; /** * The view in which the Compass obtains and indicates camera [heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading), using a (SceneView) or [rotation](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#rotation) (MapView). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass-CompassViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } export interface CoordinateConversion extends Widget, GoTo { } export class CoordinateConversion { /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) containing every [Conversion](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html) that the widget is currently displaying. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#conversions) */ conversions: Collection; /** * Describes the location of the coordinates currently displayed by the widget as a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#currentLocation) */ readonly currentLocation: Point; /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) containing every [Format](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html) that the widget is capable of displaying. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#formats) */ formats: Collection; /** * Indicates the heading level to use for the coordinate input and coordinate settings headings. * * @default 4 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#headingLevel) */ headingLevel: number; /** * This symbol is used to visualize the location currently described by the widget when `capture` mode is active. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#locationSymbol) */ locationSymbol: SimpleMarkerSymbol | PictureMarkerSymbol; /** * Describes the current mode of the widget. * * @default live * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#mode) */ mode: "live" | "capture"; /** * If this property is set to `true`, multiple conversions can be displayed. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#multipleConversions) */ multipleConversions: boolean; /** * Determines whether the widget should expand up or down. * * @default auto * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#orientation) */ orientation: "auto" | "expand-up" | "expand-down"; /** * If this property is set to `true`, sessionStorage or localStorage (depending on [storageType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#storageType)) will be used to hydrate and persist the CoordinateConversion widget's state. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#storageEnabled) */ storageEnabled: boolean; /** * This property determines whether sessionStorage or localStorage will be used to store widget state. * * @default "session" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#storageType) */ storageType: "session" | "local"; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#viewModel) */ viewModel: CoordinateConversionViewModel; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#visibleElements) */ visibleElements: CoordinateConversionVisibleElements; /** * The CoordinateConversion widget provides a way to display user cursor position either as map coordinates or as any of several popular coordinate notations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html) */ constructor(properties?: CoordinateConversionProperties); /** * Attempt to convert a string into a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#reverseConvert) */ reverseConvert(coordinate: string, format: Format): Promise; } interface CoordinateConversionProperties extends WidgetProperties, GoToProperties { /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) containing every [Conversion](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html) that the widget is currently displaying. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#conversions) */ conversions?: CollectionProperties; /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) containing every [Format](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html) that the widget is capable of displaying. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#formats) */ formats?: CollectionProperties; /** * Indicates the heading level to use for the coordinate input and coordinate settings headings. * * @default 4 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#headingLevel) */ headingLevel?: number; /** * This symbol is used to visualize the location currently described by the widget when `capture` mode is active. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#locationSymbol) */ locationSymbol?: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }); /** * Describes the current mode of the widget. * * @default live * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#mode) */ mode?: "live" | "capture"; /** * If this property is set to `true`, multiple conversions can be displayed. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#multipleConversions) */ multipleConversions?: boolean; /** * Determines whether the widget should expand up or down. * * @default auto * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#orientation) */ orientation?: "auto" | "expand-up" | "expand-down"; /** * If this property is set to `true`, sessionStorage or localStorage (depending on [storageType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#storageType)) will be used to hydrate and persist the CoordinateConversion widget's state. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#storageEnabled) */ storageEnabled?: boolean; /** * This property determines whether sessionStorage or localStorage will be used to store widget state. * * @default "session" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#storageType) */ storageType?: "session" | "local"; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#viewModel) */ viewModel?: CoordinateConversionViewModelProperties; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#visibleElements) */ visibleElements?: CoordinateConversionVisibleElements; } export interface CoordinateConversionViewModel extends Accessor, GoTo { } export class CoordinateConversionViewModel { /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) containing every [Conversion](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html) that the widget is currently displaying. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#conversions) */ conversions: Collection; /** * Describes the location of the coordinates currently displayed by the widget as a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#currentLocation) */ currentLocation: Point; /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) containing every [Format](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html) that the widget is capable of displaying. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#formats) */ formats: Collection; /** * This symbol is used to visualize the location currently described by the widget when `capture` mode is active. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#locationSymbol) */ locationSymbol: SimpleMarkerSymbol | PictureMarkerSymbol; /** * Describes the current mode of the widget. * * @default live * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#mode) */ mode: "live" | "capture"; /** * The view model's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#state) */ readonly state: "ready" | "loading" | "disabled"; /** * If this property is set to `true`, sessionStorage or localStorage (depending on [storageType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#storageType)) will be used to hydrate and persist the CoordinateConversion widget's state. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#storageEnabled) */ storageEnabled: boolean; /** * This property determines whether sessionStorage or localStorage will be used to store widget state. * * @default "session" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#storageType) */ storageType: "session" | "local"; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#view) */ view: MapView | SceneView; /** * Provides the logic for the [CoordinateConversion](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html) */ constructor(properties?: CoordinateConversionViewModelProperties); /** * Attempt to convert a point into a [Position](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#Position). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#convert) */ convert(point: Point, format: Format): Promise; /** * Attempt to convert a string into a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#reverseConvert) */ reverseConvert(coordinate: string, format: Format): Promise; /** * Update the input conversions based on the input point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#updateConversions) */ updateConversions(conversions: Conversion[], location: Point): Promise; } interface CoordinateConversionViewModelProperties extends GoToProperties { /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) containing every [Conversion](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html) that the widget is currently displaying. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#conversions) */ conversions?: CollectionProperties; /** * Describes the location of the coordinates currently displayed by the widget as a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#currentLocation) */ currentLocation?: PointProperties; /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) containing every [Format](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html) that the widget is capable of displaying. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#formats) */ formats?: CollectionProperties; /** * This symbol is used to visualize the location currently described by the widget when `capture` mode is active. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#locationSymbol) */ locationSymbol?: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }); /** * Describes the current mode of the widget. * * @default live * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#mode) */ mode?: "live" | "capture"; /** * If this property is set to `true`, sessionStorage or localStorage (depending on [storageType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#storageType)) will be used to hydrate and persist the CoordinateConversion widget's state. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#storageEnabled) */ storageEnabled?: boolean; /** * This property determines whether sessionStorage or localStorage will be used to store widget state. * * @default "session" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#storageType) */ storageType?: "session" | "local"; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } /** * Describes a point in terms of a location, a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html), and a coordinate, a string. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#Position) */ export interface Position { /** * A point geometry representing the location described by the conversion. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#Position) */ location: Point; /** * A string representing the location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#Position) */ coordinate: string; } export class Conversion extends Accessor { /** * A formatted string based on the current [position](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html#position) and display information on the [format](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html#format). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html#displayCoordinate) */ readonly displayCoordinate: string; /** * The [Format](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html) for this conversion. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html#format) */ format: Format; /** * The position property contains the location information for this conversion. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html#position) */ position: ConversionPosition; /** * The Conversion class represents one of the [conversions](esri-widgets-CoordinateConversion.html#conversions) in the [Coordinate Conversion widget](esri-widgets-CoordinateConversion.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html) */ constructor(properties?: ConversionProperties); } interface ConversionProperties { /** * The [Format](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html) for this conversion. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html#format) */ format?: FormatProperties; /** * The position property contains the location information for this conversion. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html#position) */ position?: ConversionPosition; } /** * Describes a point in terms of a location, a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html), and a coordinate, a string. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html#Position) */ export interface ConversionPosition { /** * A point geometry representing the location described by the conversion. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html#Position) */ location: Point; /** * A string representing the location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html#Position) */ coordinate: string; } export class Format extends Accessor { /** * Contains information that describes how this Format should be converted. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#conversionInfo) */ conversionInfo: ConversionInfo; /** * A array of [Coordinate Segments](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#CoordinateSegment). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#coordinateSegments) */ coordinateSegments: CoordinateSegment[]; /** * A string that serves as a pattern describing how this Format should be displayed. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#currentPattern) */ currentPattern: string; /** * The default pattern describing how this Format should be displayed. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#defaultPattern) */ defaultPattern: string; /** * A string that is used to label this Format in the UI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#label) */ label: string; /** * The name of the coordinate. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#name) */ name: string; /** * The [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) for this format. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#spatialReference) */ spatialReference: SpatialReference; /** * The view model of the [CoordinateConversion](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html) widget that is utilizing this format. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#viewModel) */ viewModel: CoordinateConversionViewModel; /** * The Format class represents one of the [formats](esri-widgets-CoordinateConversion.html#formats) in the [Coordinate Conversion widget](esri-widgets-CoordinateConversion.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html) */ constructor(properties?: FormatProperties); } interface FormatProperties { /** * Contains information that describes how this Format should be converted. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#conversionInfo) */ conversionInfo?: ConversionInfo; /** * A array of [Coordinate Segments](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#CoordinateSegment). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#coordinateSegments) */ coordinateSegments?: CoordinateSegment[]; /** * A string that serves as a pattern describing how this Format should be displayed. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#currentPattern) */ currentPattern?: string; /** * The default pattern describing how this Format should be displayed. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#defaultPattern) */ defaultPattern?: string; /** * A string that is used to label this Format in the UI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#label) */ label?: string; /** * The name of the coordinate. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#name) */ name?: string; /** * The [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) for this format. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * The view model of the [CoordinateConversion](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html) widget that is utilizing this format. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#viewModel) */ viewModel?: CoordinateConversionViewModelProperties; } /** * This object describes how a Format should be projected and formatted for display. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#ConversionInfo) */ export interface ConversionInfo { /** * A function that takes a point and returns a [position](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#Position). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#ConversionInfo) */ convert?: ConvertFunction; /** * A function that takes a string and returns a Point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#ConversionInfo) */ reverseConvert?: ReverseConvertFunction; } export type ConvertFunction = (point: Point) => FormatPosition; /** * A coordinate segment represents one piece of a coordinate string. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#CoordinateSegment) */ export interface CoordinateSegment { /** * A string that provides the name for this segment of a coordinate string. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#CoordinateSegment) */ alias: string; /** * A string that describes the role of this segment. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#CoordinateSegment) */ description: string; /** * A regular expression that should extract this segment from the complete coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#CoordinateSegment) */ searchPattern: RegExp; } /** * Describes a point in terms of a location, a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html), and a coordinate, a string. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#Position) */ export interface FormatPosition { /** * A point geometry representing the location described by the conversion. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#Position) */ location: Point; /** * A string representing the location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#Position) */ coordinate: string; } export type ReverseConvertFunction = (coordinate: string) => Point; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#VisibleElements) */ export interface CoordinateConversionVisibleElements { /** * Indicates whether the settings button will be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#VisibleElements) */ settingsButton?: boolean; /** * Indicates whether the input coordinate button will be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#VisibleElements) */ editButton?: boolean; /** * Indicates whether the expand and retract buttons will be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#VisibleElements) */ expandButton?: boolean; /** * Indicates whether the capture mode button will be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#VisibleElements) */ captureButton?: boolean; } export class Daylight extends Widget { /** * Controls whether the widget displays a date or a season picker. * * @default "date" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#dateOrSeason) */ dateOrSeason: "season" | "date"; /** * Indicates the heading level to use for the widget title. * * @default 3 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#headingLevel) */ headingLevel: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Daylight#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#iconClass) */ iconClass: string; /** * Controls the speed of the daytime and date animation. * * @default 1.0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#playSpeedMultiplier) */ playSpeedMultiplier: number; /** * Sets steps, or intervals, on the time slider to restrict the times of the day that can be selected when dragging the thumb. * * @default 5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#timeSliderSteps) */ timeSliderSteps: number | number[]; /** * A reference to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#view) */ view: SceneView; /** * The view model for the Daylight widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#viewModel) */ viewModel: DaylightViewModel; /** * This property provides the ability to display or hide the individual elements of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#visibleElements) */ visibleElements: DaylightVisibleElements; /** * The Daylight widget can be used to manipulate the lighting conditions of a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html) */ constructor(properties?: DaylightProperties); } interface DaylightProperties extends WidgetProperties { /** * Controls whether the widget displays a date or a season picker. * * @default "date" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#dateOrSeason) */ dateOrSeason?: "season" | "date"; /** * Indicates the heading level to use for the widget title. * * @default 3 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#headingLevel) */ headingLevel?: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Daylight#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#iconClass) */ iconClass?: string; /** * Controls the speed of the daytime and date animation. * * @default 1.0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#playSpeedMultiplier) */ playSpeedMultiplier?: number; /** * Sets steps, or intervals, on the time slider to restrict the times of the day that can be selected when dragging the thumb. * * @default 5 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#timeSliderSteps) */ timeSliderSteps?: number | number[]; /** * A reference to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#view) */ view?: SceneViewProperties; /** * The view model for the Daylight widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#viewModel) */ viewModel?: DaylightViewModelProperties; /** * This property provides the ability to display or hide the individual elements of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#visibleElements) */ visibleElements?: DaylightVisibleElements; } export class DaylightViewModel extends Accessor { /** * A season can be set instead of a date. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#currentSeason) */ currentSeason: "spring" | "summer" | "fall" | "winter"; /** * Starts or pauses the daytime animation cycling through the minutes of the day. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#dayPlaying) */ dayPlaying: boolean; /** * Indicates whether to show shadows cast by the sun. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#directShadowsEnabled) */ directShadowsEnabled: boolean; /** * The calendar date in the timezone given by [utcOffset](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#utcOffset). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#localDate) */ localDate: Date; /** * Controls the daytime and date animation speed. * * @default 1.0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#playSpeedMultiplier) */ playSpeedMultiplier: number; /** * Indicates whether date and time are used to determine position of the light source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#sunLightingEnabled) */ sunLightingEnabled: boolean; /** * Slider position for the time of day in the timezone given by [utcOffset](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#utcOffset). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#timeSliderPosition) */ timeSliderPosition: number; /** * The difference in hours between UTC time and the time displayed in the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#utcOffset) */ utcOffset: number; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#view) */ view: SceneView; /** * Starts or pauses the date animation cycling through the months of the year. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#yearPlaying) */ yearPlaying: boolean; /** * Provides the logic for the [Daylight](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html) */ constructor(properties?: DaylightViewModelProperties); } interface DaylightViewModelProperties { /** * A season can be set instead of a date. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#currentSeason) */ currentSeason?: "spring" | "summer" | "fall" | "winter"; /** * Starts or pauses the daytime animation cycling through the minutes of the day. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#dayPlaying) */ dayPlaying?: boolean; /** * Indicates whether to show shadows cast by the sun. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#directShadowsEnabled) */ directShadowsEnabled?: boolean; /** * The calendar date in the timezone given by [utcOffset](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#utcOffset). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#localDate) */ localDate?: DateProperties; /** * Controls the daytime and date animation speed. * * @default 1.0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#playSpeedMultiplier) */ playSpeedMultiplier?: number; /** * Indicates whether date and time are used to determine position of the light source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#sunLightingEnabled) */ sunLightingEnabled?: boolean; /** * Slider position for the time of day in the timezone given by [utcOffset](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#utcOffset). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#timeSliderPosition) */ timeSliderPosition?: number; /** * The difference in hours between UTC time and the time displayed in the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#utcOffset) */ utcOffset?: number; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#view) */ view?: SceneViewProperties; /** * Starts or pauses the date animation cycling through the months of the year. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#yearPlaying) */ yearPlaying?: boolean; } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#VisibleElements) */ export interface DaylightVisibleElements { /** * When set to `false`, the header is not displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#VisibleElements) */ header?: boolean; /** * When set to `false`, neither of the play buttons are displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#VisibleElements) */ playButtons?: boolean; /** * When set to `false`, neither the date nor the season picker are displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#VisibleElements) */ datePicker?: boolean; /** * When set to `false`, the timezone selector is not displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#VisibleElements) */ timezone?: boolean; /** * When set to `false`, the sun lighting checkbox is not displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#VisibleElements) */ sunLightingToggle?: boolean; /** * When set to `false`, the shadows checkbox is not displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#VisibleElements) */ shadowsToggle?: boolean; } export class DirectionalPad extends Widget { /** * Indicates whether interaction is allowed on the widget. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad.html#disabled) */ disabled: boolean; /** * The view which the directional pad will control. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad.html#view) */ view: MapView; /** * The view model for the DirectionalPad widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad.html#viewModel) */ viewModel: DirectionalPadViewModel; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad.html#visibleElements) */ visibleElements: DirectionalPadVisibleElements; /** * Determines the size of directional pad buttons and the slider. * * @default 's' * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad.html#visualScale) */ visualScale: "s" | "m" | "l"; /** * A directional pad (D-Pad) widget can be used to control the position and rotation of the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad.html) */ constructor(properties?: DirectionalPadProperties); } interface DirectionalPadProperties extends WidgetProperties { /** * Indicates whether interaction is allowed on the widget. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad.html#disabled) */ disabled?: boolean; /** * The view which the directional pad will control. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad.html#view) */ view?: MapViewProperties; /** * The view model for the DirectionalPad widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad.html#viewModel) */ viewModel?: DirectionalPadViewModelProperties; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad.html#visibleElements) */ visibleElements?: DirectionalPadVisibleElements; /** * Determines the size of directional pad buttons and the slider. * * @default 's' * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad.html#visualScale) */ visualScale?: "s" | "m" | "l"; } export class DirectionalPadViewModel extends Accessor { /** * The closest angle that matches the current mouse position relative to the widget's center. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad-DirectionalPadViewModel.html#angle) */ readonly angle: number | undefined; /** * Indicates whether interaction is allowed on the widget. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad-DirectionalPadViewModel.html#disabled) */ disabled: boolean; /** * The angle of rotation of the map. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad-DirectionalPadViewModel.html#rotation) */ rotation: number; /** * The state of the view model. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad-DirectionalPadViewModel.html#state) */ readonly state: "disabled" | "ready" | "moving"; /** * Provides the logic for the [DirectionalPad](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad-DirectionalPadViewModel.html) */ constructor(properties?: DirectionalPadViewModelProperties); /** * Starts movement in the correct direction according to pointer location, and listens for pointer move (to change direction) or release (to stop movement) This method should be called in response to pointerdown event on a button * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad-DirectionalPadViewModel.html#beginFollowingPointer) */ beginFollowingPointer(pointerLocation: Vector, widgetCenter: Vector): void; /** * Initialize a brief movement in a desired direction * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad-DirectionalPadViewModel.html#moveOnce) */ moveOnce(angle: number): void; } interface DirectionalPadViewModelProperties { /** * Indicates whether interaction is allowed on the widget. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad-DirectionalPadViewModel.html#disabled) */ disabled?: boolean; /** * The angle of rotation of the map. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad-DirectionalPadViewModel.html#rotation) */ rotation?: number; } /** * An x/y coordinate pair. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad-DirectionalPadViewModel.html#Vector) */ export interface Vector { /** * X coordinate * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad-DirectionalPadViewModel.html#Vector) */ x?: number; /** * Y coordinate * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad-DirectionalPadViewModel.html#Vector) */ y?: number; } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad.html#VisibleElements) */ export interface DirectionalPadVisibleElements { /** * Indicates whether to display the directional pad buttons. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad.html#VisibleElements) */ directionalButtons?: boolean; /** * Indicates whether to display the map rotation slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad.html#VisibleElements) */ rotationSlider?: boolean; /** * Indicates whether to display the button to reset the rotation angle. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad.html#VisibleElements) */ rotationResetButton?: boolean; } export interface Directions extends Widget, GoTo { } export class Directions { /** * An authorization string used to access a resource or service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#apiKey) */ apiKey: string; /** * Indicates the heading level to use for the origin and destination addresses (i.e. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#headingLevel) */ headingLevel: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Directions#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#iconClass) */ iconClass: string; /** * The most recent route result. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#lastRoute) */ readonly lastRoute: DirectionsLastRoute; /** * The [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html) associated with the Directions widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#layer) */ layer: RouteLayer; /** * The maximum number of stops allowed for routing. * * @default 50 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#maxStops) */ maxStops: number; /** * Controls the default properties used when [searching](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#searchProperties) */ searchProperties: DirectionsSearchProperties; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#unit) */ unit: | "imperial" | "metric" | "centimeters" | "decimeters" | "feet" | "inches" | "kilometers" | "meters" | "miles" | "millimeters" | "nautical-miles" | "yards"; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#viewModel) */ viewModel: DirectionsViewModel; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#visibleElements) */ visibleElements: DirectionsVisibleElements; /** * The Directions widget provides a way to calculate directions, between two or more input locations with a [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html), using ArcGIS Online and custom Network Analysis Route services. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html) */ constructor(properties?: DirectionsProperties); /** * Computes a route and directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#getDirections) */ getDirections(): Promise; /** * Saves the RouteLayer associated with the view model. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#save) */ save(): Promise; /** * Saves the RouteLayer associated with the view model as a new portal item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#saveAs) */ saveAs(portalItem: Promise, options?: DirectionsSaveAsOptions): Promise; /** * Zoom so that the full route is displayed within the current map extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#zoomToRoute) */ zoomToRoute(): void; } interface DirectionsProperties extends WidgetProperties, GoToProperties { /** * An authorization string used to access a resource or service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#apiKey) */ apiKey?: string; /** * Indicates the heading level to use for the origin and destination addresses (i.e. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#headingLevel) */ headingLevel?: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Directions#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#iconClass) */ iconClass?: string; /** * The [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html) associated with the Directions widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#layer) */ layer?: RouteLayerProperties; /** * The maximum number of stops allowed for routing. * * @default 50 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#maxStops) */ maxStops?: number; /** * Controls the default properties used when [searching](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#searchProperties) */ searchProperties?: DirectionsSearchProperties; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#unit) */ unit?: | "imperial" | "metric" | "centimeters" | "decimeters" | "feet" | "inches" | "kilometers" | "meters" | "miles" | "millimeters" | "nautical-miles" | "yards"; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#viewModel) */ viewModel?: DirectionsViewModelProperties; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#visibleElements) */ visibleElements?: DirectionsVisibleElements; } export interface DirectionsViewModel extends Accessor, GoTo { } export class DirectionsViewModel { /** * An authorization string used to access a resource or service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#apiKey) */ apiKey: string; /** * The network attribute name to be used as the impedance attribute in the analysis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#impedanceAttribute) */ readonly impedanceAttribute: DirectionsViewModelImpedanceAttribute; /** * The most recent route result. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#lastRoute) */ readonly lastRoute: DirectionsViewModelLastRoute; /** * The [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html) associated with the DirectionsViewModel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#layer) */ layer: RouteLayer; /** * The maximum number of stops allowed for routing. * * @default 50 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#maxStops) */ maxStops: number; /** * Route Parameters object used to call the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#routeParameters) */ routeParameters: RouteParameters; /** * The travel mode that will be used by [getDirections()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#getDirections) when requesting the route and directions. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#selectedTravelMode) */ selectedTravelMode: TravelMode; /** * The Service Description object returned by the Route REST Endpoint. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#serviceDescription) */ readonly serviceDescription: ServiceDescription; /** * The current state of the view model. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#state) */ readonly state: "disabled" | "ready"; /** * The name of the network attribute to use for the drive time when computing directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#timeAttribute) */ readonly timeAttribute: DirectionsViewModelTimeAttribute; /** * An array of available [travel modes](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-TravelMode.html) from the associated [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#layer)'s routing service (see [RouteLayer.url](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#url)). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#travelModes) */ readonly travelModes: TravelMode[]; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#view) */ view: MapView | SceneView; /** * Provides the communication and data manipulation logic for the [Directions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html) */ constructor(properties?: DirectionsViewModelProperties); /** * Centers the map at the specified maneuver or stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#centerAt) */ centerAt(stopOrManeuver: Graphic): void; /** * Clears any highlighted route segments. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#clearHighlights) */ clearHighlights(): void; /** * Removes the route directions from the directions list, leaving the inputs untouched. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#clearResults) */ clearResults(): void; /** * Returns the cost attribute associated with the parsed name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#getCostAttribute) */ getCostAttribute(attributeName: string): any; /** * Computes a route and directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#getDirections) */ getDirections(): Promise; /** * Highlights the specified network feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#highlight) */ highlight(networkFeature: | DirectionLine | DirectionPoint | PointBarrier | PolygonBarrier | PolylineBarrier | RouteInfo | Stop): Promise; /** * This method should be called to load the view model's routing resources. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#load) */ load(): Promise; /** * Resets the state of the ViewModel, clearing all the input stops and results in the widget and in the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#reset) */ reset(): void; /** * Saves the RouteLayer associated with the view model. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#save) */ save(): Promise; /** * Saves the RouteLayer associated with the view model as a new portal item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#saveAs) */ saveAs(portalItem: Promise, options?: DirectionsViewModelSaveAsOptions): Promise; /** * Zoom so that the full route is displayed within the current map extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#zoomToRoute) */ zoomToRoute(): void; } interface DirectionsViewModelProperties extends GoToProperties { /** * An authorization string used to access a resource or service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#apiKey) */ apiKey?: string; /** * The [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html) associated with the DirectionsViewModel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#layer) */ layer?: RouteLayerProperties; /** * The maximum number of stops allowed for routing. * * @default 50 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#maxStops) */ maxStops?: number; /** * Route Parameters object used to call the service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#routeParameters) */ routeParameters?: RouteParametersProperties; /** * The travel mode that will be used by [getDirections()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#getDirections) when requesting the route and directions. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#selectedTravelMode) */ selectedTravelMode?: TravelModeProperties; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } export interface DirectionsViewModelImpedanceAttribute { /** * Name of the impedance network attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#impedanceAttribute) */ name: string; /** * Units of this network attribute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#impedanceAttribute) */ units: string; } export interface DirectionsViewModelLastRoute extends RouteLayerSolveResult { /** * Collection of direction polylines associated with line segments between turns. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#lastRoute) */ directionLines: Collection; /** * Collection of direction items as points with various display information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#lastRoute) */ directionPoints: Collection; /** * Collection of point barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#lastRoute) */ pointBarriers: Collection; /** * Collection of polygon barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#lastRoute) */ polygonBarriers: Collection; /** * Collection of polyline barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#lastRoute) */ polylineBarriers: Collection; /** * Information about a solved route including the route's geometry and overall distance and time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#lastRoute) */ routeInfo: RouteInfo; /** * Collection of stops. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#lastRoute) */ stops: Collection; } export interface DirectionsViewModelSaveAsOptions { /** * The folder in which to save the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#saveAs) */ folder?: PortalFolder; } export interface DirectionsViewModelTimeAttribute { /** * The name of the network attribute to use for the drive time when computing directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#timeAttribute) */ name: string; /** * The units to use when calculating drive time for directions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#timeAttribute) */ units: string; } export interface DirectionsLastRoute extends RouteLayerSolveResult { /** * Collection of direction polylines associated with line segments between turns. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#lastRoute) */ directionLines: Collection; /** * Collection of direction items as points with various display information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#lastRoute) */ directionPoints: Collection; /** * Collection of point barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#lastRoute) */ pointBarriers: Collection; /** * Collection of polygon barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#lastRoute) */ polygonBarriers: Collection; /** * Collection of polyline barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#lastRoute) */ polylineBarriers: Collection; /** * Information about a solved route including the route's geometry and overall distance and time. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#lastRoute) */ routeInfo: RouteInfo; /** * Collection of stops. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#lastRoute) */ stops: Collection; } export interface DirectionsSaveAsOptions { /** * The folder in which to save the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#saveAs) */ folder?: PortalFolder; } /** * Configurable Search properties of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ export interface DirectionsSearchProperties { /** * Number index indicating the current selected source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ activeSourceIndex?: number; /** * String value used as a hint for input text when searching on multiple sources. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ allPlaceholder?: string; /** * Indicates whether to automatically navigate to the selected result once selected. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ autoNavigate?: boolean; /** * Indicates whether to automatically select and zoom to the first geocoded result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ autoSelect?: boolean; /** * Indicates whether or not to include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ includeDefaultSources?: boolean | Function; /** * Define the type of location, either `"street"` or `"rooftop"`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ locationType?: string; /** * Indicates the maximum number of search results to return. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ maxResults?: number; /** * Indicates the maximum number of suggestions to return for the widget's input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ maxSuggestions?: number; /** * Indicates the minimum number of characters required before querying for a suggestion. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ minSuggestCharacters?: number; /** * Indicates whether to display a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) when a selected result is clicked. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ popupEnabled?: boolean; /** * A customized PopupTemplate for the selected feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ popupTemplate?: PopupTemplate; /** * Indicates whether to show a graphic on the map for the selected source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ resultGraphicEnabled?: boolean; /** * Indicates whether to display the option to search all sources. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ searchAllEnabled?: boolean; /** * The value of the search box input text string. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ searchTerm?: string; /** * Specifies the sources to search in the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#view). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ sources?: Collection; /** * Indicates whether to display suggestions as the user enters input text in the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ suggestionsEnabled?: boolean; /** * The view of the widget. * * [Read more...](global.html) */ view?: MapView | SceneView; /** * The Search widget's view model. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ viewModel?: SearchViewModel; } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#VisibleElements) */ export interface DirectionsVisibleElements { /** * Indicates whether to a link to the route layer portal-item (if any) will be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#VisibleElements) */ layerDetails?: boolean; /** * Indicates whether to the Save As button will be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#VisibleElements) */ saveAsButton?: boolean; /** * Indicates whether to the Save button will be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#VisibleElements) */ saveButton?: boolean; } export class DirectLineMeasurement3D extends Widget { /** * The direct line measurement analysis object being created or modified by the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#analysis) */ readonly analysis: DirectLineMeasurementAnalysis; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/DirectLineMeasurement3D#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#iconClass) */ iconClass: string; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#unit) */ unit: SystemOrLengthUnit; /** * List of unit systems (imperial, metric) and specific units for displaying the distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#unitOptions) */ unitOptions: SystemOrLengthUnit[]; /** * A reference to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#view) */ view: SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#viewModel) */ viewModel: DirectLineMeasurement3DViewModel; /** * The DirectLineMeasurement3D widget calculates and displays the 3D distance between two points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html) */ constructor(properties?: DirectLineMeasurement3DProperties); } interface DirectLineMeasurement3DProperties extends WidgetProperties { /** * The direct line measurement analysis object being created or modified by the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#analysis) */ analysis?: DirectLineMeasurementAnalysisProperties; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/DirectLineMeasurement3D#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#iconClass) */ iconClass?: string; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#unit) */ unit?: | "imperial" | "metric" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"; /** * List of unit systems (imperial, metric) and specific units for displaying the distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#unitOptions) */ unitOptions?: ( | "imperial" | "metric" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet" )[]; /** * A reference to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#view) */ view?: SceneViewProperties; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#viewModel) */ viewModel?: DirectLineMeasurement3DViewModelProperties; } export class DirectLineMeasurement3DViewModel extends Accessor { /** * The direct line measurement analysis object being created or modified by the view model. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#analysis) */ readonly analysis: DirectLineMeasurementAnalysis; /** * The current measurement calculated between the two points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#measurement) */ readonly measurement: DirectLineMeasurement3DViewModelMeasurement; /** * The view model's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#state) */ readonly state: "disabled" | "ready" | "measuring" | "measured"; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#unit) */ unit: SystemOrLengthUnit; /** * List of unit systems (imperial, metric) and specific units for displaying the distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#unitOptions) */ unitOptions: SystemOrLengthUnit[]; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#view) */ view: SceneView; /** * Provides the logic for the [DirectLineMeasurement3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html) */ constructor(properties?: DirectLineMeasurement3DViewModelProperties); /** * Clears the current measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#clear) */ clear(): void; /** * Starts a new measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#start) */ start(): void; } interface DirectLineMeasurement3DViewModelProperties { /** * The direct line measurement analysis object being created or modified by the view model. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#analysis) */ analysis?: DirectLineMeasurementAnalysisProperties; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#unit) */ unit?: | "imperial" | "metric" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"; /** * List of unit systems (imperial, metric) and specific units for displaying the distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#unitOptions) */ unitOptions?: ( | "imperial" | "metric" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet" )[]; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#view) */ view?: SceneViewProperties; } export interface DirectLineMeasurement3DViewModelMeasurement { /** * Describes how the `horizontalDistance` is computed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#measurement) */ mode: "euclidean" | "geodesic"; /** * The 3D distance between the two points that is computed in a Euclidean manner. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#measurement) */ directDistance: DirectLineMeasurement3DViewModelMeasurementValue; /** * The 2D distance between the two points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#measurement) */ horizontalDistance: DirectLineMeasurement3DViewModelMeasurementValue; /** * The elevation difference between the two points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#measurement) */ verticalDistance: DirectLineMeasurement3DViewModelMeasurementValue; } /** * Measurement value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#MeasurementValue) */ export interface DirectLineMeasurement3DViewModelMeasurementValue { /** * Textual representation of the measured value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#MeasurementValue) */ text: string; /** * State of the measured value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#MeasurementValue) */ state: string; } export class DistanceMeasurement2D extends Widget { /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/DistanceMeasurement2D#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D.html#iconClass) */ iconClass: string; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D.html#unit) */ unit: SystemOrLengthUnit; /** * List of available units and unit systems (imperial, metric) for displaying the distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D.html#unitOptions) */ unitOptions: SystemOrLengthUnit[]; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D.html#view) */ view: MapView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D.html#viewModel) */ viewModel: DistanceMeasurement2DViewModel; /** * The DistanceMeasurement2D widget calculates and displays the distance between two or more points in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D.html) */ constructor(properties?: DistanceMeasurement2DProperties); } interface DistanceMeasurement2DProperties extends WidgetProperties { /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/DistanceMeasurement2D#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D.html#iconClass) */ iconClass?: string; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D.html#unit) */ unit?: | "imperial" | "metric" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"; /** * List of available units and unit systems (imperial, metric) for displaying the distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D.html#unitOptions) */ unitOptions?: ( | "imperial" | "metric" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet" )[]; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D.html#view) */ view?: MapViewProperties; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D.html#viewModel) */ viewModel?: DistanceMeasurement2DViewModelProperties; } export class DistanceMeasurement2DViewModel extends Accessor { /** * Threshold (in meters) which determines the method for computing and displaying distances in non-Web Mercator projected coordinate systems (PCS). * * @default null * @deprecated since version 4.29. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#geodesicDistanceThreshold) */ geodesicDistanceThreshold: number; /** * The length and geometry of the measurement polyline in meters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#measurement) */ readonly measurement: DistanceMeasurement2DViewModelMeasurement; /** * This property returns the locale specific representation of the length. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#measurementLabel) */ readonly measurementLabel: string; /** * The view model's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#state) */ readonly state: "disabled" | "ready" | "measuring" | "measured"; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#unit) */ unit: SystemOrLengthUnit; /** * List of available units and unit systems (imperial, metric) for displaying the distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#unitOptions) */ unitOptions: SystemOrLengthUnit[]; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#view) */ view: MapView; /** * Provides the logic for the [DistanceMeasurement2D](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html) */ constructor(properties?: DistanceMeasurement2DViewModelProperties); /** * Clears the current measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#clear) */ clear(): void; /** * Starts a new measurement. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#start) */ start(): void; } interface DistanceMeasurement2DViewModelProperties { /** * Threshold (in meters) which determines the method for computing and displaying distances in non-Web Mercator projected coordinate systems (PCS). * * @default null * @deprecated since version 4.29. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#geodesicDistanceThreshold) */ geodesicDistanceThreshold?: number; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#unit) */ unit?: | "imperial" | "metric" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"; /** * List of available units and unit systems (imperial, metric) for displaying the distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#unitOptions) */ unitOptions?: ( | "imperial" | "metric" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet" )[]; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#view) */ view?: MapViewProperties; } export interface DistanceMeasurement2DViewModelMeasurement { /** * Line length (m). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#measurement) */ length: number; /** * Measurement line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#measurement) */ geometry: any; } export class Editor extends Widget { /** * A property indicating the current active workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#activeWorkflow) */ readonly activeWorkflow: CreateFeaturesWorkflow | UpdateWorkflow; /** * An array of string values which specifies what end users are allowed to edit. * * @deprecated since version 4.29. Use {@link module:esri/widgets/Editor#visibleElements Editor.visibleElements} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#allowedWorkflows) */ allowedWorkflows: "create-features" | "update"; /** * Indicates the heading level to use for title of the widget. * * @default 4 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#headingLevel) */ headingLevel: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Editor#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#iconClass) */ readonly iconClass: string; /** * Options to configure the sketch labels shown next to each segment of the geometry being created or updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#labelOptions) */ labelOptions: SketchLabelOptions; /** * An array of editing configurations for individual layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#layerInfos) */ layerInfos: LayerInfo[]; /** * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) for editing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#snappingOptions) */ snappingOptions: SnappingOptions; /** * This property allows customization of supporting Editor widgets and their default behavior. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#supportingWidgetDefaults) */ supportingWidgetDefaults: SupportingWidgetDefaults; /** * Options to configure the tooltip shown next to the cursor when creating or updating graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#tooltipOptions) */ tooltipOptions: SketchTooltipOptions; /** * Options to configure how values are displayed and input when creating or updating graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#valueOptions) */ valueOptions: SketchValueOptions; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#viewModel) */ viewModel: EditorViewModel; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#visibleElements) */ visibleElements: EditorVisibleElements; /** * This widget provides an out-of-the-box editing experience to help streamline editing within a web application. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html) */ constructor(properties?: EditorProperties); /** * Cancels any active workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#cancelWorkflow) */ cancelWorkflow(): Promise; /** * This is applicable if there is an active [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#deleteFeatureFromWorkflow) */ deleteFeatureFromWorkflow(): Promise; /** * Initiates the [CreateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html) by displaying the panel where feature(s) creation begins. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#startCreateFeaturesWorkflowAtFeatureCreation) */ startCreateFeaturesWorkflowAtFeatureCreation(creationInfo: CreationInfo): Promise; /** * This method starts the [CreateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html) at the "creating-features" step with the provided feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#startCreateFeaturesWorkflowAtFeatureEdit) */ startCreateFeaturesWorkflowAtFeatureEdit(params: EditorStartCreateFeaturesWorkflowAtFeatureEditParams): Promise; /** * Initiates the [CreateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html) by displaying the [FeatureTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html) panel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#startCreateFeaturesWorkflowAtFeatureTypeSelection) */ startCreateFeaturesWorkflowAtFeatureTypeSelection(): Promise; /** * Starts the [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html) at the attribute editing panel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#startUpdateWorkflowAtFeatureEdit) */ startUpdateWorkflowAtFeatureEdit(feature: Graphic): Promise; /** * Starts the [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html) using the current selected feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#startUpdateWorkflowAtFeatureSelection) */ startUpdateWorkflowAtFeatureSelection(): Promise; /** * This method starts the [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html) where it waits for multiple features to be selected. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#startUpdateWorkflowAtMultipleFeatureSelection) */ startUpdateWorkflowAtMultipleFeatureSelection(candidates: Graphic[]): Promise; on(name: "sketch-create", eventHandler: EditorSketchCreateEventHandler): IHandle; on(name: "sketch-update", eventHandler: EditorSketchUpdateEventHandler): IHandle; } interface EditorProperties extends WidgetProperties { /** * An array of string values which specifies what end users are allowed to edit. * * @deprecated since version 4.29. Use {@link module:esri/widgets/Editor#visibleElements Editor.visibleElements} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#allowedWorkflows) */ allowedWorkflows?: "create-features" | "update"; /** * Indicates the heading level to use for title of the widget. * * @default 4 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#headingLevel) */ headingLevel?: number; /** * Options to configure the sketch labels shown next to each segment of the geometry being created or updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#labelOptions) */ labelOptions?: SketchLabelOptionsProperties; /** * An array of editing configurations for individual layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#layerInfos) */ layerInfos?: LayerInfo[]; /** * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) for editing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#snappingOptions) */ snappingOptions?: SnappingOptionsProperties; /** * This property allows customization of supporting Editor widgets and their default behavior. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#supportingWidgetDefaults) */ supportingWidgetDefaults?: SupportingWidgetDefaults; /** * Options to configure the tooltip shown next to the cursor when creating or updating graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#tooltipOptions) */ tooltipOptions?: SketchTooltipOptionsProperties; /** * Options to configure how values are displayed and input when creating or updating graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#valueOptions) */ valueOptions?: SketchValueOptionsProperties; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#viewModel) */ viewModel?: EditorViewModelProperties; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#visibleElements) */ visibleElements?: EditorVisibleElements; } export class CreateFeaturesWorkflow extends Workflow { /** * Indicates the current feature state during creation. * * @default "create-new" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html#createFeatureState) */ readonly createFeatureState: "create-new" | "update-pending"; /** * Returns the number of pending features of an active [CreateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html#numPendingFeatures) */ readonly numPendingFeatures: number; /** * Returns a collection of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) representing features that are currently pending in the [CreateFeaturesWorkflowData](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflowData.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html#pendingFeatures) */ readonly pendingFeatures: Collection; /** * A read-only class containing the logic used when creating features using the [Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html) */ constructor(properties?: CreateFeaturesWorkflowProperties); /** * Moves the pending feature into update mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html#updatePendingFeature) */ updatePendingFeature(feature: Graphic): Promise; } interface CreateFeaturesWorkflowProperties extends WorkflowProperties { } export class CreateFeaturesWorkflowData extends Accessor { /** * This provides the feature template and layer when creating a new feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflowData.html#creationInfo) */ creationInfo: CreationInfo; /** * Returns a collection of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) representing features that have been created during the workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflowData.html#pendingFeatures) */ pendingFeatures: Collection; /** * The associated [EditorViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html) for this workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflowData.html#viewModel) */ viewModel: EditorViewModel; /** * This object supports the [Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflowData.html) */ constructor(properties?: CreateFeaturesWorkflowDataProperties); } interface CreateFeaturesWorkflowDataProperties { /** * This provides the feature template and layer when creating a new feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflowData.html#creationInfo) */ creationInfo?: CreationInfo; /** * Returns a collection of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) representing features that have been created during the workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflowData.html#pendingFeatures) */ pendingFeatures?: CollectionProperties; /** * The associated [EditorViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html) for this workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflowData.html#viewModel) */ viewModel?: EditorViewModelProperties; } export class EditorViewModel extends Accessor { /** * A property indicating the current active workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#activeWorkflow) */ readonly activeWorkflow: CreateFeaturesWorkflow | UpdateWorkflow; /** * An array of string values which specifies what end users are allowed to edit. * * @deprecated since version 4.29. Use {@link module:esri/widgets/Editor#visibleElements Editor.visibleElements} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#allowedWorkflows) */ allowedWorkflows: "create-features" | "update"; /** * The [AttachmentsViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html) for supporting the editor widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#attachmentsViewModel) */ attachmentsViewModel: AttachmentsViewModel; /** * Convenience property that indicates at least one layer supports a `create-features` workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#canCreate) */ readonly canCreate: boolean; /** * Convenience property that indicates at least one layer supports a `update` workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#canUpdate) */ readonly canUpdate: boolean; /** * A read-only collection of editable item objects that match the feature being updated. * * @deprecated true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#editableItems) */ readonly editableItems: Collection; /** * A read-only collection of editable item objects that match the feature being updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#editorItems) */ readonly editorItems: Collection; /** * An array of objects containing information specific to any failed editing operations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#failures) */ readonly failures: EditorViewModelFailures[]; /** * The [FeatureFormViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html) for supporting the editor widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#featureFormViewModel) */ featureFormViewModel: FeatureFormViewModel; /** * The [FeatureTemplatesViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-FeatureTemplatesViewModel.html) for supporting the editor widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#featureTemplatesViewModel) */ featureTemplatesViewModel: FeatureTemplatesViewModel; /** * Options to configure the labels shown next to each segment of the geometry being created or updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#labelOptions) */ labelOptions: SketchLabelOptions; /** * An array of editing configurations for individual layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#layerInfos) */ layerInfos: LayerInfo[]; /** * The [SketchViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html) for supporting the editor widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#sketchViewModel) */ sketchViewModel: SketchViewModel; /** * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) for sketching. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#snappingOptions) */ snappingOptions: SnappingOptions; /** * The widget's state. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#state) */ readonly state: | "adding-attachment" | "awaiting-feature-creation-info" | "awaiting-feature-to-create" | "awaiting-feature-to-update" | "awaiting-update-feature-candidate" | "creating-features" | "disabled" | "editing-attributes" | "editing-attachment" | "editing-existing-feature" | "editing-new-feature" | "awaiting-update-feature-candidate" | "ready"; /** * Indicates if there is at least one edit request being processed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#syncing) */ readonly syncing: boolean; /** * Options to configure the tooltip shown next to the cursor when creating or updating graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#tooltipOptions) */ tooltipOptions: SketchTooltipOptions; /** * Options to configure how values are displayed and input when creating or updating graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#valueOptions) */ valueOptions: SketchValueOptions; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#view) */ view: MapView | SceneView; /** * Provides the logic for the [Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html) */ constructor(properties?: EditorViewModelProperties); /** * Cancels any active workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#cancelWorkflow) */ cancelWorkflow(): Promise; /** * This is applicable if there is an active update workflow with an active child workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#deleteFeatureFromWorkflow) */ deleteFeatureFromWorkflow(): Promise; /** * Initiates the [CreateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html) by displaying the panel where feature creation begins. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#startCreateFeaturesWorkflowAtFeatureCreation) */ startCreateFeaturesWorkflowAtFeatureCreation(creationInfo: CreationInfo): Promise; /** * This method starts the [CreateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html) at the "creating-features" step with the provided feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#startCreateFeaturesWorkflowAtFeatureEdit) */ startCreateFeaturesWorkflowAtFeatureEdit(params: EditorViewModelStartCreateFeaturesWorkflowAtFeatureEditParams): Promise; /** * Initiates the [CreateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html) by displaying the [FeatureTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html) panel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#startCreateFeaturesWorkflowAtFeatureTypeSelection) */ startCreateFeaturesWorkflowAtFeatureTypeSelection(): Promise; /** * Starts the update workflow at the feature geometry and attribute editing panel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#startUpdateWorkflowAtFeatureEdit) */ startUpdateWorkflowAtFeatureEdit(feature: Graphic): Promise; /** * Starts the `update` workflow using the current selected feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#startUpdateWorkflowAtFeatureSelection) */ startUpdateWorkflowAtFeatureSelection(): Promise; /** * Starts the Editor workflow where it waits for multiple features to be selected. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#startUpdateWorkflowAtMultipleFeatureSelection) */ startUpdateWorkflowAtMultipleFeatureSelection(): Promise; /** * Toggles the `UpdateWorkflow`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#toggleUpdateWorkflow) */ toggleUpdateWorkflow(): void; on(name: "sketch-create", eventHandler: EditorViewModelSketchCreateEventHandler): IHandle; on(name: "sketch-update", eventHandler: EditorViewModelSketchUpdateEventHandler): IHandle; } interface EditorViewModelProperties { /** * An array of string values which specifies what end users are allowed to edit. * * @deprecated since version 4.29. Use {@link module:esri/widgets/Editor#visibleElements Editor.visibleElements} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#allowedWorkflows) */ allowedWorkflows?: "create-features" | "update"; /** * The [AttachmentsViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html) for supporting the editor widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#attachmentsViewModel) */ attachmentsViewModel?: AttachmentsViewModelProperties; /** * The [FeatureFormViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html) for supporting the editor widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#featureFormViewModel) */ featureFormViewModel?: FeatureFormViewModelProperties; /** * The [FeatureTemplatesViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-FeatureTemplatesViewModel.html) for supporting the editor widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#featureTemplatesViewModel) */ featureTemplatesViewModel?: FeatureTemplatesViewModelProperties; /** * Options to configure the labels shown next to each segment of the geometry being created or updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#labelOptions) */ labelOptions?: SketchLabelOptionsProperties; /** * An array of editing configurations for individual layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#layerInfos) */ layerInfos?: LayerInfo[]; /** * The [SketchViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html) for supporting the editor widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#sketchViewModel) */ sketchViewModel?: SketchViewModelProperties; /** * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) for sketching. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#snappingOptions) */ snappingOptions?: SnappingOptionsProperties; /** * Options to configure the tooltip shown next to the cursor when creating or updating graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#tooltipOptions) */ tooltipOptions?: SketchTooltipOptionsProperties; /** * Options to configure how values are displayed and input when creating or updating graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#valueOptions) */ valueOptions?: SketchValueOptionsProperties; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } /** * The editable item available within the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#EditableItem) */ export interface EditableItem { /** * The layer associated with the editable item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#EditableItem) */ layer: FeatureLayer | SceneLayer | any; /** * The workflow type that this item supports. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#EditableItem) */ supports: string; /** * Indicates whether this layer has attachments on it. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#EditableItem) */ hasAttachments: boolean; /** * Indicates whether this layer enables or disables geometry updates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#EditableItem) */ geometryUpdatesEnabled: boolean; /** * Indicates whether this layer supports attribute editing while in the `update` workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#EditableItem) */ attributeUpdatesEnabled: boolean; /** * Indicates whether this layer supports the ability to work with attachments while creating features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#EditableItem) */ attachmentsOnCreateEnabled: boolean; /** * Indicates whether this layer supports the ability to work with attachments while updating or deleting features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#EditableItem) */ attachmentsOnUpdateEnabled: boolean; /** * Indicates whether this layer's [formTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html) is invalid. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#EditableItem) */ hasInvalidFormTemplate: boolean; } /** * The editable item available within the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#EditorItem) */ export interface EditorItem { /** * The layer associated with the editable item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#EditorItem) */ layer: FeatureLayer | SceneLayer | any; } export interface EditorViewModelFailures { /** * The read-only error message. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#failures) */ error: Error; } export interface EditorViewModelStartCreateFeaturesWorkflowAtFeatureEditParams { /** * The initial feature used when you begin creating features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#startCreateFeaturesWorkflowAtFeatureEdit) */ initialFeature: Graphic; } export interface EditorViewModelSketchCreateEvent { detail: EditorViewModelSketchCreateEventDetail; layer: FeatureLayer | SceneLayer | SubtypeSublayer; type: "sketch-create"; } export interface EditorViewModelSketchUpdateEvent { detail: EditorViewModelSketchUpdateEventDetail; layer: FeatureLayer | SceneLayer | SubtypeSublayer; toolEventInfo: UpdateToolEventInfo; type: "sketch-update"; } export interface EditorViewModelSketchCreateEventDetail { graphic: Graphic; state: "start" | "active" | "complete" | "cancel"; tool: "point" | "multipoint" | "polyline" | "polygon" | "circle" | "rectangle" | "mesh"; toolEventInfo: CreateToolEventInfo; type: "create"; } export interface EditorViewModelSketchUpdateEventDetail { aborted: boolean; graphics: Graphic[]; state: "start" | "active" | "complete"; tool: "move" | "transform" | "reshape"; type: "update"; } export class Edits extends Accessor { /** * The feature to be edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Edits.html#feature) */ readonly feature: Graphic; /** * When true, the feature has been modified from its original state. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Edits.html#modified) */ readonly modified: boolean; /** * This class supports the [Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Edits.html) */ constructor(properties?: EditsProperties); } interface EditsProperties { } export class UpdateWorkflow extends Workflow { /** * The type of workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html#type) */ readonly type: "update"; /** * A read-only class containing the logic used when updating and/or deleting features using the [Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html) */ constructor(properties?: UpdateWorkflowProperties); } interface UpdateWorkflowProperties extends WorkflowProperties { } export class UpdateWorkflowData extends Accessor { /** * An array of features to be updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflowData.html#candidates) */ candidates: Graphic[]; /** * The associated [EditorViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html) for this workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflowData.html#viewModel) */ viewModel: EditorViewModel; /** * This object supports the [Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflowData.html) */ constructor(properties?: UpdateWorkflowDataProperties); } interface UpdateWorkflowDataProperties { /** * An array of features to be updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflowData.html#candidates) */ candidates?: GraphicProperties[]; /** * The associated [EditorViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html) for this workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflowData.html#viewModel) */ viewModel?: EditorViewModelProperties; } export class Workflow extends Accessor { /** * The shared workflow data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Workflow.html#data) */ readonly data: CreateFeaturesWorkflowData | UpdateWorkflowData; /** * This property indicates whether there is a next step in the workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Workflow.html#hasNextStep) */ readonly hasNextStep: boolean; /** * This property indicates if there is a previous step in the workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Workflow.html#hasPreviousStep) */ readonly hasPreviousStep: boolean; /** * Indicates whether the workflow is considered active. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Workflow.html#started) */ readonly started: boolean; /** * The name of the current step in the workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Workflow.html#stepId) */ readonly stepId: string; /** * Value indicating the workflow type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Workflow.html#type) */ readonly type: "create" | "create-features" | "update"; /** * The read-only `Workflow` class helps manage different stages of an [editing](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html) workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Workflow.html) */ constructor(properties?: WorkflowProperties); /** * Cancels the active workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Workflow.html#cancel) */ cancel(options?: WorkflowCancelOptions): Promise; /** * Call this method when the workflow is considered finished. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Workflow.html#commit) */ commit(): Promise; /** * Moves to the next step in the workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Workflow.html#next) */ next(): Promise; /** * Moves to the previous step in the workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Workflow.html#previous) */ previous(options?: WorkflowPreviousOptions): Promise; /** * Resets the workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Workflow.html#reset) */ reset(): Promise; /** * Starts the workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Workflow.html#start) */ start(): Promise; } interface WorkflowProperties { } export interface WorkflowCancelOptions { /** * The returned Error object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Workflow.html#cancel) */ error?: Error; /** * Indicates whether to force cancel the active workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Workflow.html#cancel) */ force?: boolean; /** * Indicates whether to display a prompt indicating canceling the active workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Workflow.html#cancel) */ notify?: boolean; } export interface WorkflowPreviousOptions { /** * Cancels the current workflow when calling this method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Workflow.html#previous) */ cancelCurrentStep: boolean; } /** * This object provides required and optional properties needed when creating a new feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#CreationInfo) */ export interface CreationInfo { /** * The associated layer for newly-created feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#CreationInfo) */ layer: FeatureLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer; /** * The associated feature template used to create new features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#CreationInfo) */ template: FeatureTemplate; /** * The associated [Mesh](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html) geometry for the newly-created feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#CreationInfo) */ geometryToPlace?: Mesh; /** * The maximum amount of feature to create in one batch editing operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#CreationInfo) */ maxFeatures?: number; /** * The initial feature used when you begin creating features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#CreationInfo) */ initialFeature?: Graphic; } export interface EditorStartCreateFeaturesWorkflowAtFeatureEditParams { /** * The initial feature used when you begin creating features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#startCreateFeaturesWorkflowAtFeatureEdit) */ initialFeature: Graphic; } /** * Configurations used for setting the layer's editable preferences within the Editor. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#LayerInfo) */ export interface LayerInfo { /** * The associated layer containing the fields to edit. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#LayerInfo) */ layer: FeatureLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer | SubtypeGroupLayer; /** * Indicates whether to enable editing on the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#LayerInfo) */ enabled?: boolean; /** * Indicates whether to enable the ability to create new features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#LayerInfo) */ addEnabled?: boolean; /** * Indicates whether to enable the ability to update existing features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#LayerInfo) */ updateEnabled?: boolean; /** * Indicates whether to enable the ability to delete features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#LayerInfo) */ deleteEnabled?: boolean; /** * Indicates whether to enable or disable attribute updates from the feature's form. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#LayerInfo) */ attributeUpdatesEnabled?: boolean; /** * Indicates whether to display the attachments widget in the Editor's UI. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#LayerInfo) */ allowAttachments?: boolean; /** * _(Since 4.26)_ Indicates whether to enable or disable attachments while creating features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#LayerInfo) */ attachmentsOnCreateEnabled?: boolean; /** * _(Since 4.26)_ Indicates whether to enable or disable attachments while updating existing features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#LayerInfo) */ attachmentsOnUpdateEnabled?: boolean; /** * Indicates whether to enable or disable geometry updates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#LayerInfo) */ geometryUpdatesEnabled?: boolean; /** * A template that defines the feature's form content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#LayerInfo) */ formTemplate?: FormTemplate; } export interface EditorSketchCreateEvent { detail: EditorSketchCreateEventDetail; layer: FeatureLayer | SceneLayer | SubtypeSublayer; type: "sketch-create"; } export interface EditorSketchUpdateEvent { detail: EditorSketchUpdateEventDetail; layer: FeatureLayer | SceneLayer | SubtypeSublayer; toolEventInfo: UpdateToolEventInfo; type: "sketch-update"; } /** * Set this to customize any supporting Editor widget's default behavior. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#SupportingWidgetDefaults) */ export interface SupportingWidgetDefaults { /** * An object containing properties specific for customizing the [Attachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#SupportingWidgetDefaults) */ attachments?: SupportingWidgetDefaultsAttachments; /** * An object containing properties specific for customizing the [FeatureForm](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#SupportingWidgetDefaults) */ featureForm?: SupportingWidgetDefaultsFeatureForm; /** * An object containing properties specific for customizing the [FeatureTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#SupportingWidgetDefaults) */ featureTemplates?: SupportingWidgetDefaultsFeatureTemplates; /** * An object containing properties specific for customizing the [Sketch](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#SupportingWidgetDefaults) */ sketch?: SupportingWidgetDefaultsSketch; } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#VisibleElements) */ export interface EditorVisibleElements { /** * _Since 4.28_. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#VisibleElements) */ createFeaturesSection?: boolean; /** * _Since 4.28_. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#VisibleElements) */ editFeaturesSection?: boolean; /** * _Since 4.29_. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#VisibleElements) */ labelsToggle?: boolean; /** * _Since 4.29_. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#VisibleElements) */ tooltipsToggle?: boolean; /** * Indicates whether to display the `SnappingControls` widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#VisibleElements) */ snappingControls?: boolean; /** * The available [SnappingControls](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html) elements within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#VisibleElements) */ snappingControlsElements?: VisibleElementsSnappingControlsElements; } export interface EditorSketchCreateEventDetail { graphic: Graphic; state: "start" | "active" | "complete" | "cancel"; tool: "point" | "multipoint" | "polyline" | "polygon" | "circle" | "rectangle" | "mesh"; toolEventInfo: CreateToolEventInfo; type: "create"; } export interface EditorSketchUpdateEventDetail { aborted: boolean; graphics: Graphic[]; state: "start" | "active" | "complete"; tool: "move" | "transform" | "reshape"; type: "update"; } export interface SupportingWidgetDefaultsAttachments { /** * String indicating how to [display](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#displayType) the attachments. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#SupportingWidgetDefaults) */ displayType?: string; /** * The capabilities needed for the attachments widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#SupportingWidgetDefaults) */ capabilities?: AttachmentsCapabilities; } export interface SupportingWidgetDefaultsFeatureForm { /** * String indicating the [groupDisplay](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#groupDisplay) and how they will be displayed to the end user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#SupportingWidgetDefaults) */ groupDisplay?: string; } export interface SupportingWidgetDefaultsFeatureTemplates { /** * Aids in managing various template items and how they display within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#SupportingWidgetDefaults) */ groupBy?: string | GroupByFunction; visibleElements: SupportingWidgetDefaultsFeatureTemplatesVisibleElements; /** * (Since 4.28) Indicates whether the list of [feature template items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html) should scroll within the containing element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#SupportingWidgetDefaults) */ enableListScroll?: boolean; } export interface SupportingWidgetDefaultsFeatureTemplatesVisibleElements { /** * Indicates whether the [templates filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#visibleElements) displays. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#SupportingWidgetDefaults) */ filter?: boolean; } export interface SupportingWidgetDefaultsSketch { /** * An object containing the `defaultUpdateOptions` for the [Sketch](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#SupportingWidgetDefaults) */ defaultUpdateOptions?: any; /** * The marker symbol used to symbolize any point feature updates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#SupportingWidgetDefaults) */ markerSymbol?: SimpleMarkerSymbol; /** * The polygon symbol used to symbolize any polygon feature updates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#SupportingWidgetDefaults) */ polygonSymbol?: SimpleFillSymbol; /** * The line symbol used to symbolize any line feature updates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#SupportingWidgetDefaults) */ polylineSymbol?: SimpleLineSymbol; } export interface VisibleElementsSnappingControlsElements { /** * Indicates whether to display the header. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#VisibleElements) */ header?: boolean; /** * Indicates whether to display the `enabledToggle` (Enable snapping). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#VisibleElements) */ enabledToggle?: boolean; /** * Indicates whether to display the `selfEnabledToggle` (Geometry guides). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#VisibleElements) */ selfEnabledToggle?: boolean; /** * Indicates whether to display the `featureEnabledToggle` (Feature to feature). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#VisibleElements) */ featureEnabledToggle?: boolean; /** * Indicates whether to display the [FeatureSnappingLayerSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-FeatureSnappingLayerSource.html) layerList. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#VisibleElements) */ layerList?: boolean; } export class ElevationProfile extends Widget { /** * Threshold (in meters) which determines the method for computing and displaying distances in non-Web Mercator projected coordinate systems (PCS). * * @default null * @deprecated since version 4.29. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#geodesicDistanceThreshold) */ geodesicDistanceThreshold: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/ElevationProfile#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#iconClass) */ iconClass: string; /** * The input line graphic along which elevation will be queried in order to generate an elevation profile. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input) */ input: Graphic; /** * Collection of elevation profile lines which are to be generated and displayed in the widget's chart. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#profiles) */ profiles: Collection< ElevationProfileLineGround | ElevationProfileLineInput | ElevationProfileLineQuery | ElevationProfileLineView >; /** * Unit system (imperial, metric) or specific unit used for displaying the elevation and distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#unit) */ unit: SystemOrLengthUnit; /** * List of available units and unit systems (imperial, metric) for displaying the elevation and distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#unitOptions) */ unitOptions: SystemOrLengthUnit[]; /** * A reference to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) or the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#view) */ view: SceneView | MapView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#viewModel) */ viewModel: ElevationProfileViewModel; /** * This property provides the ability to display or hide the individual elements of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#visibleElements) */ visibleElements: ElevationProfileVisibleElements; /** * The ElevationProfile widget 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). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html) */ constructor(properties?: ElevationProfileProperties); } interface ElevationProfileProperties extends WidgetProperties { /** * Threshold (in meters) which determines the method for computing and displaying distances in non-Web Mercator projected coordinate systems (PCS). * * @default null * @deprecated since version 4.29. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#geodesicDistanceThreshold) */ geodesicDistanceThreshold?: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/ElevationProfile#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#iconClass) */ iconClass?: string; /** * The input line graphic along which elevation will be queried in order to generate an elevation profile. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input) */ input?: GraphicProperties; /** * Collection of elevation profile lines which are to be generated and displayed in the widget's chart. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#profiles) */ profiles?: CollectionProperties< | (ElevationProfileLineGroundProperties & { type: "ground" }) | (ElevationProfileLineInputProperties & { type: "input" }) | (ElevationProfileLineQueryProperties & { type: "query" }) | (ElevationProfileLineViewProperties & { type: "view" }) >; /** * Unit system (imperial, metric) or specific unit used for displaying the elevation and distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#unit) */ unit?: | "imperial" | "metric" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"; /** * List of available units and unit systems (imperial, metric) for displaying the elevation and distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#unitOptions) */ unitOptions?: ( | "imperial" | "metric" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet" )[]; /** * A reference to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) or the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#view) */ view?: (SceneViewProperties & { type: "3d" }) | (MapViewProperties & { type: "2d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#viewModel) */ viewModel?: ElevationProfileViewModelProperties; /** * This property provides the ability to display or hide the individual elements of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#visibleElements) */ visibleElements?: ElevationProfileVisibleElements; } export class ElevationProfileLine extends Accessor { /** * Color of the line on the chart and the hovered points in the view. * * @default #000000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#color) */ color: Color; /** * Point being hovered in the chart, in the view's spatial reference. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#hoveredPoint) */ readonly hoveredPoint: Point; /** * Unique identifier for the profile line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#id) */ id: string; /** * How far along the generation of this profile is. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#progress) */ readonly progress: number; /** * List of samples that make up the elevation profile. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#samples) */ readonly samples: ElevationProfileSample[]; /** * Statistics about the generated elevation profile, if available. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#statistics) */ readonly statistics: ElevationProfileStatistics; /** * Title of the line, to be displayed in the chart tooltip and in the chart legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#title) */ title: string; /** * The line type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#type) */ readonly type: "ground" | "input" | "query" | "view"; /** * Whether a line visualization representing [elevationSamples](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#samples) should be added to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#viewVisualizationEnabled) */ viewVisualizationEnabled: boolean; /** * Whether the line should be computed and shown in the chart. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#visible) */ visible: boolean; /** * Common interface for all the elevation profile lines. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html) */ constructor(properties?: ElevationProfileLineProperties); } interface ElevationProfileLineProperties { /** * Color of the line on the chart and the hovered points in the view. * * @default #000000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#color) */ color?: Color | number[] | string; /** * Unique identifier for the profile line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#id) */ id?: string; /** * Title of the line, to be displayed in the chart tooltip and in the chart legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#title) */ title?: string; /** * Whether a line visualization representing [elevationSamples](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#samples) should be added to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#viewVisualizationEnabled) */ viewVisualizationEnabled?: boolean; /** * Whether the line should be computed and shown in the chart. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#visible) */ visible?: boolean; } /** * Represents an elevation sample in the profile. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#ElevationProfileSample) */ export interface ElevationProfileSample { /** * The x coordinate of the sample, in the spatial reference of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#ElevationProfileSample) */ x: number; /** * The y coordinate of the sample, in the spatial reference of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#ElevationProfileSample) */ y: number; /** * The z coordinate of the sample, in the spatial reference of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#ElevationProfileSample) */ z?: number; /** * Distance from the beginning of the path, in the effective selected by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#ElevationProfileSample) */ distance: number; /** * The elevation of the sample, in the effective units selected by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#ElevationProfileSample) */ elevation?: number; } /** * Represents the statistics for the generated profile line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#ElevationProfileStatistics) */ export interface ElevationProfileStatistics { /** * The maximum distance or length of the path. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#ElevationProfileStatistics) */ maxDistance: number; /** * The minimum elevation along the path. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#ElevationProfileStatistics) */ minElevation: number; /** * The maximum elevation along the path. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#ElevationProfileStatistics) */ maxElevation: number; /** * The average elevation along the path. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#ElevationProfileStatistics) */ avgElevation: number; /** * The cumulative elevation gain along the path. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#ElevationProfileStatistics) */ elevationGain: number; /** * The cumulative elevation loss along the path. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#ElevationProfileStatistics) */ elevationLoss: number; /** * The maximum slope along the path. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#ElevationProfileStatistics) */ maxSlope: number; /** * The average slope along the path. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLine.html#ElevationProfileStatistics) */ avgSlope: number; } export class ElevationProfileLineGround extends ElevationProfileLine { /** * The line type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLineGround.html#type) */ readonly type: "ground"; /** * Profile line which samples elevation from the [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html) of the [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) currently set in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLineGround.html) */ constructor(properties?: ElevationProfileLineGroundProperties); } interface ElevationProfileLineGroundProperties extends ElevationProfileLineProperties { } export class ElevationProfileLineInput extends ElevationProfileLine { /** * The line type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLineInput.html#type) */ readonly type: "input"; /** * Profile line which samples elevation from the geometry of the input [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) itself, typically used on input lines with z values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLineInput.html) */ constructor(properties?: ElevationProfileLineInputProperties); } interface ElevationProfileLineInputProperties extends ElevationProfileLineProperties { } export class ElevationProfileLineQuery extends ElevationProfileLine { /** * Elevation source used to sample elevation when generating the profile, for example an [ElevationLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLineQuery.html#source) */ source: ElevationProfileLineQuerySource; /** * The line type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLineQuery.html#type) */ readonly type: "query"; /** * Profile line which samples elevation from a custom elevation source, for example by creating a new [ElevationLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html), or by using an elevation layer from [ground.layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#layers). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLineQuery.html) */ constructor(properties?: ElevationProfileLineQueryProperties); } interface ElevationProfileLineQueryProperties extends ElevationProfileLineProperties { /** * Elevation source used to sample elevation when generating the profile, for example an [ElevationLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLineQuery.html#source) */ source?: ElevationProfileLineQuerySource; } export interface ElevationProfileLineQuerySource { /** * Function used to query elevation values for a geometry ([Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html), [Multipoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html) or [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html)). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLineQuery.html#source) */ queryElevation: QueryElevation; } export type QueryElevation = ( geometry: Point | Multipoint | Polyline, options?: any, ) => Promise; export class ElevationProfileLineView extends ElevationProfileLine { /** * Items which are to be excluded when querying elevation from view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLineView.html#exclude) */ exclude: | (IntersectItem | Collection | IntersectItem[] | Ground)[] | Collection | IntersectItem; /** * Items which are to be hit when querying elevation from view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLineView.html#include) */ include: | (IntersectItem | Collection | IntersectItem[] | Ground)[] | Collection | IntersectItem; /** * The line type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLineView.html#type) */ readonly type: "view"; /** * Profile line which samples elevation directly from the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLineView.html) */ constructor(properties?: ElevationProfileLineViewProperties); } interface ElevationProfileLineViewProperties extends ElevationProfileLineProperties { /** * Items which are to be excluded when querying elevation from view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLineView.html#exclude) */ exclude?: | ( | GraphicProperties | LayerProperties | BuildingSublayerProperties | CollectionProperties | (GraphicProperties | LayerProperties | BuildingSublayerProperties)[] | GroundProperties )[] | CollectionProperties | GraphicProperties | LayerProperties | BuildingSublayerProperties; /** * Items which are to be hit when querying elevation from view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLineView.html#include) */ include?: | ( | GraphicProperties | LayerProperties | BuildingSublayerProperties | CollectionProperties | (GraphicProperties | LayerProperties | BuildingSublayerProperties)[] | GroundProperties )[] | CollectionProperties | GraphicProperties | LayerProperties | BuildingSublayerProperties; } export class ElevationProfileViewModel extends Accessor { /** * Units which have been selected according to the magnitude of the elevations and distances that are to be displayed in the widget, according to the selected unit or unit system. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#effectiveUnits) */ readonly effectiveUnits: EffectiveUnits; /** * Threshold (in meters) which determines the method for computing and displaying distances in non-Web Mercator projected coordinate systems (PCS). * * @default null * @deprecated since version 4.29. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#geodesicDistanceThreshold) */ geodesicDistanceThreshold: number; /** * Whether the graphic used as [input](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input) is highlighted. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#highlightEnabled) */ highlightEnabled: boolean; /** * The position, in the range [0, 1], being hovered in the graph. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#hoveredChartPosition) */ hoveredChartPosition: number; /** * The input path along which elevation will be queried in order to generate an elevation profile. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#input) */ input: Graphic; /** * Collection of elevation profile lines which are to be generated and displayed in the widget's chart. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#profiles) */ profiles: Collection< ElevationProfileLineGround | ElevationProfileLineInput | ElevationProfileLineQuery | ElevationProfileLineView >; /** * The progress, between 0 and 1 of generating all the configured elevation profiles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#progress) */ readonly progress: number; /** * The current state of the view model that can be used for rendering the UI of the widget. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#state) */ readonly state: "disabled" | "ready" | "creating" | "created" | "selecting" | "selected"; /** * Whether the chart should use a uniform scale for the X and Y axes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#uniformChartScaling) */ uniformChartScaling: boolean; /** * Unit system (imperial, metric) or specific unit used for displaying the elevation and distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#unit) */ unit: SystemOrLengthUnit; /** * List of available units and unit systems (imperial, metric) for displaying the elevation and distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#unitOptions) */ unitOptions: SystemOrLengthUnit[]; /** * A reference to the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#view) */ view: SceneView | MapView; /** * Provides the logic for the [ElevationProfile](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html) */ constructor(properties?: ElevationProfileViewModelProperties); /** * Stops a creation/selection operation and restores the previously configured input path. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#cancel) */ cancel(): void; /** * Clears the existing profile and stops any interaction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#clear) */ clear(): void; /** * If mode is "sketch" (the default), switches to the "creating" state in which the user can draw a new line. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#start) */ start(options?: ElevationProfileViewModelStartOptions): void; /** * Stops a creation/selection operation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#stop) */ stop(): void; } interface ElevationProfileViewModelProperties { /** * Threshold (in meters) which determines the method for computing and displaying distances in non-Web Mercator projected coordinate systems (PCS). * * @default null * @deprecated since version 4.29. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#geodesicDistanceThreshold) */ geodesicDistanceThreshold?: number; /** * Whether the graphic used as [input](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input) is highlighted. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#highlightEnabled) */ highlightEnabled?: boolean; /** * The position, in the range [0, 1], being hovered in the graph. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#hoveredChartPosition) */ hoveredChartPosition?: number; /** * The input path along which elevation will be queried in order to generate an elevation profile. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#input) */ input?: GraphicProperties; /** * Collection of elevation profile lines which are to be generated and displayed in the widget's chart. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#profiles) */ profiles?: CollectionProperties< | (ElevationProfileLineGroundProperties & { type: "ground" }) | (ElevationProfileLineInputProperties & { type: "input" }) | (ElevationProfileLineQueryProperties & { type: "query" }) | (ElevationProfileLineViewProperties & { type: "view" }) >; /** * Whether the chart should use a uniform scale for the X and Y axes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#uniformChartScaling) */ uniformChartScaling?: boolean; /** * Unit system (imperial, metric) or specific unit used for displaying the elevation and distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#unit) */ unit?: | "imperial" | "metric" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"; /** * List of available units and unit systems (imperial, metric) for displaying the elevation and distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#unitOptions) */ unitOptions?: ( | "imperial" | "metric" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet" )[]; /** * A reference to the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#view) */ view?: (SceneViewProperties & { type: "3d" }) | (MapViewProperties & { type: "2d" }); } /** * The units which have been selected according to the magnitude of the elevations and distances that are to be displayed in the widget, according to the selected unit or unit system. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#EffectiveUnits) */ export interface EffectiveUnits { /** * Units used for displaying distance or length values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#EffectiveUnits) */ distance: LengthUnit; /** * Units used for displaying elevation values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#EffectiveUnits) */ elevation: LengthUnit; } export interface ElevationProfileViewModelStartOptions { /** * The mode that the widget will start with. * * @default "sketch" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#start) */ mode?: "sketch" | "select"; } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#VisibleElements) */ export interface ElevationProfileVisibleElements { /** * When set to `false`, the legend (which includes statistics) is not displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#VisibleElements) */ legend?: boolean; /** * When set to `false`, the chart is not displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#VisibleElements) */ chart?: boolean; /** * When set to `false` the button used to clear the current elevation profile is not displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#VisibleElements) */ clearButton?: boolean; /** * When set to `false`, the button used to open the settings popup is not displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#VisibleElements) */ settingsButton?: boolean; /** * When set to `false`, the button used to start drawing/sketching is not displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#VisibleElements) */ sketchButton?: boolean; /** * When set to `false`, the button used to select a path is not displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#VisibleElements) */ selectButton?: boolean; /** * When set to `false`, the dropdown used to select the units is not displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#VisibleElements) */ unitSelector?: boolean; /** * When set to `false`, the element used to toggle uniform chart scaling on or off is not displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#VisibleElements) */ uniformChartScalingToggle?: boolean; } export class Expand extends Widget { /** * Automatically collapses the expand widget instance when the view's viewpoint updates. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#autoCollapse) */ autoCollapse: boolean; /** * When true, the Expand widget will close after the Escape key is pressed when the keyboard focus is within its content. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#closeOnEsc) */ closeOnEsc: boolean | Function; /** * Calcite icon used to style the Expand button when the [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#content) can be collapsed. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#collapseIcon) */ collapseIcon: string; /** * Icon font used to style the Expand button. * * @deprecated since 4.27. Use {@link module:esri/widgets/Expand#collapseIcon collapseIcon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#collapseIconClass) */ collapseIconClass: string; /** * Tooltip to display to indicate Expand widget can be collapsed. * * @default "Collapse" (English locale) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#collapseTooltip) */ collapseTooltip: string; /** * The content to display within the expanded Expand widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#content) */ content: Node | string | Widget; /** * Indicates whether the widget is currently expanded or not. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expanded) */ expanded: boolean; /** * Calcite icon used when the widget is collapsed. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expandIcon) */ expandIcon: string; /** * Icon font used to style the Expand button. * * @deprecated since 4.27. Use {@link module:esri/widgets/Expand#expandIcon expandIcon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expandIconClass) */ expandIconClass: string; /** * Tooltip to display to indicate Expand widget can be expanded. * * @default "Expand" (English locale) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expandTooltip) */ expandTooltip: string; /** * This value associates two or more Expand widget instances with each other, allowing one instance to auto collapse when another instance in the same group is expanded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#group) */ group: string; /** * A number to display at the corner of the widget to indicate the number of, for example, open issues or unread notices. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#iconNumber) */ iconNumber: number; /** * The mode in which the widget displays. * * @default "auto" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#mode) */ mode: "auto" | "floating" | "drawer"; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#viewModel) */ viewModel: ExpandViewModel; /** * The Expand widget acts as a clickable button for opening a widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html) */ constructor(properties?: ExpandProperties); /** * Collapse the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#collapse) */ collapse(): void; /** * Expand the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expand) */ expand(): void; /** * Toggle the widget by expanding it if it's collapsed, or collapsing it if it's expanded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#toggle) */ toggle(): void; } interface ExpandProperties extends WidgetProperties { /** * Automatically collapses the expand widget instance when the view's viewpoint updates. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#autoCollapse) */ autoCollapse?: boolean; /** * When true, the Expand widget will close after the Escape key is pressed when the keyboard focus is within its content. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#closeOnEsc) */ closeOnEsc?: boolean | Function; /** * Calcite icon used to style the Expand button when the [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#content) can be collapsed. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#collapseIcon) */ collapseIcon?: string; /** * Icon font used to style the Expand button. * * @deprecated since 4.27. Use {@link module:esri/widgets/Expand#collapseIcon collapseIcon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#collapseIconClass) */ collapseIconClass?: string; /** * Tooltip to display to indicate Expand widget can be collapsed. * * @default "Collapse" (English locale) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#collapseTooltip) */ collapseTooltip?: string; /** * The content to display within the expanded Expand widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#content) */ content?: Node | string | WidgetProperties; /** * Indicates whether the widget is currently expanded or not. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expanded) */ expanded?: boolean; /** * Calcite icon used when the widget is collapsed. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expandIcon) */ expandIcon?: string; /** * Icon font used to style the Expand button. * * @deprecated since 4.27. Use {@link module:esri/widgets/Expand#expandIcon expandIcon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expandIconClass) */ expandIconClass?: string; /** * Tooltip to display to indicate Expand widget can be expanded. * * @default "Expand" (English locale) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expandTooltip) */ expandTooltip?: string; /** * This value associates two or more Expand widget instances with each other, allowing one instance to auto collapse when another instance in the same group is expanded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#group) */ group?: string; /** * A number to display at the corner of the widget to indicate the number of, for example, open issues or unread notices. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#iconNumber) */ iconNumber?: number; /** * The mode in which the widget displays. * * @default "auto" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#mode) */ mode?: "auto" | "floating" | "drawer"; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#viewModel) */ viewModel?: ExpandViewModelProperties; } export class ExpandViewModel extends Accessor { /** * Automatically collapses the expand widget instance when the view's viewpoint updates. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand-ExpandViewModel.html#autoCollapse) */ autoCollapse: boolean; /** * Whether the widget is currently expanded or not. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand-ExpandViewModel.html#expanded) */ expanded: boolean; /** * This value associates two or more Expand widget instances with each other, allowing one instance to auto collapse when another instance in the same group is expanded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand-ExpandViewModel.html#group) */ group: string; /** * The view model's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand-ExpandViewModel.html#state) */ readonly state: "ready" | "disabled"; /** * The view in which the Expand is used. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand-ExpandViewModel.html#view) */ view: MapView | SceneView; /** * Provides the logic for the [Expand](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand-ExpandViewModel.html) */ constructor(properties?: ExpandViewModelProperties); } interface ExpandViewModelProperties { /** * Automatically collapses the expand widget instance when the view's viewpoint updates. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand-ExpandViewModel.html#autoCollapse) */ autoCollapse?: boolean; /** * Whether the widget is currently expanded or not. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand-ExpandViewModel.html#expanded) */ expanded?: boolean; /** * This value associates two or more Expand widget instances with each other, allowing one instance to auto collapse when another instance in the same group is expanded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand-ExpandViewModel.html#group) */ group?: string; /** * The view in which the Expand is used. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand-ExpandViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } export class Feature extends Widget { /** * Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#defaultPopupTemplateEnabled) */ defaultPopupTemplateEnabled: boolean; /** * The [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#graphic) */ graphic: Graphic; /** * Indicates the heading level to use for the [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#title) of the feature widget. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#headingLevel) */ headingLevel: number; /** * A map is required when the input [graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#graphic) has a popupTemplate that contains [Arcade](https://developers.arcgis.com/arcade) expressions in [ExpressionInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ExpressionInfo.html) or [ExpressionContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html) that may use the `$map` profile variable to access data from layers within a map. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#map) */ map: Map; /** * The spatial reference used for [Arcade](https://developers.arcgis.com/arcade) operations. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#spatialReference) */ spatialReference: SpatialReference; /** * Dates and times displayed in the widget will be displayed in this time zone. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#timeZone) */ timeZone: string; /** * The title for the feature. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#title) */ readonly title: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#viewModel) */ viewModel: FeatureViewModel; /** * The visible elements that are displayed within the widget's [graphic.popupTemplate.content](esri-PopupTemplate.html#content). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#visibleElements) */ visibleElements: FeatureVisibleElements; /** * The Feature widget displays a graphic according to its [PopupTemplate](esri-PopupTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html) */ constructor(properties?: FeatureProperties); /** * Paginates to the next [media](esri-popup-content-MediaContent.html) info. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#nextMedia) */ nextMedia(contentElementIndex: number): void; /** * Paginates to the previous [media](esri-popup-content-MediaContent.html) info in the specified [media](esri-popup-content-MediaContent.html) content element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#previousMedia) */ previousMedia(contentElementIndex: number): void; /** * Paginates to a specified [media](esri-popup-content-MediaContent.html) info object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#setActiveMedia) */ setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): void; } interface FeatureProperties extends WidgetProperties { /** * Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#defaultPopupTemplateEnabled) */ defaultPopupTemplateEnabled?: boolean; /** * The [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#graphic) */ graphic?: GraphicProperties; /** * Indicates the heading level to use for the [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#title) of the feature widget. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#headingLevel) */ headingLevel?: number; /** * A map is required when the input [graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#graphic) has a popupTemplate that contains [Arcade](https://developers.arcgis.com/arcade) expressions in [ExpressionInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ExpressionInfo.html) or [ExpressionContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html) that may use the `$map` profile variable to access data from layers within a map. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#map) */ map?: MapProperties; /** * The spatial reference used for [Arcade](https://developers.arcgis.com/arcade) operations. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * Dates and times displayed in the widget will be displayed in this time zone. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#timeZone) */ timeZone?: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#viewModel) */ viewModel?: FeatureViewModelProperties; /** * The visible elements that are displayed within the widget's [graphic.popupTemplate.content](esri-PopupTemplate.html#content). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#visibleElements) */ visibleElements?: FeatureVisibleElements; } export class FeatureViewModel extends Accessor { /** * Defines the specific [abilities](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#Abilities) that the [Feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html) and [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) widgets should use when querying and displaying its content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#abilities) */ abilities: Abilities; /** * The [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#content) of the feature. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#content) */ readonly content: Content[] | Widget | HTMLElement | string; /** * Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#defaultPopupTemplateEnabled) */ defaultPopupTemplateEnabled: boolean; /** * The formatted attributes calculated from `fieldInfo` [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) content. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#formattedAttributes) */ readonly formattedAttributes: FeatureViewModelFormattedAttributes; /** * The [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#graphic) */ graphic: Graphic; /** * A read-only property containing metadata regarding the last edit performed on a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#lastEditInfo) */ readonly lastEditInfo: FeatureViewModelLastEditInfo; /** * The [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing the location of the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) interaction used to trigger the opening of the widget. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#location) */ location: Point; /** * A map is required when the input [graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#graphic) has a popupTemplate that contains [Arcade](https://developers.arcgis.com/arcade) expressions in [ExpressionInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ExpressionInfo.html) or [ExpressionContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html) that may use the `$map` profile variable to access data from layers within a map. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#map) */ map: Map; /** * The spatial reference used for [Arcade](https://developers.arcgis.com/arcade) operations. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#spatialReference) */ spatialReference: SpatialReference; /** * The view model's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#state) */ readonly state: "ready" | "disabled" | "error" | "loading"; /** * Dates and times displayed in the widget will be displayed in this time zone. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#timeZone) */ timeZone: string; /** * The title for the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#title) */ readonly title: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#view) */ view: MapView | SceneView; /** * Indicates whether the feature is currently waiting for all of its content to finish loading. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#waitingForContent) */ readonly waitingForContent: boolean; /** * Provides the logic for the [Feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html) */ constructor(properties?: FeatureViewModelProperties); /** * Paginates to the next [media](esri-popup-content-MediaContent.html) info. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#nextMedia) */ nextMedia(contentElementIndex: number): void; /** * Paginates to the previous [media](esri-popup-content-MediaContent.html) info in the specified [media](esri-popup-content-MediaContent.html) content element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#previousMedia) */ previousMedia(contentElementIndex: number): void; /** * Paginates to a specified [media](esri-popup-content-MediaContent.html) info object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#setActiveMedia) */ setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): void; } interface FeatureViewModelProperties { /** * Defines the specific [abilities](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#Abilities) that the [Feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html) and [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) widgets should use when querying and displaying its content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#abilities) */ abilities?: Abilities; /** * Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#defaultPopupTemplateEnabled) */ defaultPopupTemplateEnabled?: boolean; /** * The [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#graphic) */ graphic?: GraphicProperties; /** * The [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing the location of the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) interaction used to trigger the opening of the widget. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#location) */ location?: PointProperties; /** * A map is required when the input [graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#graphic) has a popupTemplate that contains [Arcade](https://developers.arcgis.com/arcade) expressions in [ExpressionInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ExpressionInfo.html) or [ExpressionContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html) that may use the `$map` profile variable to access data from layers within a map. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#map) */ map?: MapProperties; /** * The spatial reference used for [Arcade](https://developers.arcgis.com/arcade) operations. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * Dates and times displayed in the widget will be displayed in this time zone. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#timeZone) */ timeZone?: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } /** * This object defines specific abilities for the [Feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html) and [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) widgets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#Abilities) */ export interface Abilities { /** * Indicate whether the widget should query and display [attachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-AttachmentsContent.html) associated with the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#Abilities) */ attachmentsContent?: boolean; /** * Indicate whether the widget should display animations for charts residing in [media content elements](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#Abilities) */ chartAnimation?: boolean; /** * Indicate whether the widget should display any [custom content elements](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-CustomContent.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#Abilities) */ customContent?: boolean; /** * Indicate whether the widget should display any [fields content elements](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-FieldsContent.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#Abilities) */ fieldsContent?: boolean; /** * Indicate whether the widget should display any [media content elements](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#Abilities) */ mediaContent?: boolean; /** * Indicate whether the widget should display any [text content elements](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-TextContent.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#Abilities) */ textContent?: boolean; } export interface FeatureViewModelFormattedAttributes { /** * The formatted attributes specified at the root level of the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) using the [PopupTemplate.fieldInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#fieldInfos) property. * * [Read more...](global.html) */ global?: any; /** * The formatted attributes for an individual content element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#formattedAttributes) */ content?: any; } export interface FeatureViewModelLastEditInfo { /** * User who performed the last edit on a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#lastEditInfo) */ user: string; /** * Date that the edit was performed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#lastEditInfo) */ date: string; /** * The type of edit that was performed on the feature. * * [Read more...](global.html#type) */ type: "edit" | "create"; } export interface VisibleContentElements { /** * Indicates whether to display any [AttachmentsContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-AttachmentsContent.html) elements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#VisibleContentElements) */ attachments?: boolean; /** * Indicates whether to display any [FieldsContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-FieldsContent.html) elements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#VisibleContentElements) */ fields?: boolean; /** * Indicates whether to display any [MediaContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) elements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#VisibleContentElements) */ media?: boolean; /** * Indicates whether to display any [TextContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-TextContent.html) elements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#VisibleContentElements) */ text?: boolean; /** * Indicates whether to display any [ExpressionContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html) elements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#VisibleContentElements) */ expression?: boolean; } export interface FeatureVisibleElements { /** * Indicates whether the title associated with the feature displays. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#VisibleElements) */ title?: boolean; /** * Indicates whether content for the Feature displays, can also indicate the specific types of content elements by setting it via [VisibleContentElements](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#VisibleContentElements). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#VisibleElements) */ content?: boolean | VisibleContentElements; /** * Indicates whether [lastEditInfo](esri-widgets-Feature-FeatureViewModel.html#lastEditInfo) is displayed within the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#VisibleElements) */ lastEditInfo?: boolean; } export class FeatureForm extends Widget { /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#disabled) */ disabled: boolean; /** * The associated feature containing the editable attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#feature) */ feature: Graphic; /** * The associated [template](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html) used for the form. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#formTemplate) */ formTemplate: FormTemplate; /** * Defines how groups will be displayed to the user. * * @default all * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#groupDisplay) */ groupDisplay: "all" | "sequential"; /** * Indicates the heading level to use for the [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#title) of the form. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#headingLevel) */ headingLevel: number; /** * Layer containing the editable feature attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#layer) */ layer: FeatureLayer | SubtypeSublayer; /** * A reference to the associated [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#map) */ map: Map; /** * The timezone displayed within the form. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#timeZone) */ timeZone: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @deprecated since 4.27. Use {@link module:esri/widgets/FeatureForm#map map} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#viewModel) */ viewModel: FeatureFormViewModel; /** * The FeatureForm widget displays attributes of a feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html) */ constructor(properties?: FeatureFormProperties); /** * Returns all of the field values, regardless of update status. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#getValues) */ getValues(): any; /** * Fires the [submit](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#event-submit) event. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#submit) */ submit(): void; on(name: "value-change", eventHandler: FeatureFormValueChangeEventHandler): IHandle; on(name: "submit", eventHandler: FeatureFormSubmitEventHandler): IHandle; } interface FeatureFormProperties extends WidgetProperties { /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#disabled) */ disabled?: boolean; /** * The associated feature containing the editable attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#feature) */ feature?: GraphicProperties; /** * The associated [template](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html) used for the form. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#formTemplate) */ formTemplate?: FormTemplateProperties; /** * Defines how groups will be displayed to the user. * * @default all * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#groupDisplay) */ groupDisplay?: "all" | "sequential"; /** * Indicates the heading level to use for the [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#title) of the form. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#headingLevel) */ headingLevel?: number; /** * Layer containing the editable feature attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#layer) */ layer?: (FeatureLayerProperties & { type: "feature" }) | (SubtypeSublayerProperties & { type: "subtype-sublayer" }); /** * A reference to the associated [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#map) */ map?: MapProperties; /** * The timezone displayed within the form. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#timeZone) */ timeZone?: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @deprecated since 4.27. Use {@link module:esri/widgets/FeatureForm#map map} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#viewModel) */ viewModel?: FeatureFormViewModelProperties; } export class EditableInput { } export interface FeatureFormViewModel extends Accessor, Evented { } export class FeatureFormViewModel { /** * The associated feature containing the editable attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#feature) */ feature: Graphic; /** * The associated [template](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html) used for the form. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#formTemplate) */ formTemplate: FormTemplate; /** * The field, group, or relationship inputs that make up the form [FeatureForm](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#inputs) */ readonly inputs: (FieldInput | GroupInput | RelationshipInput)[]; /** * Layer containing the editable feature attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#layer) */ layer: FeatureLayer | SceneLayer | SubtypeSublayer; /** * A reference to the associated [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#map) */ map: Map; /** * The widget's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#state) */ readonly state: "ready" | "disabled"; /** * Indicates if the field's value can be submitted without introducing data validation issues. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#submittable) */ submittable: boolean; /** * The timezone displayed within the form. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#timeZone) */ timeZone: string; /** * Indicates whether the form is currently updating. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#updating) */ readonly updating: boolean; /** * Indicates whether all of the input fields are valid. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#valid) */ readonly valid: boolean; /** * Provides the logic for the [FeatureForm](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html) */ constructor(properties?: FeatureFormViewModelProperties); /** * Convenience method to find field inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#findField) */ findField(fieldName: string): FieldInput; /** * Returns all of the field values, regardless of whether or not they were updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#getValues) */ getValues(): any; /** * The method used to set the updated field value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#setValue) */ setValue(fieldName: string, value: number | string | null): void; /** * Fires the [submit](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#event-submit) event. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#submit) */ submit(): void; /** * Validates whether a feature's attribute values conform to the defined contingent values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#validateContingencyConstraints) */ validateContingencyConstraints(values: string, options?: FeatureFormViewModelValidateContingencyConstraintsOptions): any[]; on(name: "value-change", eventHandler: FeatureFormViewModelValueChangeEventHandler): IHandle; on(name: "submit", eventHandler: FeatureFormViewModelSubmitEventHandler): IHandle; } interface FeatureFormViewModelProperties { /** * The associated feature containing the editable attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#feature) */ feature?: GraphicProperties; /** * The associated [template](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html) used for the form. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#formTemplate) */ formTemplate?: FormTemplateProperties; /** * Layer containing the editable feature attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#layer) */ layer?: | (FeatureLayerProperties & { type: "feature" }) | (SceneLayerProperties & { type: "scene" }) | (SubtypeSublayerProperties & { type: "subtype-sublayer" }); /** * A reference to the associated [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#map) */ map?: MapProperties; /** * Indicates if the field's value can be submitted without introducing data validation issues. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#submittable) */ submittable?: boolean; /** * The timezone displayed within the form. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#timeZone) */ timeZone?: string; } export interface FeatureFormViewModelValidateContingencyConstraintsOptions { /** * If `true`, return contingency violations for field groups that are invalid because values have not yet been specified for all their fields. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#validateContingencyConstraints) */ includeIncompleteViolations?: boolean; } export interface FeatureFormViewModelSubmitEvent { invalid: string[]; valid: string[]; values: any; } export interface FeatureFormViewModelValueChangeEvent { feature: Graphic; fieldName: string; layer: FeatureLayer; valid: boolean; value: number | string | null; } export interface FieldInput extends Accessor, EditableInput, InputBase { } export class FieldInput { /** * The type of data displayed by the field input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldInput.html#dataType) */ readonly dataType: "number" | "text" | "date" | "unsupported"; /** * The input value's domain. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldInput.html#domain) */ readonly domain: CodedValueDomain | RangeDomain; /** * Indicates if the field is editable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldInput.html#editable) */ readonly editable: boolean; /** * If the input field's value is invalid, this property returns a validation error code. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldInput.html#error) */ readonly error: string; /** * The associated field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldInput.html#field) */ readonly field: Field; /** * The group containing the field input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldInput.html#group) */ readonly group: GroupInput; /** * A hint for the field's value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldInput.html#hint) */ readonly hint: string; /** * Indicates whether date information is included for date inputs. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldInput.html#includeDate) */ readonly includeDate: boolean; /** * Indicates whether time information is included for date inputs. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldInput.html#includeTime) */ readonly includeTime: string; /** * Indicates whether timestamp information is included for date inputs. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldInput.html#includeTimeOffset) */ readonly includeTimeOffset: boolean; /** * The type of editor used when working with `string` fields. * * @default text-box * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldInput.html#inputType) */ readonly inputType: "text-box" | "text-area"; /** * The field's label. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldInput.html#label) */ readonly label: string; /** * Restricts the input length. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldInput.html#maxLength) */ readonly maxLength: number; /** * Restricts the input length. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldInput.html#minLength) */ readonly minLength: number; /** * The associated field name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldInput.html#name) */ readonly name: string; /** * Indicates whether the field is required. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldInput.html#required) */ readonly required: boolean; /** * Indicates if the field's value can be submitted without introducing data validation issues. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldInput.html#submittable) */ readonly submittable: boolean; /** * The type of input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldInput.html#type) */ readonly type: "field"; /** * Indicates if the field is updating. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldInput.html#updating) */ readonly updating: boolean; /** * Indicates if the input value is valid. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldInput.html#valid) */ readonly valid: boolean; /** * The field input's value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldInput.html#value) */ readonly value: number | string | null; /** * Indicates if the field is visible. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldInput.html#visible) */ readonly visible: boolean; /** * This is a read-only support class that represents a field's input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldInput.html) */ constructor(properties?: FieldInputProperties); } interface FieldInputProperties extends InputBaseProperties { } export interface GroupInput extends Accessor, InputBase { } export class GroupInput { /** * Defines if the group should be expanded or collapsed when the form is initially displayed. * * @default expanded * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-GroupInput.html#initialState) */ readonly initialState: "expanded" | "collapsed"; /** * The field inputs contained within the group. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-GroupInput.html#inputs) */ readonly inputs: FieldInput[] | RelationshipInput[]; /** * The group's label. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-GroupInput.html#label) */ readonly label: string; /** * Indicates whether or not the group is open, ie. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-GroupInput.html#open) */ open: boolean; state: "expanded" | "collapsed"; /** * The type of input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-GroupInput.html#type) */ readonly type: "group"; /** * The group's visibility. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-GroupInput.html#visible) */ readonly visible: boolean; /** * This is a support class that represents a group of field inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-GroupInput.html) */ constructor(properties?: GroupInputProperties); } interface GroupInputProperties extends InputBaseProperties { /** * Indicates whether or not the group is open, ie. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-GroupInput.html#open) */ open?: boolean; state?: "expanded" | "collapsed"; } export class InputBase { /** * The input's description. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-InputBase.html#description) */ readonly description: string; } interface InputBaseProperties { } export interface RelationshipInput extends Accessor, EditableInput, InputBase { } export class RelationshipInput { /** * A numeric value indicating the maximum number of related features to display in the list of related records. * * @default 3 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-RelationshipInput.html#displayCount) */ readonly displayCount: number; /** * A string value indicating how to display related records within the relationship content. * * @default "list" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-RelationshipInput.html#displayType) */ readonly displayType: "list"; /** * Indicates whether the input is editable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-RelationshipInput.html#editable) */ readonly editable: boolean; /** * The group containing the relationship input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-RelationshipInput.html#group) */ readonly group: GroupInput; /** * An array of [RelatedRecordsInfoFieldOrder](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-RelatedRecordsInfoFieldOrder.html) objects indicating the field display order for the related records and whether they should be sorted in ascending `asc` or descending `desc` order. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-RelationshipInput.html#orderByFields) */ readonly orderByFields: RelatedRecordsInfoFieldOrder[]; /** * The type of input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-RelationshipInput.html#type) */ readonly type: "relationship"; /** * Indicates whether the form is currently updating. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-RelationshipInput.html#updating) */ readonly updating: boolean; /** * This is a read-only support class that represents a relationship input field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-RelationshipInput.html) */ constructor(properties?: RelationshipInputProperties); } interface RelationshipInputProperties extends InputBaseProperties { } export interface FeatureFormSubmitEvent { invalid: string[]; valid: string[]; values: any; } export interface FeatureFormValueChangeEvent { feature: Graphic; fieldName: string; layer: FeatureLayer; valid: boolean; value: number | string | null; } export interface Features extends Widget, GoTo, Evented { } export class Features { /** * Indicates whether the popup displays its content. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#collapsed) */ readonly collapsed: boolean; /** * The content of the Features widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#content) */ content: string | HTMLElement | Widget; /** * An array of features associated with the Features widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#features) */ features: Graphic[]; /** * Indicates the heading level to use for the [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#title) of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#headingLevel) */ headingLevel: number; /** * An array of pending Promises that have not yet been fulfilled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#promises) */ promises: Promise[]; /** * The selected feature accessed by the Features widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#selectedFeature) */ readonly selectedFeature: Graphic; /** * Index of the feature that is [selected](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#selectedFeature). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#selectedFeatureIndex) */ selectedFeatureIndex: number; /** * Returns a reference to the current [Feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#selectedFeatureWidget) */ readonly selectedFeatureWidget: Feature; /** * The title of the Features widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#title) */ title: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#view) */ view: MapView | SceneView; /** * This is a class that contains all the logic (properties and methods) that controls this widget's behavior. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#viewModel) */ viewModel: FeaturesViewModel; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#visibleElements) */ visibleElements: FeaturesVisibleElements; /** * The Features widget allows users to view a feature's popupTemplate content such as attributes, actions, related records, etc., without having to be tied to the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html) */ constructor(properties?: FeaturesProperties); /** * Use this method to remove focus from the Widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#blur) */ blur(): void; /** * Removes [promises](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#promises), [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#features), [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#content), and [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#title) from the Features widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#clear) */ clear(): void; /** * This is a convenience method to closes the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#close) */ close(): void; /** * Use this method to return feature(s) at a given screen location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#fetchFeatures) */ fetchFeatures(screenPoint: FeaturesFetchFeaturesScreenPoint, options?: FetchFeaturesOptions): Promise; /** * Use this method to give focus to the Widget if the widget is able to be focused. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#focus) */ focus(): void; /** * Selects the feature at the next index in relation to the selected feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#next) */ next(): FeaturesViewModel; /** * Opens the Features widget in its [container](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#container) with content defined either explicitly with `content` or driven from the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) of input features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#open) */ open(options?: FeaturesOpenOptions): void; /** * Selects the feature at the previous index in relation to the selected feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#previous) */ previous(): FeaturesViewModel; /** * Triggers the [trigger-action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#event-trigger-action) event and executes the [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#actions) at the specified index in the [actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#actions) array. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#triggerAction) */ triggerAction(actionIndex: number): void; on(name: "trigger-action", eventHandler: FeaturesTriggerActionEventHandler): IHandle; } interface FeaturesProperties extends WidgetProperties, GoToProperties { /** * The content of the Features widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#content) */ content?: string | HTMLElement | WidgetProperties; /** * An array of features associated with the Features widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#features) */ features?: GraphicProperties[]; /** * Indicates the heading level to use for the [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#title) of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#headingLevel) */ headingLevel?: number; /** * An array of pending Promises that have not yet been fulfilled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#promises) */ promises?: Promise[]; /** * Index of the feature that is [selected](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#selectedFeature). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#selectedFeatureIndex) */ selectedFeatureIndex?: number; /** * The title of the Features widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#title) */ title?: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * This is a class that contains all the logic (properties and methods) that controls this widget's behavior. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#viewModel) */ viewModel?: FeaturesViewModelProperties; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#visibleElements) */ visibleElements?: FeaturesVisibleElements; } export interface FeaturesViewModel extends Accessor, Evented, GoTo { } export class FeaturesViewModel { /** * [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [action toggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html) objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#actions) */ actions: Collection; /** * Indicates if the view model is active when it is visible and is not [waiting for results](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#waitingForResult). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#active) */ readonly active: boolean; /** * A collection of [actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [action toggles](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#allActions) */ readonly allActions: Collection; /** * This closes the container when the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) camera or [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) changes. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#autoCloseEnabled) */ autoCloseEnabled: boolean; /** * Indicates if the "Browse features" experience is active in a [cluster](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html) popup. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#browseClusterEnabled) */ browseClusterEnabled: boolean; /** * The information to display. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#content) */ content: string | HTMLElement | Widget; /** * A read-only property that specifies a [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of action [buttons](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) and/or [toggles](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#defaultActions) */ readonly defaultActions: Collection; /** * Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#defaultPopupTemplateEnabled) */ defaultPopupTemplateEnabled: boolean; /** * The number of selected [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#features) available. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#featureCount) */ readonly featureCount: number; /** * An array of features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#features) */ features: Graphic[]; /** * The number of features to fetch at one time. * * @default 20 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#featuresPerPage) */ featuresPerPage: number; /** * Defines the specific [abilities](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#Abilities) that can be used when querying and displaying content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#featureViewModelAbilities) */ featureViewModelAbilities: Abilities; /** * An array of [feature view model(s)](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#featureViewModels) */ readonly featureViewModels: FeatureViewModel[]; /** * Highlight the selected feature using the [highlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#highlightOptions) set on the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or the [highlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlightOptions) set on the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#highlightEnabled) */ highlightEnabled: boolean; /** * Indicates whether or not to include [defaultActions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#defaultActions). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#includeDefaultActions) */ includeDefaultActions: boolean; /** * Geometry used to show the location of the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#location) */ location: Point; /** * The number of [promises](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#promises) remaining to be resolved. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#pendingPromisesCount) */ readonly pendingPromisesCount: number; /** * The number of selected [promises](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#promises) available. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#promiseCount) */ readonly promiseCount: number; /** * An array of pending Promises that have not yet been fulfilled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#promises) */ promises: Promise[]; /** * The graphic used to represent the cluster extent when the `Browse features` action is active. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#selectedClusterBoundaryFeature) */ readonly selectedClusterBoundaryFeature: Graphic; /** * The selected feature accessed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#selectedFeature) */ readonly selectedFeature: Graphic; /** * Index of the feature that is [selected](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#selectedFeature). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#selectedFeatureIndex) */ selectedFeatureIndex: number; /** * The view model's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#state) */ readonly state: "ready" | "disabled"; /** * The title of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#title) */ title: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#view) */ view: MapView | SceneView; /** * Indicates whether the widget is visible. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#visible) */ visible: boolean; /** * Indicates whether a feature was found while resolving [promises](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#promises). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#waitingForResult) */ readonly waitingForResult: boolean; /** * Provides the logic for the [Features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html) */ constructor(properties?: FeaturesViewModelProperties); /** * Removes all [promises](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#promises), [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#features), [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#content), and [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#title). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#clear) */ clear(): void; /** * Use this method to return feature(s) at a given screen location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#fetchFeatures) */ fetchFeatures(screenPoint: FeaturesViewModelFetchFeaturesScreenPoint, options?: PopupFetchFeaturesOptions): Promise; /** * Selects the feature at the next index in relation to the selected feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#next) */ next(): FeaturesViewModel; /** * Opens the widget at the given location with content defined either explicitly with `content` or driven from the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) of input features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#open) */ open(options?: FeaturesViewModelOpenOptions): void; /** * Selects the feature at the previous index in relation to the selected feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#previous) */ previous(): FeaturesViewModel; /** * Triggers the [trigger-action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#event-trigger-action) event and executes the [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#actions) at the specified index in the [actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#actions) array. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#triggerAction) */ triggerAction(actionIndex: number): void; on(name: "trigger-action", eventHandler: FeaturesViewModelTriggerActionEventHandler): IHandle; } interface FeaturesViewModelProperties extends GoToProperties { /** * [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [action toggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html) objects. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#actions) */ actions?: CollectionProperties< (ActionButtonProperties & { type: "button" }) | (ActionToggleProperties & { type: "toggle" }) >; /** * This closes the container when the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) camera or [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) changes. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#autoCloseEnabled) */ autoCloseEnabled?: boolean; /** * Indicates if the "Browse features" experience is active in a [cluster](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html) popup. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#browseClusterEnabled) */ browseClusterEnabled?: boolean; /** * The information to display. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#content) */ content?: string | HTMLElement | WidgetProperties; /** * Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#defaultPopupTemplateEnabled) */ defaultPopupTemplateEnabled?: boolean; /** * An array of features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#features) */ features?: GraphicProperties[]; /** * The number of features to fetch at one time. * * @default 20 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#featuresPerPage) */ featuresPerPage?: number; /** * Defines the specific [abilities](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#Abilities) that can be used when querying and displaying content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#featureViewModelAbilities) */ featureViewModelAbilities?: Abilities; /** * Highlight the selected feature using the [highlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#highlightOptions) set on the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or the [highlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlightOptions) set on the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#highlightEnabled) */ highlightEnabled?: boolean; /** * Indicates whether or not to include [defaultActions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#defaultActions). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#includeDefaultActions) */ includeDefaultActions?: boolean; /** * Geometry used to show the location of the feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#location) */ location?: PointProperties; /** * An array of pending Promises that have not yet been fulfilled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#promises) */ promises?: Promise[]; /** * Index of the feature that is [selected](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#selectedFeature). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#selectedFeatureIndex) */ selectedFeatureIndex?: number; /** * The title of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#title) */ title?: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * Indicates whether the widget is visible. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#visible) */ visible?: boolean; } export interface FeaturesViewModelFetchFeaturesScreenPoint { /** * The x coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#fetchFeatures) */ x: number; /** * The y coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#fetchFeatures) */ y: number; } export interface FeaturesViewModelOpenOptions { /** * Sets the [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#title) of the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#open) */ title?: string; /** * Sets the [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#content) of the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#open) */ content?: string; /** * **Since:** 4.12 When `true`, indicates the feature's content should be fetched and displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#open) */ fetchFeatures?: boolean; /** * Sets the [location](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#location), which is the geometry used to position the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#open) */ location?: Geometry; /** * Sets the [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#features), which populates the title and content based on each graphic's [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#open) */ features?: Graphic[]; /** * Sets pending [promises](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#promises). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#open) */ promises?: Promise[]; /** * When `true`, indicates the [location](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#location) property will be updated for each paginated feature based on the [selected feature's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#selectedFeature) geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#open) */ updateLocationEnabled?: boolean; } export interface FeaturesViewModelTriggerActionEvent { action: ActionButton | ActionToggle; } export interface FeaturesFetchFeaturesScreenPoint { /** * The x coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#fetchFeatures) */ x: number; /** * The y coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#fetchFeatures) */ y: number; } export interface FeaturesOpenOptions { /** * This property allows you to specify a collection of [actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) to the action bar when the Features widget opens. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#open) */ actions?: Collection; /** * Indicates whether the widget displays its content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#open) */ collapsed?: boolean; /** * Sets the [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#content) of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#open) */ content?: string | HTMLElement | Widget; /** * Sets the widget's [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#features), which populate the title and content of the widget based on each graphic's [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#open) */ features?: Graphic[]; /** * This property enables multiple features in the widget to display in a list rather than displaying the first selected feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#open) */ featureMenuOpen?: boolean; /** * When `true`, indicates the widget should fetch the content of this feature and display it. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#open) */ fetchFeatures?: boolean; /** * The geometry used to query for the features when `fetchFeatures=true`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#open) */ location?: Geometry; /** * Sets pending [promises](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#promises) on the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#open) */ promises?: Promise[]; /** * Sets the [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#title) of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#open) */ title?: string; /** * Indicates whether to update the location when the [selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#selectedFeatureIndex) changes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#open) */ updateLocationEnabled?: string; } /** * Optional properties to use with the [fetchFeatures](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#fetchFeatures) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#FetchFeaturesOptions) */ export interface FetchFeaturesOptions { /** * The `click` event for either the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#FetchFeaturesOptions) */ event?: any; /** * The signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#FetchFeaturesOptions) */ signal?: AbortSignal; } export interface FeaturesTriggerActionEvent { action: ActionButton; } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#VisibleElements) */ export interface FeaturesVisibleElements { /** * Indicates whether to display the action bar that holds the feature's [actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#actions) will be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#VisibleElements) */ actionBar?: boolean; /** * Indicates whether to display a close button on the widget dialog. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#VisibleElements) */ closeButton?: boolean; /** * **Since 4.28.** Indicates whether to display the collapse button on the widget dialog. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#VisibleElements) */ collapseButton?: boolean; /** * Indicates whether pagination for feature navigation will be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#VisibleElements) */ featureNavigation?: boolean; /** * **Since 4.29.** Determines whether the widget should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#VisibleElements) */ flow?: boolean; /** * Indicates whether to display the widget heading. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#VisibleElements) */ heading?: boolean; /** * Indicates whether to display the widget's loading spinner. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#VisibleElements) */ spinner?: boolean; } export class FeatureTable extends Widget { /** * A read-only property indicating the type of filter used by the table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#activeFilters) */ readonly activeFilters: Collection; /** * Use this read-only property if needing to query features while retaining a column's sort order. * * @default [] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#activeSortOrders) */ readonly activeSortOrders: ColumnSortOrder[]; /** * Indicates whether to display the `Attachments` field in the table. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#attachmentsEnabled) */ attachmentsEnabled: boolean; /** * Automatically refreshes the table when its associated layer has been updated. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#autoRefreshEnabled) */ autoRefreshEnabled: boolean; /** * When `true`, columns can be reordered by dragging a column's header. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#columnReorderingEnabled) */ columnReorderingEnabled: boolean; /** * A read-only collection of [field columns](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html) and/or [grouped field columns](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-GroupColumn.html) within the table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#columns) */ readonly columns: Collection; /** * Indicates whether editing is enabled on the data within the feature table. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#editingEnabled) */ editingEnabled: boolean; /** * Set this property to filter the features displayed in the table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#filterGeometry) */ filterGeometry: Geometry; /** * A collection of string [field.names](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) that are to remain hidden within the table. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#hiddenFields) */ hiddenFields: Collection; /** * Indicates whether to highlight the associated feature when a row is selected. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#highlightEnabled) */ highlightEnabled: boolean; /** * This property accepts and returns a collection of feature ObjectId's. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#highlightIds) */ highlightIds: Collection; /** * Indicates whether to highlight the associated feature when a row is selected. * * @default true * @deprecated since version 4.25. Use {@link module:esri/widgets/FeatureTable#highlightEnabled highlightEnabled} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#highlightOnRowSelectEnabled) */ highlightOnRowSelectEnabled: boolean; /** * The associated [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html), [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html), [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html), [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html), or [WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html) containing the fields and attributes to display within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#layer) */ layer: FeatureLayer | SceneLayer | GeoJSONLayer | CSVLayer | WFSLayer | ImageryLayer; /** * Reference to the FeatureTable's menu. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#menu) */ readonly menu: ButtonMenu; /** * Set this object to customize the feature table's menu content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#menuConfig) */ menuConfig: ButtonMenuConfig; /** * Indicates whether sorting multiple columns is supported within the table. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#multiSortEnabled) */ multiSortEnabled: boolean; /** * The default page size used when displaying features within the table. * * @default 50 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#pageSize) */ pageSize: number; /** * Indicates whether to fetch geometries for the corresponding features displayed in the table. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#returnGeometryEnabled) */ returnGeometryEnabled: boolean; /** * The state of the widget. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#state) */ readonly state: "disabled" | "loading" | "loaded" | "ready"; /** * The associated [template](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html) used for the feature table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#tableTemplate) */ tableTemplate: TableTemplate; /** * Dates and times displayed in the widget will be in terms of this time zone. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#timeZone) */ timeZone: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#viewModel) */ viewModel: FeatureTableViewModel; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#visibleElements) */ visibleElements: FeatureTableVisibleElements; /** * This widget provides an interactive tabular view of each feature's attributes in a feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) */ constructor(properties?: FeatureTableProperties); /** * Clears the current selection within the table. * * @deprecated since version 4.25. Use {@link module:esri/core/Collection#removeAll highlightIds.removeAll()} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#clearSelection) */ clearSelection(): void; /** * Clears the current selection filter within the table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#clearSelectionFilter) */ clearSelectionFilter(): void; /** * Deletes all the selected rows from the table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#deleteSelection) */ deleteSelection(showWarningPrompt?: boolean): Promise; /** * Unselects the specified rows within the table. * * @deprecated since 4.25. Use {@link module:esri/widgets/FeatureTable#highlightIds highlightIds.remove()} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#deselectRows) */ deselectRows(params: number | Graphic | (number | Graphic)[]): void; /** * Filters the table by the current selection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#filterBySelection) */ filterBySelection(): void; /** * Finds the specified column within the feature table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#findColumn) */ findColumn(fieldName: string): Column | GroupColumn; /** * Hides the specified column from the feature table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#hideColumn) */ hideColumn(fieldName: string): void; /** * Refreshes the table contents while maintaining the current scroll position. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#refresh) */ refresh(): Promise; /** * Scrolls the table to a row based on a specified index. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#scrollToIndex) */ scrollToIndex(index: number): void; /** * Selects the specified rows within the table. * * @deprecated since 4.25. Use {@link module:esri/widgets/FeatureTable#highlightIds highlightIds.add()} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#selectRows) */ selectRows(params: number | Graphic | (number | Graphic)[]): void; /** * Shows all of the columns in the table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#showAllColumns) */ showAllColumns(): void; /** * Shows the specified column within the feature table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#showColumn) */ showColumn(fieldName: string): void; /** * Sorts the column in either ascending ("asc") or descending ("desc") order. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#sortColumn) */ sortColumn(path: string, direction: "asc" | "desc"): void; /** * Zooms the view to the extent of the current row selection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#zoomToSelection) */ zoomToSelection(): void; on(name: "selection-change", eventHandler: FeatureTableSelectionChangeEventHandler): IHandle; } interface FeatureTableProperties extends WidgetProperties { /** * Indicates whether to display the `Attachments` field in the table. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#attachmentsEnabled) */ attachmentsEnabled?: boolean; /** * Automatically refreshes the table when its associated layer has been updated. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#autoRefreshEnabled) */ autoRefreshEnabled?: boolean; /** * When `true`, columns can be reordered by dragging a column's header. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#columnReorderingEnabled) */ columnReorderingEnabled?: boolean; /** * Indicates whether editing is enabled on the data within the feature table. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#editingEnabled) */ editingEnabled?: boolean; /** * Set this property to filter the features displayed in the table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#filterGeometry) */ filterGeometry?: GeometryProperties; /** * A collection of string [field.names](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) that are to remain hidden within the table. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#hiddenFields) */ hiddenFields?: CollectionProperties; /** * Indicates whether to highlight the associated feature when a row is selected. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#highlightEnabled) */ highlightEnabled?: boolean; /** * This property accepts and returns a collection of feature ObjectId's. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#highlightIds) */ highlightIds?: CollectionProperties; /** * Indicates whether to highlight the associated feature when a row is selected. * * @default true * @deprecated since version 4.25. Use {@link module:esri/widgets/FeatureTable#highlightEnabled highlightEnabled} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#highlightOnRowSelectEnabled) */ highlightOnRowSelectEnabled?: boolean; /** * The associated [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html), [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html), [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html), [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html), or [WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html) containing the fields and attributes to display within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#layer) */ layer?: | (FeatureLayerProperties & { type: "feature" }) | (SceneLayerProperties & { type: "scene" }) | (GeoJSONLayerProperties & { type: "geojson" }) | (CSVLayerProperties & { type: "csv" }) | (WFSLayerProperties & { type: "wfs" }) | (ImageryLayerProperties & { type: "imagery" }); /** * Set this object to customize the feature table's menu content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#menuConfig) */ menuConfig?: ButtonMenuConfig; /** * Indicates whether sorting multiple columns is supported within the table. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#multiSortEnabled) */ multiSortEnabled?: boolean; /** * The default page size used when displaying features within the table. * * @default 50 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#pageSize) */ pageSize?: number; /** * Indicates whether to fetch geometries for the corresponding features displayed in the table. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#returnGeometryEnabled) */ returnGeometryEnabled?: boolean; /** * The associated [template](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html) used for the feature table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#tableTemplate) */ tableTemplate?: TableTemplateProperties; /** * Dates and times displayed in the widget will be in terms of this time zone. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#timeZone) */ timeZone?: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#viewModel) */ viewModel?: FeatureTableViewModelProperties; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#visibleElements) */ visibleElements?: FeatureTableVisibleElements; } export class FeatureTableViewModel extends Accessor { /** * A read-only property indicating the type of filter used by the table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#activeFilters) */ readonly activeFilters: Collection; /** * Use this read-only property if needing to query features while retaining a column's sort order. * * @default [] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#activeSortOrders) */ readonly activeSortOrders: ColumnSortOrder[]; /** * Indicates whether to display the `Attachments` field in the table. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#attachmentsEnabled) */ attachmentsEnabled: boolean; /** * Indicates whether to refresh the table when the layer is refreshed. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#autoRefreshEnabled) */ autoRefreshEnabled: boolean; /** * Indicates whether editing is enabled on the data within the feature table. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#editingEnabled) */ editingEnabled: boolean; /** * Set this property to filter the features displayed in the table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#filterGeometry) */ filterGeometry: Geometry; /** * A collection of string [field.names](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) that are to remain hidden within the table. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#hiddenFields) */ hiddenFields: Collection; /** * Indicates whether to highlight the associated feature when a row is selected. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#highlightEnabled) */ highlightEnabled: boolean; /** * This property accepts and returns a collection of feature ObjectId's. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#highlightIds) */ highlightIds: Collection; /** * Indicates whether to highlight the associated feature when a row is selected. * * @default true * @deprecated since version 4.25. Use {@link module:esri/widgets/FeatureTable/FeatureTableViewModel#highlightEnabled highlightEnabled} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#highlightOnRowSelectEnabled) */ highlightOnRowSelectEnabled: boolean; /** * The associated [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html), [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html), [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html), [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html), or [WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html) containing the fields and attributes to display within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#layer) */ layer: FeatureLayer | SceneLayer | GeoJSONLayer | CSVLayer | WFSLayer | ImageryLayer; /** * The [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) displaying data for the table's associated [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#layer). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#layerView) */ readonly layerView: LayerView; /** * Indicates whether sorting multiple columns is supported within the table. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#multiSortEnabled) */ multiSortEnabled: boolean; /** * Indicates whether to fetch geometries for the corresponding features displayed in the table. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#returnGeometryEnabled) */ returnGeometryEnabled: boolean; /** * The view model's state. * * @default ready * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#state) */ readonly state: "disabled" | "loading" | "loaded" | "ready"; /** * The associated [template](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html) used for the feature table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#tableTemplate) */ tableTemplate: TableTemplate; /** * Dates and times displayed in the widget will be in terms of this time zone. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#timeZone) */ timeZone: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#view) */ view: MapView | SceneView; /** * Provides the logic for the [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) widget, which allows users to view content from feature attributes in a tabular format. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html) */ constructor(properties?: FeatureTableViewModelProperties); /** * Clears the current selection within the table. * * @deprecated since version 4.25. Use {@link module:esri/core/Collection#removeAll highlightIds.removeAll()} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#clearSelection) */ clearSelection(): void; /** * Clears the current [filterBySelection](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#filterBySelection) so that the table displays all of the table rows. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#clearSelectionFilter) */ clearSelectionFilter(): void; /** * Deletes all the selected rows from the table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#deleteSelection) */ deleteSelection(showWarningPrompt?: boolean): Promise; /** * Unselects the specified rows within the table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#deselectRows) */ deselectRows(params: number | Graphic | (number | Graphic)[]): void; /** * Filters the table using the current row selection and displays only those selected table rows. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#filterBySelection) */ filterBySelection(): void; /** * Returns the current row index for the associated feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#getObjectIdIndex) */ getObjectIdIndex(objectId: number): number; /** * Returns a field value given the specified feature `ObjectId` and an associated `fieldName`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#getValue) */ getValue(objectId: number, fieldName: string): string | number | null; /** * Refreshes the table contents while maintaining the current scroll position. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#refresh) */ refresh(): void; /** * Performs a full reset of the entire table resulting in the table scrolling to the top-most row. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#reset) */ reset(): void; /** * Scrolls the table to a row based on a specified index. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#scrollToIndex) */ scrollToIndex(index: number): void; /** * Selects the specified rows within the table. * * @deprecated since 4.25. Use {@link module:esri/widgets/FeatureTable#highlightIds highlightIds.add()} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#selectRows) */ selectRows(params: number | Graphic | (number | Graphic)[]): void; /** * Zooms the view to the extent of the current row selection. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#zoomToSelection) */ zoomToSelection(): void; } interface FeatureTableViewModelProperties { /** * Indicates whether to display the `Attachments` field in the table. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#attachmentsEnabled) */ attachmentsEnabled?: boolean; /** * Indicates whether to refresh the table when the layer is refreshed. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#autoRefreshEnabled) */ autoRefreshEnabled?: boolean; /** * Indicates whether editing is enabled on the data within the feature table. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#editingEnabled) */ editingEnabled?: boolean; /** * Set this property to filter the features displayed in the table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#filterGeometry) */ filterGeometry?: GeometryProperties; /** * A collection of string [field.names](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) that are to remain hidden within the table. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#hiddenFields) */ hiddenFields?: CollectionProperties; /** * Indicates whether to highlight the associated feature when a row is selected. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#highlightEnabled) */ highlightEnabled?: boolean; /** * This property accepts and returns a collection of feature ObjectId's. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#highlightIds) */ highlightIds?: CollectionProperties; /** * Indicates whether to highlight the associated feature when a row is selected. * * @default true * @deprecated since version 4.25. Use {@link module:esri/widgets/FeatureTable/FeatureTableViewModel#highlightEnabled highlightEnabled} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#highlightOnRowSelectEnabled) */ highlightOnRowSelectEnabled?: boolean; /** * The associated [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html), [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html), [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html), [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html), or [WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html) containing the fields and attributes to display within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#layer) */ layer?: | (FeatureLayerProperties & { type: "feature" }) | (SceneLayerProperties & { type: "scene" }) | (GeoJSONLayerProperties & { type: "geojson" }) | (CSVLayerProperties & { type: "csv" }) | (WFSLayerProperties & { type: "wfs" }) | (ImageryLayerProperties & { type: "imagery" }); /** * Indicates whether sorting multiple columns is supported within the table. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#multiSortEnabled) */ multiSortEnabled?: boolean; /** * Indicates whether to fetch geometries for the corresponding features displayed in the table. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#returnGeometryEnabled) */ returnGeometryEnabled?: boolean; /** * The associated [template](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html) used for the feature table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#tableTemplate) */ tableTemplate?: TableTemplateProperties; /** * Dates and times displayed in the widget will be in terms of this time zone. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#timeZone) */ timeZone?: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } /** * An array of objects containing a column's name and sort direction. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#ColumnSortOrder) */ export interface ColumnSortOrder { /** * The field name as defined by the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#ColumnSortOrder) */ fieldName: string; /** * Controls the sort order of the column given the set `fieldName`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#ColumnSortOrder) */ direction: "asc" | "desc" | null; } /** * Use this for spatial filtering, it is the [Geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html) used to filter out data within the table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#GeometryFilter) */ export interface GeometryFilter { /** * The type of the filter used. * * [Read more...](global.html#type) */ type: string; /** * The geometry used to filter out the table's data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#GeometryFilter) */ geometry: Geometry; } /** * Use this for selecting rows within the table based off of their ObjectId. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#SelectionFilter) */ export interface SelectionFilter { /** * The type of the filter used. * * [Read more...](global.html#type) */ type: string; /** * An array of numbers indicating the row's ObjectId's. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#SelectionFilter) */ objectIds: number[]; } export interface FieldColumn extends Accessor, Column { } export class FieldColumn { /** * The display name for the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html#alias) */ readonly alias: string; /** * The default value set for the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html#defaultValue) */ readonly defaultValue: number | string | null | undefined; /** * Contains information describing the purpose of each field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html#description) */ readonly description: string; /** * Indicates whether the field is editable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html#editable) */ readonly editable: boolean; /** * The [Field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) associated with this column. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html#field) */ field: Field; /** * If applicable, the associated [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) tied to the column. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html#layer) */ layer: FeatureLayer | SceneLayer; /** * Restricts the input length for the column. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html#maxLength) */ readonly maxLength: number; /** * The [Object](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#ButtonMenuConfig) used to customize the column's menu content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html#menuConfig) */ readonly menuConfig: ButtonMenuConfig; /** * Restricts the input length for the column. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html#minLength) */ readonly minLength: number; /** * The name of the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html#name) */ readonly name: string; /** * Indicates if the field can accept `null` values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html#nullable) */ readonly nullable: boolean; /** * Indicates whether the field is required. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html#required) */ readonly required: boolean; /** * Indicates whether the column is sortable. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html#sortable) */ sortable: boolean; /** * A configurable template for the table column. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html#template) */ template: FieldColumnTemplate; /** * The [FieldColumn](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html) class works with the [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) and provides the underlying logic for column behavior. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html) */ constructor(properties?: FieldColumnProperties); } interface FieldColumnProperties extends ColumnProperties { /** * The [Field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) associated with this column. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html#field) */ field?: FieldProperties; /** * If applicable, the associated [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) tied to the column. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html#layer) */ layer?: (FeatureLayerProperties & { type: "feature" }) | (SceneLayerProperties & { type: "scene" }); /** * Indicates whether the column is sortable. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html#sortable) */ sortable?: boolean; /** * A configurable template for the table column. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html#template) */ template?: FieldColumnTemplateProperties; } export class Column { /** * Used to indicate the column is in an invalid state. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-Column.html#invalid) */ invalid: boolean; /** * The object to customize the feature table column's menu content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-Column.html#menu) */ readonly menu: ButtonMenu; /** * Indicates whether the column is resizable. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-Column.html#resizable) */ readonly resizable: boolean; /** * Returns any associated menu items on the column. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-Column.html#getMenuItems) */ getMenuItems(): ButtonMenuItemConfig; } interface ColumnProperties { /** * Used to indicate the column is in an invalid state. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-Column.html#invalid) */ invalid?: boolean; } export interface GroupColumn extends Accessor, Column { } export class GroupColumn { constructor(properties?: GroupColumnProperties); } interface GroupColumnProperties extends ColumnProperties { } export class ButtonMenu extends Widget { /** * When true, the widget is visually withdrawn and cannot be interacted with. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenu.html#disabled) */ disabled: boolean; /** * Adds a CSS class to the menu button's DOM node. * * @deprecated since 4.27. Use {@link module:esri/widgets/DirectionPad#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenu.html#iconClass) */ iconClass: string; /** * An array of individual [menu items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenu.html#items) */ items: ButtonMenuItem[]; /** * Indicates if the menu content is open and visible. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenu.html#open) */ open: boolean; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenu.html#viewModel) */ viewModel: ButtonMenuViewModel; /** * This widget provides the underlying menu functionality when working with the [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenu.html) */ constructor(properties?: ButtonMenuProperties); } interface ButtonMenuProperties extends WidgetProperties { /** * When true, the widget is visually withdrawn and cannot be interacted with. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenu.html#disabled) */ disabled?: boolean; /** * Adds a CSS class to the menu button's DOM node. * * @deprecated since 4.27. Use {@link module:esri/widgets/DirectionPad#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenu.html#iconClass) */ iconClass?: string; /** * An array of individual [menu items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenu.html#items) */ items?: ButtonMenuItemProperties[]; /** * Indicates if the menu content is open and visible. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenu.html#open) */ open?: boolean; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenu.html#viewModel) */ viewModel?: ButtonMenuViewModelProperties; } export class ButtonMenuItem extends Accessor { /** * Indicates whether to automatically close the menu's item. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#autoCloseMenu) */ autoCloseMenu: boolean; /** * A function that executes on the ButtonMenuItem's `click` event. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#clickFunction) */ clickFunction: ButtonMenuItemClickFunction; /** * Adds a CSS class to the menu button's DOM node. * * @deprecated since 4.27. Use {@link module:esri/widgets/DirectionPad#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#iconClass) */ iconClass: string; /** * An array of individual [menu items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#items) */ items: ButtonMenuItem[]; /** * The label of the menu item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#label) */ label: string; /** * Indicates if the menu content is visible. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#open) */ open: boolean; /** * Indicates whether the menu item is selected. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#selected) */ selected: boolean; /** * Indicates whether a toggled state should be applied to individual menu items. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#selectionEnabled) */ selectionEnabled: boolean; /** * The `ButtonMenuItem` class provides the underlying menu functionality to create and customize new menu items within the [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) widget's [ButtonMenu](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenu.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html) */ constructor(properties?: ButtonMenuItemProperties); } interface ButtonMenuItemProperties { /** * Indicates whether to automatically close the menu's item. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#autoCloseMenu) */ autoCloseMenu?: boolean; /** * A function that executes on the ButtonMenuItem's `click` event. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#clickFunction) */ clickFunction?: ButtonMenuItemClickFunction; /** * Adds a CSS class to the menu button's DOM node. * * @deprecated since 4.27. Use {@link module:esri/widgets/DirectionPad#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#iconClass) */ iconClass?: string; /** * An array of individual [menu items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#items) */ items?: ButtonMenuItemProperties[]; /** * The label of the menu item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#label) */ label?: string; /** * Indicates if the menu content is visible. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#open) */ open?: boolean; /** * Indicates whether the menu item is selected. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#selected) */ selected?: boolean; /** * Indicates whether a toggled state should be applied to individual menu items. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#selectionEnabled) */ selectionEnabled?: boolean; } export type ButtonMenuItemClickFunction = (event: any) => void; export class ButtonMenuViewModel extends Accessor { /** * An array of individual [menu items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuViewModel.html#items) */ items: ButtonMenuItem[]; /** * Indicates if the menu content is visible. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuViewModel.html#open) */ open: boolean; /** * Provides the logic for the module:esri/widgets/ButtonMenuItemConfig widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuViewModel.html) */ constructor(properties?: ButtonMenuViewModelProperties); } interface ButtonMenuViewModelProperties { /** * An array of individual [menu items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuViewModel.html#items) */ items?: ButtonMenuItemProperties[]; /** * Indicates if the menu content is visible. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuViewModel.html#open) */ open?: boolean; } export class ColumnTemplate extends ColumnTemplateBase { /** * Indicates whether the field is editable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplate.html#editable) */ editable: boolean; /** * Indicates whether a field requires a value. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplate.html#required) */ required: boolean; /** * The 'type' of column that the template represents. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplate.html#type) */ readonly type: "column"; /** * A ColumnTemplate formats and defines the structure of a [Column](module-esri-widgets-FeatureTable-Grid-Column.html) within a [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplate.html) */ constructor(properties?: ColumnTemplateProperties); static fromJSON(json: any): ColumnTemplate; } interface ColumnTemplateProperties extends ColumnTemplateBaseProperties { /** * Indicates whether the field is editable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplate.html#editable) */ editable?: boolean; /** * Indicates whether a field requires a value. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplate.html#required) */ required?: boolean; } export interface ColumnTemplateBase extends Accessor, JSONSupport { } export class ColumnTemplateBase { /** * Controls the sort order of the column. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplateBase.html#direction) */ direction: "asc" | "desc" | null; /** * Use this in combination with [FeatureTable.multiSortEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#multiSortEnabled) and FeatureTable.direction properties to set sorting functionality on multiple columns. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplateBase.html#initialSortPriority) */ initialSortPriority: number; /** * A string value containing the column alias. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplateBase.html#label) */ label: string; /** * Set this object to customize the column's menu content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplateBase.html#menuConfig) */ menuConfig: ButtonMenuConfig; /** * Indicates whether the field column can be sorted. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplateBase.html#sortable) */ sortable: boolean; /** * Aligns the columns cell content horizontally. * * @default start * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplateBase.html#textAlign) */ textAlign: "start" | "center" | "end"; /** * The 'type' of column that the template represents. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplateBase.html#type) */ readonly type: "column" | "field" | "group"; /** * Indicates whether the column is visible. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplateBase.html#visible) */ visible: boolean; /** * The base class for all column templates used by the [tableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html) within the [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplateBase.html) */ constructor(properties?: ColumnTemplateBaseProperties); static fromJSON(json: any): ColumnTemplateBase; } interface ColumnTemplateBaseProperties { /** * Controls the sort order of the column. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplateBase.html#direction) */ direction?: "asc" | "desc" | null; /** * Use this in combination with [FeatureTable.multiSortEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#multiSortEnabled) and FeatureTable.direction properties to set sorting functionality on multiple columns. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplateBase.html#initialSortPriority) */ initialSortPriority?: number; /** * A string value containing the column alias. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplateBase.html#label) */ label?: string; /** * Set this object to customize the column's menu content. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplateBase.html#menuConfig) */ menuConfig?: ButtonMenuConfig; /** * Indicates whether the field column can be sorted. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplateBase.html#sortable) */ sortable?: boolean; /** * Aligns the columns cell content horizontally. * * @default start * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplateBase.html#textAlign) */ textAlign?: "start" | "center" | "end"; /** * Indicates whether the column is visible. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplateBase.html#visible) */ visible?: boolean; } export class FieldColumnTemplate extends ColumnTemplateBase { /** * The [coded value domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CodedValueDomain.html) or a [range domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RangeDomain.html) of the associated field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#domain) */ domain: CodedValueDomain | RangeDomain; /** * Indicates whether the field is editable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#editable) */ editable: boolean; /** * The field name as defined by the feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#fieldName) */ fieldName: string; /** * Indicates whether a field requires a value. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#required) */ required: boolean; /** * The 'type' of column that the template represents. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#type) */ readonly type: "field"; /** * A FieldColumnTemplate formats and defines the structure of a [FieldColumn](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html) within a [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html) */ constructor(properties?: FieldColumnTemplateProperties); static fromJSON(json: any): FieldColumnTemplate; } interface FieldColumnTemplateProperties extends ColumnTemplateBaseProperties { /** * The [coded value domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CodedValueDomain.html) or a [range domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RangeDomain.html) of the associated field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#domain) */ domain?: (CodedValueDomainProperties & { type: "coded-value" }) | (RangeDomainProperties & { type: "range" }); /** * Indicates whether the field is editable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#editable) */ editable?: boolean; /** * The field name as defined by the feature layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#fieldName) */ fieldName?: string; /** * Indicates whether a field requires a value. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#required) */ required?: boolean; } export class GroupColumnTemplate extends ColumnTemplateBase { /** * A collection of [field column templates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html) and/or [group column templates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-GroupColumnTemplate.html) that represent an ordered list of column templates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-GroupColumnTemplate.html#columnTemplates) */ columnTemplates: (FieldColumnTemplate | GroupColumnTemplate)[]; /** * The 'type' of column that the template represents. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-GroupColumnTemplate.html#type) */ readonly type: "group"; /** * A GroupColumnTemplate formats and defines the structure of a [GroupColumn](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-GroupColumn.html) within a [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-GroupColumnTemplate.html) */ constructor(properties?: GroupColumnTemplateProperties); static fromJSON(json: any): GroupColumnTemplate; } interface GroupColumnTemplateProperties extends ColumnTemplateBaseProperties { /** * A collection of [field column templates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html) and/or [group column templates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-GroupColumnTemplate.html) that represent an ordered list of column templates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-GroupColumnTemplate.html#columnTemplates) */ columnTemplates?: ( | (FieldColumnTemplateProperties & { type: "field" }) | (GroupColumnTemplateProperties & { type: "group" }) )[]; } export interface TableTemplate extends Accessor, JSONSupport { } export class TableTemplate { /** * A collection of [field column templates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html) and/or [group column templates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-GroupColumnTemplate.html) that represent an ordered list of column templates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html#columnTemplates) */ columnTemplates: (FieldColumnTemplate | GroupColumnTemplate)[]; /** * A TableTemplate formats and defines the content of a [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html) */ constructor(properties?: TableTemplateProperties); /** * Creates a deep clone of the TableTemplate class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html#clone) */ clone(): TableTemplate; static fromJSON(json: any): TableTemplate; } interface TableTemplateProperties { /** * A collection of [field column templates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html) and/or [group column templates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-GroupColumnTemplate.html) that represent an ordered list of column templates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html#columnTemplates) */ columnTemplates?: ( | (FieldColumnTemplateProperties & { type: "field" }) | (GroupColumnTemplateProperties & { type: "group" }) )[]; } /** * The configurable options to customize either the feature table or [column](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html) menu via the [menuConfig](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#menuConfig) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#ButtonMenuConfig) */ export interface ButtonMenuConfig { /** * The DOM Element containing the menu. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#ButtonMenuConfig) */ container?: HTMLElement; /** * Adds a CSS class to the menu button's DOM node. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#ButtonMenuConfig) */ iconClass?: string; /** * An array of [ButtonMenuItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenuItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#ButtonMenuConfig) */ items?: ButtonMenuItem[]; /** * Indicates if the menu content is visible. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#ButtonMenuConfig) */ open?: boolean; /** * The associated viewModel for the [ButtonMenu](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-support-ButtonMenu.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#ButtonMenuConfig) */ viewModel?: ButtonMenuViewModel; } /** * The configurable options to customize either the feature table or column menu via the [menuConfig](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#menuConfig) item property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#ButtonMenuItemConfig) */ export interface ButtonMenuItemConfig { /** * Indicates whether to automatically close the menu's item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#ButtonMenuItemConfig) */ autoCloseMenu?: boolean; /** * A function that executes on the ButtonMenuItem's `click` event. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#ButtonMenuItemConfig) */ clickFunction?: ButtonMenuItemClickFunction; /** * Adds a CSS class to the menu button's DOM node. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#ButtonMenuItemConfig) */ iconClass?: string; /** * An array of individual menu items. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#ButtonMenuItemConfig) */ items?: ButtonMenuItem[]; /** * The label of the menu item. * * [Read more...](global.html) */ label?: string; /** * Indicates if the menu content is visible. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#ButtonMenuItemConfig) */ open?: boolean; /** * Indicates whether a toggled state should be applied to individual menu items. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#ButtonMenuItemConfig) */ selectionEnabled?: boolean; /** * Indicates whether the menu item is selected. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#ButtonMenuItemConfig) */ selected?: boolean; } export interface FeatureTableSelectionChangeEvent { added: FeatureTableSelectionChangeEventAdded[]; removed: FeatureTableSelectionChangeEventRemoved[]; } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#VisibleElements) */ export interface FeatureTableVisibleElements { /** * Indicates whether to display the feature table's header information. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#VisibleElements) */ header?: boolean; /** * Indicates whether to display the feature table's menu. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#VisibleElements) */ menu?: boolean; /** * Indicates whether to display the selection column in the table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#VisibleElements) */ selectionColumn?: boolean; /** * _(Since 4.23)_ Indicates whether to display the menu items within the individual columns. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#VisibleElements) */ columnMenus?: boolean; /** * The menu items within the feature table menu. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#VisibleElements) */ menuItems?: VisibleElementsMenuItems; } export interface FeatureTableSelectionChangeEventAdded { feature: Graphic; attachments: AttachmentInfo[]; objectId: number; relatedRecords: Graphic[]; } export interface FeatureTableSelectionChangeEventRemoved { feature: Graphic; attachments: AttachmentInfo[]; objectId: number; relatedRecords: Graphic[]; } export interface VisibleElementsMenuItems { /** * Indicates whether to display the `Clear selection` menu item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#VisibleElements) */ clearSelection?: boolean; /** * _(Since 4.25)_ Indicates whether to display the `Delete Selection` menu item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#VisibleElements) */ deleteSelection?: boolean; /** * Indicates whether to display the `Refresh data` menu item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#VisibleElements) */ refreshData?: boolean; /** * _(Since 4.23)_ Indicates whether to toggle between showing only selected records in the table to showing all of the records. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#VisibleElements) */ selectedRecordsShowAllToggle?: boolean; /** * _(Since 4.23)_ Indicates whether to display the `Show selected records` menu item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#VisibleElements) */ selectedRecordsShowSelectedToggle?: boolean; /** * Indicates whether to enable toggling column visibility within the menu. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#VisibleElements) */ toggleColumns?: any; /** * _(Since 4.23)_ Indicates whether to display the `Zoom to selected` menu item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#VisibleElements) */ zoomToSelection?: any; } export class FeatureTemplates extends Widget { /** * Used to disable the widget user interface. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#disabled) */ disabled: boolean; /** * Indicates whether the list of available feature [template items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html) should scroll within its containing element. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#enableListScroll) */ enableListScroll: boolean; /** * [Function](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#FilterFunction) can be defined to help filter [template items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html) within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#filterFunction) */ filterFunction: FilterFunction; /** * Text used to filter items. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#filterText) */ filterText: string; /** * It is possible to group [template items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html). * * @default layer * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#groupBy) */ groupBy: string | GroupByFunction; /** * Indicates the heading level to use for the labels of grouped feature templates. * * @default 4 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#headingLevel) */ headingLevel: number; /** * An array of [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) to display within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#layers) */ layers: (FeatureLayer | GeoJSONLayer | SceneLayer | SubtypeSublayer | SubtypeGroupLayer)[]; /** * Specifies the selection behavior of list items. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#selectionMode) */ selectionMode: "single" | "none"; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#viewModel) */ viewModel: FeatureTemplatesViewModel; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#visibleElements) */ visibleElements: FeatureTemplatesVisibleElements; /** * The FeatureTemplates widget is part of the overall editing workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html) */ constructor(properties?: FeatureTemplatesProperties); /** * Selects the [template item](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html) to use. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#select) */ select(item: TemplateItem): void; on(name: "select", eventHandler: FeatureTemplatesSelectEventHandler): IHandle; } interface FeatureTemplatesProperties extends WidgetProperties { /** * Used to disable the widget user interface. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#disabled) */ disabled?: boolean; /** * Indicates whether the list of available feature [template items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html) should scroll within its containing element. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#enableListScroll) */ enableListScroll?: boolean; /** * [Function](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#FilterFunction) can be defined to help filter [template items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html) within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#filterFunction) */ filterFunction?: FilterFunction; /** * Text used to filter items. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#filterText) */ filterText?: string; /** * It is possible to group [template items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html). * * @default layer * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#groupBy) */ groupBy?: string | GroupByFunction; /** * Indicates the heading level to use for the labels of grouped feature templates. * * @default 4 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#headingLevel) */ headingLevel?: number; /** * An array of [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) to display within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#layers) */ layers?: ( | (FeatureLayerProperties & { type: "feature" }) | (GeoJSONLayerProperties & { type: "geojson" }) | (SceneLayerProperties & { type: "scene" }) | (SubtypeSublayerProperties & { type: "subtype-sublayer" }) | (SubtypeGroupLayerProperties & { type: "subtype-group" }) )[]; /** * Specifies the selection behavior of list items. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#selectionMode) */ selectionMode?: "single" | "none"; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#viewModel) */ viewModel?: FeatureTemplatesViewModelProperties; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#visibleElements) */ visibleElements?: FeatureTemplatesVisibleElements; } export interface FeatureTemplatesViewModel extends Accessor, Evented { } export class FeatureTemplatesViewModel { /** * Used to disable the associated user interface. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#disabled) */ disabled: boolean; /** * [Function](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#FilterFunction) can be defined to help filter [template items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html) within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#filterFunction) */ filterFunction: FilterFunction; /** * It is possible to group [template items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html). * * @default layer * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#groupBy) */ groupBy: string | GroupByFunction; /** * The template items or grouped template items. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#items) */ readonly items: TemplateItem[] | TemplateItemGroup[]; /** * An array of [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) that are associated with the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#layers) */ layers: (FeatureLayer | GeoJSONLayer | SceneLayer | SubtypeSublayer | SubtypeGroupLayer)[]; /** * The widget's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#state) */ readonly state: "ready" | "loading" | "disabled"; /** * Provides the logic for the [FeatureTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-FeatureTemplatesViewModel.html) */ constructor(properties?: FeatureTemplatesViewModelProperties); /** * This method updates the [template items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html) with the provided filter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#refresh) */ refresh(): void; /** * Selects the [template item](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html) to use. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#select) */ select(item: TemplateItem): void; on(name: "select", eventHandler: FeatureTemplatesViewModelSelectEventHandler): IHandle; } interface FeatureTemplatesViewModelProperties { /** * Used to disable the associated user interface. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#disabled) */ disabled?: boolean; /** * [Function](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#FilterFunction) can be defined to help filter [template items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html) within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#filterFunction) */ filterFunction?: FilterFunction; /** * It is possible to group [template items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html). * * @default layer * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#groupBy) */ groupBy?: string | GroupByFunction; /** * An array of [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) that are associated with the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#layers) */ layers?: ( | (FeatureLayerProperties & { type: "feature" }) | (GeoJSONLayerProperties & { type: "geojson" }) | (SceneLayerProperties & { type: "scene" }) | (SubtypeSublayerProperties & { type: "subtype-sublayer" }) | (SubtypeGroupLayerProperties & { type: "subtype-group" }) )[]; } export interface FeatureTemplatesViewModelSelectEvent { item: TemplateItem; template: FeatureTemplate; } export class TemplateItem extends Accessor { /** * The description that is displayed for the template item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html#description) */ description: string; /** * The label that is displayed for the template item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html#label) */ label: string; /** * The [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) associated with the template item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html#layer) */ layer: FeatureLayer; /** * The associated [FeatureTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html) for the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html#template) */ template: FeatureTemplate; /** * An object used to create a thumbnail image that represents a feature type in the feature template. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html#thumbnail) */ readonly thumbnail: HTMLElement; /** * The item displayed within the [FeatureTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html) */ constructor(properties?: TemplateItemProperties); /** * Creates a deep clone of the template item object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html#clone) */ clone(): TemplateItem; /** * Fetches the thumbnail used to display the template item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html#fetchThumbnail) */ static fetchThumbnail(): Promise; } interface TemplateItemProperties { /** * The description that is displayed for the template item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html#description) */ description?: string; /** * The label that is displayed for the template item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html#label) */ label?: string; /** * The [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) associated with the template item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html#layer) */ layer?: FeatureLayerProperties; /** * The associated [FeatureTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html) for the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html#template) */ template?: FeatureTemplateProperties; } export interface TemplateItemGroup extends Accessor, Identifiable { } export class TemplateItemGroup { /** * An array of [TemplateItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html) grouped to display in the [FeatureTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItemGroup.html#items) */ readonly items: TemplateItem[]; /** * The label displayed in the [FeatureTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html) widget indicating the grouped [TemplateItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItemGroup.html#label) */ readonly label: string; /** * This is a read-only support class that represents a group of items displayed within the [FeatureTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItemGroup.html) */ constructor(properties?: TemplateItemGroupProperties); } interface TemplateItemGroupProperties { } export type FilterFunction = (filterName: any) => boolean; export type GroupByFunction = (grouping: any) => string | any; export interface FeatureTemplatesSelectEvent { item: TemplateItem; template: FeatureTemplate; } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#VisibleElements) */ export interface FeatureTemplatesVisibleElements { /** * Indicates whether to the filter will be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#VisibleElements) */ filter?: boolean; } export class FloorFilter extends Widget { /** * The currently selected facility. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#facility) */ facility: string; /** * Indicates the heading level to use for the headings separating floors in buildings. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#headingLevel) */ headingLevel: number; /** * The currently selected floor level. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#level) */ level: string; /** * Determines if the widget is expanded or collapsed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#longNames) */ longNames: boolean; /** * The currently selected site. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#site) */ site: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#viewModel) */ viewModel: FloorFilterViewModel; /** * The FloorFilter widget simplifies visualization of GIS data for a specific floor of a building in your application. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html) */ constructor(properties?: FloorFilterProperties); /** * Updates the [floorFilter](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#FloorFilter) widget definition in the provided [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#updateWebDocument) */ updateWebDocument(webmap: WebMap): void; } interface FloorFilterProperties extends WidgetProperties { /** * The currently selected facility. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#facility) */ facility?: string; /** * Indicates the heading level to use for the headings separating floors in buildings. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#headingLevel) */ headingLevel?: number; /** * The currently selected floor level. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#level) */ level?: string; /** * Determines if the widget is expanded or collapsed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#longNames) */ longNames?: boolean; /** * The currently selected site. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#site) */ site?: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#viewModel) */ viewModel?: FloorFilterViewModelProperties; } export interface FloorFilterViewModel extends Accessor, GoTo { } export class FloorFilterViewModel { /** * The currently selected facility. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter-FloorFilterViewModel.html#facility) */ facility: string; /** * The currently selected level. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter-FloorFilterViewModel.html#level) */ level: string; /** * Determines if the widget is expanded or collapsed. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter-FloorFilterViewModel.html#longNames) */ longNames: boolean; /** * The currently selected site. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter-FloorFilterViewModel.html#site) */ site: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter-FloorFilterViewModel.html#view) */ view: MapView | SceneView; /** * Provides the logic for the [FloorFilter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter-FloorFilterViewModel.html) */ constructor(properties?: FloorFilterViewModelProperties); } interface FloorFilterViewModelProperties extends GoToProperties { /** * The currently selected facility. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter-FloorFilterViewModel.html#facility) */ facility?: string; /** * The currently selected level. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter-FloorFilterViewModel.html#level) */ level?: string; /** * Determines if the widget is expanded or collapsed. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter-FloorFilterViewModel.html#longNames) */ longNames?: boolean; /** * The currently selected site. * * @default undefined * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter-FloorFilterViewModel.html#site) */ site?: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter-FloorFilterViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } export class Fullscreen extends Widget { /** * The [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) to present in fullscreen mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen.html#element) */ element: HTMLElement; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen.html#viewModel) */ viewModel: FullscreenViewModel; /** * Provides a simple widget to present the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) or a user-defined [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) using the entire screen. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen.html) */ constructor(properties?: FullscreenProperties); } interface FullscreenProperties extends WidgetProperties { /** * The [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) to present in fullscreen mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen.html#element) */ element?: HTMLElement; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen.html#viewModel) */ viewModel?: FullscreenViewModelProperties; } export class FullscreenViewModel extends Accessor { /** * The [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) to present in fullscreen mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen-FullscreenViewModel.html#element) */ element: HTMLElement; /** * The view model's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen-FullscreenViewModel.html#state) */ readonly state: "active" | "ready" | "feature-unsupported" | "disabled"; /** * The view associated with the widget instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen-FullscreenViewModel.html#view) */ view: MapView | SceneView; /** * Provides the logic for the [Fullscreen](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen-FullscreenViewModel.html) */ constructor(properties?: FullscreenViewModelProperties); /** * Enter fullscreen * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen-FullscreenViewModel.html#enter) */ enter(): void; /** * Exit fullscreen * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen-FullscreenViewModel.html#exit) */ exit(): void; /** * Toggle fullscreen * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen-FullscreenViewModel.html#toggle) */ toggle(): void; } interface FullscreenViewModelProperties { /** * The [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) to present in fullscreen mode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen-FullscreenViewModel.html#element) */ element?: HTMLElement; /** * The view associated with the widget instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen-FullscreenViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } export class Histogram extends Widget { /** * The statistical average of the data in the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#average) */ average: number; /** * Function for styling bars representing histogram bins. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#barCreatedFunction) */ barCreatedFunction: BarCreatedFunction; /** * An array of objects representing each bin in the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#bins) */ bins: Bin[]; /** * Function that fires each time a data line is created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#dataLineCreatedFunction) */ dataLineCreatedFunction: DataLineCreatedFunction; /** * When set, renders lines on the histogram that indicate important or meaningful values to the end user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#dataLines) */ dataLines: HistogramDataLines[]; /** * A function used to format labels on the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#labelFormatFunction) */ labelFormatFunction: LabelFormatter; /** * Determines the orientation of the Histogram widget. * * @default horizontal * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#layout) */ layout: "vertical" | "horizontal"; /** * The maximum value or bound of the entire histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#max) */ max: number; /** * The minimum value or bound of the entire histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#min) */ min: number; /** * The state of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#state) */ readonly state: "ready" | "disabled"; /** * The view model for the Histogram widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#viewModel) */ viewModel: HistogramViewModel; /** * Renders a histogram to visualize the spread of a dataset based on [bins](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#bins) representing buckets, or sub-ranges, of data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html) */ constructor(properties?: HistogramProperties); /** * A convenience function used to create a Histogram widget instance from the result of the [histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html) statistics function. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#fromHistogramResult) */ static fromHistogramResult(result: HistogramResult): Histogram; } interface HistogramProperties extends WidgetProperties { /** * The statistical average of the data in the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#average) */ average?: number; /** * Function for styling bars representing histogram bins. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#barCreatedFunction) */ barCreatedFunction?: BarCreatedFunction; /** * An array of objects representing each bin in the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#bins) */ bins?: Bin[]; /** * Function that fires each time a data line is created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#dataLineCreatedFunction) */ dataLineCreatedFunction?: DataLineCreatedFunction; /** * When set, renders lines on the histogram that indicate important or meaningful values to the end user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#dataLines) */ dataLines?: HistogramDataLines[]; /** * A function used to format labels on the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#labelFormatFunction) */ labelFormatFunction?: LabelFormatter; /** * Determines the orientation of the Histogram widget. * * @default horizontal * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#layout) */ layout?: "vertical" | "horizontal"; /** * The maximum value or bound of the entire histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#max) */ max?: number; /** * The minimum value or bound of the entire histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#min) */ min?: number; /** * The view model for the Histogram widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#viewModel) */ viewModel?: HistogramViewModelProperties; } export class HistogramViewModel extends Accessor { /** * The statistical average of the data in the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram-HistogramViewModel.html#average) */ average: number; /** * The range of values for the histogram calculated from the bins. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram-HistogramViewModel.html#binRange) */ readonly binRange: number; /** * An array of objects representing each bin in the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram-HistogramViewModel.html#bins) */ bins: Bin[]; /** * A function used to format labels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram-HistogramViewModel.html#labelFormatFunction) */ labelFormatFunction: LabelFormatter; /** * The maximum value or bound of the entire histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram-HistogramViewModel.html#max) */ max: number; /** * The minimum value or bound of the entire histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram-HistogramViewModel.html#min) */ min: number; /** * The range of values for the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram-HistogramViewModel.html#range) */ readonly range: number; /** * The current state of the view model. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram-HistogramViewModel.html#state) */ readonly state: "ready" | "disabled"; /** * Provides the logic for the [Histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram-HistogramViewModel.html) */ constructor(properties?: HistogramViewModelProperties); } interface HistogramViewModelProperties { /** * The statistical average of the data in the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram-HistogramViewModel.html#average) */ average?: number; /** * An array of objects representing each bin in the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram-HistogramViewModel.html#bins) */ bins?: Bin[]; /** * A function used to format labels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram-HistogramViewModel.html#labelFormatFunction) */ labelFormatFunction?: LabelFormatter; /** * The maximum value or bound of the entire histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram-HistogramViewModel.html#max) */ max?: number; /** * The minimum value or bound of the entire histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram-HistogramViewModel.html#min) */ min?: number; } export type BarCreatedFunction = (index: number, element: any) => void; /** * Represents the bin of a histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#Bin) */ export interface Bin { /** * The number of values in a dataset that are contained between the indicated `minValue` and `maxValue`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#Bin) */ count: number; /** * The minimum value (or bound) of the bin. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#Bin) */ minValue: number; /** * The maximum value (or bound) of the bin. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#Bin) */ maxValue: number; } export type DataLineCreatedFunction = (lineElement: any, labelElement?: any, index?: number) => void; export interface HistogramDataLines { /** * The value on the data axis of the histogram where a line will be rendered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#dataLines) */ value: number; /** * The label associated with the line. * * [Read more...](global.html) */ label?: string | number; } export type LabelFormatter = (value: number, type?: string, index?: number) => string; export class HistogramRangeSlider extends Widget { /** * The statistical average of the data in the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#average) */ average: number; /** * Function for styling bars representing histogram bins. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#barCreatedFunction) */ barCreatedFunction: BarCreatedFunction; /** * An array of objects representing each bin in the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#bins) */ bins: Bin[]; /** * Function that fires each time a data line is created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#dataLineCreatedFunction) */ dataLineCreatedFunction: DataLineCreatedFunction; /** * When set, renders lines on the histogram that indicate important or meaningful values to the end user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#dataLines) */ dataLines: HistogramRangeSliderDataLines[]; /** * Sets the color of the histogram bars that are excluded based on the specified [rangeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType). * * @default #d7e5f0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#excludedBarColor) */ excludedBarColor: Color; /** * Sets the color of the histogram bars that are included in the specified [rangeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType). * * @default #599dd4 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#includedBarColor) */ includedBarColor: Color; /** * A function used to format labels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#labelFormatFunction) */ labelFormatFunction: SliderLabelFormatter; /** * The maximum value or upper bound of the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#max) */ max: number; /** * The minimum value or lower bound of the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#min) */ min: number; /** * Defines how slider thumb values should be rounded. * * @default 4 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#precision) */ precision: number; /** * Indicates how the histogram bins should be rendered as the user slides the thumbs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType) */ rangeType: | "equal" | "not-equal" | "less-than" | "greater-than" | "at-most" | "at-least" | "between" | "not-between"; /** * Indicates the standard deviation of the dataset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#standardDeviation) */ standardDeviation: number; /** * Indicates the number of standard deviation lines to render on the histogram from the [average]. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#standardDeviationCount) */ standardDeviationCount: number; /** * An array of either one or two numbers representing thumb positions on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#values) */ values: number[]; /** * The view model for the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#viewModel) */ viewModel: HistogramRangeSliderViewModel; /** * A slider widget that can be used for filtering data or gathering numeric input from a user for a range of data. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html) */ constructor(properties?: HistogramRangeSliderProperties); /** * Generates a SQL where clause based on a given field and the slider's [rangeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#generateWhereClause) */ generateWhereClause(field: string): string; on(name: "max-change", eventHandler: HistogramRangeSliderMaxChangeEventHandler): IHandle; on(name: "min-change", eventHandler: HistogramRangeSliderMinChangeEventHandler): IHandle; on(name: "segment-drag", eventHandler: HistogramRangeSliderSegmentDragEventHandler): IHandle; on(name: "thumb-change", eventHandler: HistogramRangeSliderThumbChangeEventHandler): IHandle; on(name: "thumb-drag", eventHandler: HistogramRangeSliderThumbDragEventHandler): IHandle; } interface HistogramRangeSliderProperties extends WidgetProperties { /** * The statistical average of the data in the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#average) */ average?: number; /** * Function for styling bars representing histogram bins. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#barCreatedFunction) */ barCreatedFunction?: BarCreatedFunction; /** * An array of objects representing each bin in the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#bins) */ bins?: Bin[]; /** * Function that fires each time a data line is created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#dataLineCreatedFunction) */ dataLineCreatedFunction?: DataLineCreatedFunction; /** * When set, renders lines on the histogram that indicate important or meaningful values to the end user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#dataLines) */ dataLines?: HistogramRangeSliderDataLines[]; /** * Sets the color of the histogram bars that are excluded based on the specified [rangeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType). * * @default #d7e5f0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#excludedBarColor) */ excludedBarColor?: Color | number[] | string; /** * Sets the color of the histogram bars that are included in the specified [rangeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType). * * @default #599dd4 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#includedBarColor) */ includedBarColor?: Color | number[] | string; /** * A function used to format labels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#labelFormatFunction) */ labelFormatFunction?: SliderLabelFormatter; /** * The maximum value or upper bound of the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#max) */ max?: number; /** * The minimum value or lower bound of the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#min) */ min?: number; /** * Defines how slider thumb values should be rounded. * * @default 4 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#precision) */ precision?: number; /** * Indicates how the histogram bins should be rendered as the user slides the thumbs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType) */ rangeType?: | "equal" | "not-equal" | "less-than" | "greater-than" | "at-most" | "at-least" | "between" | "not-between"; /** * Indicates the standard deviation of the dataset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#standardDeviation) */ standardDeviation?: number; /** * Indicates the number of standard deviation lines to render on the histogram from the [average]. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#standardDeviationCount) */ standardDeviationCount?: number; /** * An array of either one or two numbers representing thumb positions on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#values) */ values?: number[]; /** * The view model for the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#viewModel) */ viewModel?: HistogramRangeSliderViewModelProperties; } export class HistogramRangeSliderViewModel extends SliderViewModel { /** * The statistical average of the data in the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#average) */ average: number; /** * An array of objects representing each bin in the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#bins) */ bins: Bin[]; /** * Determines the SQL where clause generated in [generateWhereClause()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#generateWhereClause) for filtering purposes. * * @default equal * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#rangeType) */ rangeType: | "equal" | "not-equal" | "less-than" | "greater-than" | "at-most" | "at-least" | "between" | "not-between"; /** * Indicates the standard deviation of the dataset above and below the `average`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#standardDeviation) */ standardDeviation: number; /** * Provides the logic for the [HistogramRangeSlider](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html) */ constructor(properties?: HistogramRangeSliderViewModelProperties); /** * Generates a SQL where clause based on a given field and the slider's [rangeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#rangeType). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#generateWhereClause) */ generateWhereClause(field: string): string; } interface HistogramRangeSliderViewModelProperties extends SliderViewModelProperties { /** * The statistical average of the data in the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#average) */ average?: number; /** * An array of objects representing each bin in the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#bins) */ bins?: Bin[]; /** * Determines the SQL where clause generated in [generateWhereClause()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#generateWhereClause) for filtering purposes. * * @default equal * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#rangeType) */ rangeType?: | "equal" | "not-equal" | "less-than" | "greater-than" | "at-most" | "at-least" | "between" | "not-between"; /** * Indicates the standard deviation of the dataset above and below the `average`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#standardDeviation) */ standardDeviation?: number; } export interface HistogramRangeSliderDataLines { /** * The value on the data axis of the histogram where a line will be rendered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#dataLines) */ value: number; /** * The label associated with the line. * * [Read more...](global.html) */ label?: string | number; } export interface HistogramRangeSliderMaxChangeEvent { oldValue: number; type: "max-change"; value: number; } export interface HistogramRangeSliderMinChangeEvent { oldValue: number; type: "min-change"; value: number; } export interface HistogramRangeSliderSegmentDragEvent { index: number; state: "start" | "drag"; thumbIndices: number[]; type: "segment-drag"; } export interface HistogramRangeSliderThumbChangeEvent { index: number; oldValue: number; type: "thumb-change"; value: number; } export interface HistogramRangeSliderThumbDragEvent { index: number; state: "start" | "drag"; type: "thumb-drag"; value: number; } export interface Home extends Widget, GoTo { } export class Home { /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/DirectionPad#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#iconClass) */ iconClass: string; /** * Overwrite localized strings for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#uiStrings) */ uiStrings: any; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#viewModel) */ viewModel: HomeViewModel; /** * The [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html), or point of view, to zoom to when going home. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#viewpoint) */ viewpoint: Viewpoint; /** * Provides a simple widget that switches the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) to its initial [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) or a previously defined [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#viewpoint). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html) */ constructor(properties?: HomeProperties); /** * This function provides the ability to interrupt and cancel the process of navigating the view back to the view's initial extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#cancelGo) */ cancelGo(): void; /** * Animates the view to the initial Viewpoint of the view or the value of [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#viewpoint). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#go) */ go(): void; on(name: "go", eventHandler: HomeGoEventHandler): IHandle; } interface HomeProperties extends WidgetProperties, GoToProperties { /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/DirectionPad#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#iconClass) */ iconClass?: string; /** * Overwrite localized strings for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#uiStrings) */ uiStrings?: any; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#viewModel) */ viewModel?: HomeViewModelProperties; /** * The [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html), or point of view, to zoom to when going home. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#viewpoint) */ viewpoint?: ViewpointProperties; } export interface HomeViewModel extends Accessor, Evented, GoTo { } export class HomeViewModel { /** * The current state of the widget. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html#state) */ readonly state: "disabled" | "ready" | "going-home"; /** * The view associated with the widget instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html#view) */ view: MapView | SceneView; /** * The [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html), or point of view, to zoom to when going home. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html#viewpoint) */ viewpoint: Viewpoint; /** * Provides the logic for the [Home](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html) widget that animates the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) to its initial [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) or a previously defined [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html#viewpoint). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html) */ constructor(properties?: HomeViewModelProperties); /** * This function provides the ability to interrupt and cancel the process of navigating the view back to the view's initial extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html#cancelGo) */ cancelGo(): void; /** * Animates the view to the initial [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) of the view or the value of [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html#viewpoint). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html#go) */ go(): void; on(name: "go", eventHandler: HomeViewModelGoEventHandler): IHandle; } interface HomeViewModelProperties extends GoToProperties { /** * The view associated with the widget instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html), or point of view, to zoom to when going home. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html#viewpoint) */ viewpoint?: ViewpointProperties; } export interface HomeViewModelGoEvent { } export interface HomeGoEvent { } export class LayerList extends Widget { /** * Indicates whether the widget is collapsed. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#collapsed) */ collapsed: boolean; /** * Indicates whether [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) may be reordered within the list by dragging and dropping. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#dragEnabled) */ dragEnabled: boolean; /** * Placeholder text used in the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#visibleElements) is true. * * @default "" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#filterPlaceholder) */ filterPlaceholder: string; /** * The value of the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#visibleElements) is true. * * @default "" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#filterText) */ filterText: string; /** * Indicates the heading level to use for the heading of the widget. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#headingLevel) */ headingLevel: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/LayerList#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#iconClass) */ iconClass: string; /** * A function that executes each time a [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) is created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#listItemCreatedFunction) */ listItemCreatedFunction: LayerListListItemCreatedHandler; /** * The minimum number of list items required to enable drag and drop reordering with [dragEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#dragEnabled). * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#minDragEnabledItems) */ minDragEnabledItems: number; /** * The minimum number of list items required to display the visibleElements.filter input box. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#minFilterItems) */ minFilterItems: number; /** * Indicates whether more than one list item may be selected by the user at a single time. * * @default false * @deprecated since 4.29. Use {@link module:esri/widgets/LayerList#selectionMode selectionMode} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#multipleSelectionEnabled) */ multipleSelectionEnabled: boolean; /** * A collection of [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html)s representing operational layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#operationalItems) */ readonly operationalItems: Collection; /** * A collection of selected [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html)s representing operational layers selected by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#selectedItems) */ selectedItems: Collection; /** * Indicates whether list items may be selected by the user. * * @default false * @deprecated since 4.29. Use {@link module:esri/widgets/LayerList#selectionMode selectionMode} and {@link module:esri/widgets/LayerList#dragEnabled dragEnabled} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#selectionEnabled) */ selectionEnabled: boolean; /** * Specifies the selection mode. * * @default "none" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#selectionMode) */ selectionMode: "multiple" | "none" | "single" | "single-persist"; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#viewModel) */ viewModel: LayerListViewModel; /** * Determines the icons used to indicate visibility. * * @default "default" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#visibilityAppearance) */ visibilityAppearance: "default" | "checkbox"; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#visibleElements) */ visibleElements: LayerListVisibleElements; /** * The LayerList widget provides a way to display a list of layers, and switch on/off their visibility. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) */ constructor(properties?: LayerListProperties); /** * Triggers the [trigger-action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#event-trigger-action) event and executes the given [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [action toggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#triggerAction) */ triggerAction(action: ActionButton | ActionToggle, item: ListItem): void; on(name: "trigger-action", eventHandler: LayerListTriggerActionEventHandler): IHandle; } interface LayerListProperties extends WidgetProperties { /** * Indicates whether the widget is collapsed. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#collapsed) */ collapsed?: boolean; /** * Indicates whether [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) may be reordered within the list by dragging and dropping. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#dragEnabled) */ dragEnabled?: boolean; /** * Placeholder text used in the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#visibleElements) is true. * * @default "" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#filterPlaceholder) */ filterPlaceholder?: string; /** * The value of the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#visibleElements) is true. * * @default "" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#filterText) */ filterText?: string; /** * Indicates the heading level to use for the heading of the widget. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#headingLevel) */ headingLevel?: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/LayerList#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#iconClass) */ iconClass?: string; /** * A function that executes each time a [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) is created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#listItemCreatedFunction) */ listItemCreatedFunction?: LayerListListItemCreatedHandler; /** * The minimum number of list items required to enable drag and drop reordering with [dragEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#dragEnabled). * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#minDragEnabledItems) */ minDragEnabledItems?: number; /** * The minimum number of list items required to display the visibleElements.filter input box. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#minFilterItems) */ minFilterItems?: number; /** * Indicates whether more than one list item may be selected by the user at a single time. * * @default false * @deprecated since 4.29. Use {@link module:esri/widgets/LayerList#selectionMode selectionMode} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#multipleSelectionEnabled) */ multipleSelectionEnabled?: boolean; /** * A collection of selected [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html)s representing operational layers selected by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#selectedItems) */ selectedItems?: CollectionProperties; /** * Indicates whether list items may be selected by the user. * * @default false * @deprecated since 4.29. Use {@link module:esri/widgets/LayerList#selectionMode selectionMode} and {@link module:esri/widgets/LayerList#dragEnabled dragEnabled} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#selectionEnabled) */ selectionEnabled?: boolean; /** * Specifies the selection mode. * * @default "none" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#selectionMode) */ selectionMode?: "multiple" | "none" | "single" | "single-persist"; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#viewModel) */ viewModel?: LayerListViewModelProperties; /** * Determines the icons used to indicate visibility. * * @default "default" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#visibilityAppearance) */ visibilityAppearance?: "default" | "checkbox"; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#visibleElements) */ visibleElements?: LayerListVisibleElements; } export class LayerListViewModel extends Accessor { /** * Whether to provide an indication if a layer is being published in the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html#checkPublishStatusEnabled) */ checkPublishStatusEnabled: boolean; /** * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html#listItemCreatedFunction) */ listItemCreatedFunction: LayerListListItemCreatedHandler; /** * A collection of [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html)s representing operational layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html#operationalItems) */ readonly operationalItems: Collection; /** * The view model's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html#state) */ readonly state: "loading" | "ready" | "disabled"; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html#view) */ view: MapView | SceneView; /** * Provides the logic for the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html) */ constructor(properties?: LayerListViewModelProperties); /** * Moves a list item from one position to another in the LayerList widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html#moveListItem) */ moveListItem(targetItem: ListItem, fromParentItem: ListItem, toParentItem: ListItem, newIndex: number): void; /** * Triggers the [trigger-action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html#event-trigger-action) event and executes the given [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [action toggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html#triggerAction) */ triggerAction(action: ActionButton | ActionToggle, item: ListItem): void; on(name: "trigger-action", eventHandler: LayerListViewModelTriggerActionEventHandler): IHandle; } interface LayerListViewModelProperties { /** * Whether to provide an indication if a layer is being published in the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html#checkPublishStatusEnabled) */ checkPublishStatusEnabled?: boolean; /** * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html#listItemCreatedFunction) */ listItemCreatedFunction?: LayerListListItemCreatedHandler; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } export interface LayerListViewModelTriggerActionEvent { action: ActionButton | ActionToggle; item: ListItem; } export interface ListItem extends Accessor, Identifiable { } export class ListItem { /** * Whether the actions panel is open in the LayerList. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#actionsOpen) */ actionsOpen: boolean; /** * A nested 2-dimensional collection of actions that could be triggered on the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#actionsSections) */ actionsSections: Collection>; /** * When a layer contains sublayers, this property is a Collection of ListItem objects belonging to the given layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#children) */ children: Collection; /** * Indicates if the children of a list item (or sublayers in a GroupLayer) can be sorted or moved/reordered. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#childrenSortable) */ childrenSortable: boolean; /** * Only valid when the list item represents a [StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#connectionStatus) */ readonly connectionStatus: "connected" | "disconnected" | "paused"; /** * The Error object returned if an error occurred. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#error) */ readonly error: Error; /** * When `true`, hides the layer from the LayerList instance. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#hidden) */ hidden: boolean; /** * The layer associated with the triggered action. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#layer) */ layer: Layer; /** * The [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) displaying data for the associated [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#layer). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#layerView) */ readonly layerView: LayerView; /** * Whether the layer is open in the LayerList. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#open) */ open: boolean; /** * Allows you to display custom content for each ListItem in the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#panel) */ panel: ListItemPanel; /** * The parent of this item * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#parent) */ parent: ListItem; /** * Value is `true` when the [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#layer) is being published. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#publishing) */ readonly publishing: boolean; /** * Indicates if the list item (or layer in the map) can be sorted or moved/reordered. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#sortable) */ sortable: boolean; /** * The title of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#title) */ title: string; /** * Value is `true` when the layer is updating; for example, if it is in the process of fetching data. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#updating) */ readonly updating: boolean; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#view) */ view: MapView | SceneView; /** * Indicates how to manage the visibility of the children layers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#visibilityMode) */ readonly visibilityMode: string; /** * Indicates if the ListItem is visible. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#visible) */ visible: boolean; /** * Whether the layer is visible at the current scale or not. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#visibleAtCurrentScale) */ readonly visibleAtCurrentScale: boolean; /** * The ListItem class represents one of the [operationalItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html#operationalItems) in the [LayerListViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) */ constructor(properties?: ListItemProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#clone) */ clone(): ListItem; } interface ListItemProperties { /** * Whether the actions panel is open in the LayerList. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#actionsOpen) */ actionsOpen?: boolean; /** * A nested 2-dimensional collection of actions that could be triggered on the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#actionsSections) */ actionsSections?: | CollectionProperties< CollectionProperties< (ActionButtonProperties & { type: "button" }) | (ActionToggleProperties & { type: "toggle" }) > > | any[][]; /** * When a layer contains sublayers, this property is a Collection of ListItem objects belonging to the given layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#children) */ children?: CollectionProperties; /** * Indicates if the children of a list item (or sublayers in a GroupLayer) can be sorted or moved/reordered. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#childrenSortable) */ childrenSortable?: boolean; /** * When `true`, hides the layer from the LayerList instance. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#hidden) */ hidden?: boolean; /** * The layer associated with the triggered action. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#layer) */ layer?: LayerProperties; /** * Whether the layer is open in the LayerList. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#open) */ open?: boolean; /** * Allows you to display custom content for each ListItem in the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#panel) */ panel?: ListItemPanelProperties; /** * The parent of this item * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#parent) */ parent?: ListItemProperties; /** * Indicates if the list item (or layer in the map) can be sorted or moved/reordered. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#sortable) */ sortable?: boolean; /** * The title of the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#title) */ title?: string; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * Indicates if the ListItem is visible. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#visible) */ visible?: boolean; } export interface ListItemPanel extends Widget, Identifiable { } export class ListItemPanel { /** * Adds a CSS class used to style a node that represents the panel. * * @default esri-icon-layer-list * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#className) */ className: string; /** * The content displayed in the ListItem panel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#content) */ content: Widget | HTMLElement | string | any[]; /** * If `true`, disables the ListItem's panel so the user cannot open or interact with it. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#disabled) */ disabled: boolean; /** * Indicates whether the panel's content should be rendered as a [Calcite Flow Item](https://developers.arcgis.com/calcite-design-system/components/flow-item/). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#flowEnabled) */ flowEnabled: boolean; /** * The URL or data URI of an image used to represent the panel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#image) */ image: string; /** * The panel's parent ListItem that represents a layer in the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#listItem) */ listItem: ListItem; /** * Indicates if the panel's content is open and visible to the user. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#open) */ open: boolean; /** * The title of the panel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#title) */ title: string; /** * This class allows you to display custom content for each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) in the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html) */ constructor(properties?: ListItemPanelProperties); } interface ListItemPanelProperties extends WidgetProperties { /** * Adds a CSS class used to style a node that represents the panel. * * @default esri-icon-layer-list * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#className) */ className?: string; /** * The content displayed in the ListItem panel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#content) */ content?: WidgetProperties | HTMLElement | string | any[]; /** * If `true`, disables the ListItem's panel so the user cannot open or interact with it. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#disabled) */ disabled?: boolean; /** * Indicates whether the panel's content should be rendered as a [Calcite Flow Item](https://developers.arcgis.com/calcite-design-system/components/flow-item/). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#flowEnabled) */ flowEnabled?: boolean; /** * The URL or data URI of an image used to represent the panel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#image) */ image?: string; /** * The panel's parent ListItem that represents a layer in the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#listItem) */ listItem?: ListItemProperties; /** * Indicates if the panel's content is open and visible to the user. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#open) */ open?: boolean; /** * The title of the panel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#title) */ title?: string; } export type LayerListListItemCreatedHandler = (event: any) => void; export interface LayerListTriggerActionEvent { action: ActionButton | ActionToggle; item: ListItem; } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#VisibleElements) */ export interface LayerListVisibleElements { /** * **Since 4.29** Indicates whether to display a close button in the header. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#VisibleElements) */ closeButton?: boolean; /** * **Since 4.29** Indicates whether to display a collapse button in the header. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#VisibleElements) */ collapseButton?: boolean; /** * **Since 4.25** Indicates whether layer load errors will be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#VisibleElements) */ errors?: boolean; /** * **Since 4.29** Indicates whether to display a filter input box when then number of list items is equal to or greater than the value set in [minFilterItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#minFilterItems), allowing users to filter layers by their title. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#VisibleElements) */ filter?: boolean; /** * **Since 4.29** Determines whether the widget should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#VisibleElements) */ flow?: boolean; /** * **Since 4.29** Indicates whether to display the widget heading. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#VisibleElements) */ heading?: boolean; /** * Indicates whether the status indicators will be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#VisibleElements) */ statusIndicators?: boolean; /** * **Since 4.29** Indicates whether temporary layer indicators will be displayed for layers with [layer.persistenceEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#persistenceEnabled) set to `false`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#VisibleElements) */ temporaryLayerIndicators?: boolean; } export class Legend extends Widget { /** * Collection of [ActiveLayerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html) objects used by the legend view to display data in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#activeLayerInfos) */ activeLayerInfos: Collection; /** * Indicates whether to show the [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) layers in the Legend. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#basemapLegendVisible) */ basemapLegendVisible: boolean; /** * Indicates the heading level to use for the legend title. * * @default 3 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#headingLevel) */ headingLevel: number; /** * When `true`, layers will only be shown in the legend if they are visible in the view's extent. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#hideLayersNotInCurrentView) */ hideLayersNotInCurrentView: boolean; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Legend#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#iconClass) */ iconClass: string; /** * Specifies a subset of the layers to display in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#layerInfos) */ layerInfos: LegendLayerInfos[]; /** * Determines whether to respect the properties of the layers in the map that control the legend's visibility (`minScale`, `maxScale`, `legendEnabled`). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#respectLayerVisibility) */ respectLayerVisibility: boolean; /** * Indicates the style of the legend. * * @default classic * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#style) */ style: string | LegendStyle; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#viewModel) */ viewModel: LegendViewModel; /** * The Legend widget describes the symbols used to represent layers in a map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) */ constructor(properties?: LegendProperties); } interface LegendProperties extends WidgetProperties { /** * Collection of [ActiveLayerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html) objects used by the legend view to display data in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#activeLayerInfos) */ activeLayerInfos?: CollectionProperties; /** * Indicates whether to show the [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) layers in the Legend. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#basemapLegendVisible) */ basemapLegendVisible?: boolean; /** * Indicates the heading level to use for the legend title. * * @default 3 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#headingLevel) */ headingLevel?: number; /** * When `true`, layers will only be shown in the legend if they are visible in the view's extent. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#hideLayersNotInCurrentView) */ hideLayersNotInCurrentView?: boolean; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Legend#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#iconClass) */ iconClass?: string; /** * Specifies a subset of the layers to display in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#layerInfos) */ layerInfos?: LegendLayerInfos[]; /** * Determines whether to respect the properties of the layers in the map that control the legend's visibility (`minScale`, `maxScale`, `legendEnabled`). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#respectLayerVisibility) */ respectLayerVisibility?: boolean; /** * Indicates the style of the legend. * * @default classic * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#style) */ style?: string | LegendStyle; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#viewModel) */ viewModel?: LegendViewModelProperties; } export class LegendViewModel extends Accessor { /** * Collection of [ActiveLayerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html) objects used by the legend view to display data in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-LegendViewModel.html#activeLayerInfos) */ activeLayerInfos: Collection; /** * Indicates whether to show the [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) layers in the Legend. * * @default filterBasemaps * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-LegendViewModel.html#basemapLegendVisible) */ basemapLegendVisible: boolean; /** * When `true`, layers will only be shown in the legend if they are visible in the view's extent. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-LegendViewModel.html#hideLayersNotInCurrentView) */ hideLayersNotInCurrentView: boolean; /** * Specifies a subset of the layers in the map to display in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-LegendViewModel.html#layerInfos) */ layerInfos: LegendViewModelLayerInfos[]; /** * Determines whether to respect the properties of the layers in the map that control the legend's visibility (`minScale`, `maxScale`, `legendEnabled`). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-LegendViewModel.html#respectLayerVisibility) */ respectLayerVisibility: boolean; /** * The view model's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-LegendViewModel.html#state) */ readonly state: "ready" | "disabled"; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-LegendViewModel.html#view) */ view: MapView | SceneView; /** * Provides the logic for the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget, which displays a label and symbol for interpreting the [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) of each layer in a map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-LegendViewModel.html) */ constructor(properties?: LegendViewModelProperties); } interface LegendViewModelProperties { /** * Collection of [ActiveLayerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html) objects used by the legend view to display data in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-LegendViewModel.html#activeLayerInfos) */ activeLayerInfos?: CollectionProperties; /** * Indicates whether to show the [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) layers in the Legend. * * @default filterBasemaps * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-LegendViewModel.html#basemapLegendVisible) */ basemapLegendVisible?: boolean; /** * When `true`, layers will only be shown in the legend if they are visible in the view's extent. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-LegendViewModel.html#hideLayersNotInCurrentView) */ hideLayersNotInCurrentView?: boolean; /** * Specifies a subset of the layers in the map to display in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-LegendViewModel.html#layerInfos) */ layerInfos?: LegendViewModelLayerInfos[]; /** * Determines whether to respect the properties of the layers in the map that control the legend's visibility (`minScale`, `maxScale`, `legendEnabled`). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-LegendViewModel.html#respectLayerVisibility) */ respectLayerVisibility?: boolean; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-LegendViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } export interface LegendViewModelLayerInfos { /** * Specify a title for the layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-LegendViewModel.html#layerInfos) */ title?: string; /** * A layer to add to the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-LegendViewModel.html#layerInfos) */ layer?: Layer; } export class ActiveLayerInfo extends Accessor { /** * A collection of child activeLayerInfos. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#children) */ children: Collection; /** * When `true`, layers will only be shown in the legend if they are visible in the view's extent. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#hideLayersNotInCurrentView) */ hideLayersNotInCurrentView: boolean; /** * Indicates if the legend's display of the layer's renderer is driven by the scale of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#isScaleDriven) */ isScaleDriven: boolean; /** * The layer represented by the ActiveLayerInfo object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#layer) */ layer: Layer; /** * The layerView represented by the ActiveLayerInfo object's layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#layerView) */ layerView: LayerView; /** * The legendElements is constructed using the layer [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#legendElements) */ legendElements: LegendElement[]; /** * The opacity of the layer or parent element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#opacity) */ readonly opacity: number; /** * The ActiveLayerInfo of the parent module:esri/layers/support/ISublayer or [GroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#parent) */ parent: ActiveLayerInfo; /** * Indicates if the activeLayerInfo is ready. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#ready) */ ready: boolean; /** * Determines whether to respect the properties of the layers in the map that control the legend's visibility (`minScale`, `maxScale`, `legendEnabled`). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#respectLayerVisibility) */ respectLayerVisibility: boolean; /** * The scale of the view instance in which the Legend is rendered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#scale) */ scale: number; /** * Only applies if the [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#layer) is a [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#sublayerIds) */ sublayerIds: number[]; /** * The text string that represents the legend's title. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#title) */ title: string; /** * The version of the ActiveLayerInfo. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#version) */ version: number; /** * The view in which the Legend is rendered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#view) */ view: View; /** * ActiveLayerInfo is added to or removed from the collection of activeLayerInfos as layers become visible or invisible in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html) */ constructor(properties?: ActiveLayerInfoProperties); } interface ActiveLayerInfoProperties { /** * A collection of child activeLayerInfos. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#children) */ children?: CollectionProperties; /** * When `true`, layers will only be shown in the legend if they are visible in the view's extent. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#hideLayersNotInCurrentView) */ hideLayersNotInCurrentView?: boolean; /** * Indicates if the legend's display of the layer's renderer is driven by the scale of the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#isScaleDriven) */ isScaleDriven?: boolean; /** * The layer represented by the ActiveLayerInfo object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#layer) */ layer?: LayerProperties; /** * The layerView represented by the ActiveLayerInfo object's layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#layerView) */ layerView?: LayerViewProperties; /** * The legendElements is constructed using the layer [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#legendElements) */ legendElements?: ( | SymbolTableElement | ColorRampElement | OpacityRampElement | SizeRampElement | HeatmapRampElement | RelationshipRampElement )[]; /** * The ActiveLayerInfo of the parent module:esri/layers/support/ISublayer or [GroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#parent) */ parent?: ActiveLayerInfoProperties; /** * Indicates if the activeLayerInfo is ready. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#ready) */ ready?: boolean; /** * Determines whether to respect the properties of the layers in the map that control the legend's visibility (`minScale`, `maxScale`, `legendEnabled`). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#respectLayerVisibility) */ respectLayerVisibility?: boolean; /** * The scale of the view instance in which the Legend is rendered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#scale) */ scale?: number; /** * Only applies if the [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#layer) is a [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#sublayerIds) */ sublayerIds?: number[]; /** * The text string that represents the legend's title. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#title) */ title?: string; /** * The version of the ActiveLayerInfo. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#version) */ version?: number; /** * The view in which the Legend is rendered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#view) */ view?: ViewProperties; } /** * Describes the schema of the ColorRampElement used as a [legendElement](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#legendElement). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#ColorRampElement) */ export interface ColorRampElement { /** * The type of this element is always `color-ramp`. * * [Read more...](global.html#type) */ type: string; /** * The title of the color ramp as displayed in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#ColorRampElement) */ title: string | RampTitle; /** * The individual color stops rendered in the legend that correspond to the color visual variable in the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#ColorRampElement) */ infos: ColorRampStop[]; } /** * Describes the schema of the ColorRampStop element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#ColorRampStop) */ export interface ColorRampStop { /** * The label in the legend describing features with the given `color` and `value`. * * [Read more...](global.html) */ label: string; /** * The value of the color visual variable [stop](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html#stops). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#ColorRampStop) */ value: number; /** * The color of the visual variable [stop](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html#stops). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#ColorRampStop) */ color: Color; /** * A number between `0` and `1` describing the position of the label on the color ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#ColorRampStop) */ offset: number; } /** * Describes the schema of the HeatmapRampElement used as a [legendElement](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#legendElement). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#HeatmapRampElement) */ export interface HeatmapRampElement { /** * The type of this element is always `heatmap-ramp`. * * [Read more...](global.html#type) */ type: string; /** * The title of the heatmap ramp as displayed in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#HeatmapRampElement) */ title?: string | RampTitle; /** * The individual color stops rendered in the legend that correspond to the heatmap colorStops in the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#HeatmapRampElement) */ infos: HeatmapRampStop[]; } /** * Describes the schema of the HeatmapRampStop element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#HeatmapRampStop) */ export interface HeatmapRampStop { /** * The label of the color stop displayed in the legend. * * [Read more...](global.html) */ label: string; /** * The ratio of a pixel's intensity value to the minPixelIntensity of the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#HeatmapRampStop) */ ratio: number; /** * The color of the pixel corresponding to the appropriate pixel `ratio`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#HeatmapRampStop) */ color: Color; /** * A number between `0` and `1` describing the position of the label on the ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#HeatmapRampStop) */ offset: number; } /** * Properties defining the scheme of each of the ImageSymbolTableElementInfo. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#ImageSymbolTableElementInfo) */ export interface ImageSymbolTableElementInfo { /** * The label of the category corresponding to the given image. * * [Read more...](global.html) */ label?: string; /** * The data URI of the image representing a colored pixel in the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#ImageSymbolTableElementInfo) */ src: string; /** * The opacity of the image (`0` to `1`). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#ImageSymbolTableElementInfo) */ opacity: number; /** * The width of the image in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#ImageSymbolTableElementInfo) */ width?: number; /** * The height of the image in pixels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#ImageSymbolTableElementInfo) */ height?: number; } /** * Properties defining the scheme of each of the supported [legendElements](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#legendElements). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#LegendElement) */ export type LegendElement = | SymbolTableElement | ColorRampElement | OpacityRampElement | SizeRampElement | HeatmapRampElement | RelationshipRampElement; /** * Describes the schema of the OpacityRampElement used as a [legendElement](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#legendElement). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#OpacityRampElement) */ export interface OpacityRampElement { /** * The type of this element is always `opacity-ramp`. * * [Read more...](global.html#type) */ type: string; /** * The title of the opacity ramp as displayed in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#OpacityRampElement) */ title?: string | RampTitle; /** * The individual opacity stops rendered in the legend that correspond to the opacity visual variable in the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#OpacityRampElement) */ infos: OpacityRampStop[]; } /** * Describes the schema of the OpacityRampStop element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#OpacityRampStop) */ export interface OpacityRampStop { /** * The label in the legend describing features with the given `color` and `value`. * * [Read more...](global.html) */ label: string; /** * The value of the opacity visual variable [stop](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-OpacityVariable.html#stops). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#OpacityRampStop) */ value: number; /** * The color of the visual variable [stop](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-OpacityVariable.html#stops). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#OpacityRampStop) */ color: Color; /** * A number between `0` and `1` describing the position of the label on the ramp. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#OpacityRampStop) */ offset: number; } /** * Describes the schema of the RampTitle element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RampTitle) */ export interface RampTitle { /** * The field name used in a visual variable of a renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RampTitle) */ field: string; /** * If provided, the normalization field name used in a visual variable of a renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RampTitle) */ normField: string; /** * If `true`, the legend formats to display the field and normalization field as a ratio. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RampTitle) */ ratio: boolean; /** * If `true`, the legend formats to display the field and normalization field as a percentage. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RampTitle) */ ratioPercent: boolean; /** * If `true`, the legend formats to display the field and normalization field as a percentage of total. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RampTitle) */ ratioPercentTotal: boolean; } /** * Describes the schema of the RelationshipLabels element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RelationshipLabels) */ export interface RelationshipLabels { /** * The label corresponding with the top corner of the legend if the focus is set to `HH`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RelationshipLabels) */ top: string; /** * The label corresponding with the bottom corner of the legend if the focus is set to `HH`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RelationshipLabels) */ bottom: string; /** * The label corresponding with the left corner of the legend (if the focus is set to `HH`). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RelationshipLabels) */ left: string; /** * The label corresponding with the right corner of the legend (if the focus is set to `HH`). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RelationshipLabels) */ right: string; } /** * Describes the schema of the RelationshipRampElement used as a [legendElement](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#legendElement). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RelationshipRampElement) */ export interface RelationshipRampElement { /** * The type of this element is always `relationship-ramp`. * * [Read more...](global.html#type) */ type: string; /** * The number of classes for each field comprising the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RelationshipRampElement) */ numClasses: number; /** * Determines the orientation of the Legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RelationshipRampElement) */ focus: string; /** * A 2-dimensional array of colors as displayed in the legend grid. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RelationshipRampElement) */ colors: Color[][]; /** * The labels for each corner of the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RelationshipRampElement) */ labels: RelationshipLabels; /** * The rotation of the legend in degrees (0-360). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RelationshipRampElement) */ rotation: number; /** * The title of the renderer as displayed in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RelationshipRampElement) */ title?: string; /** * Info objects associated with the relationship renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RelationshipRampElement) */ infos?: any[]; } /** * Describes the schema of the RendererTitle element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RendererTitle) */ export interface RendererTitle { /** * The title of the renderer as displayed in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RendererTitle) */ title?: string; /** * The field name used in the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RendererTitle) */ field: string; /** * If a normalization field is provided to the renderer, this field is also used in the generated title for the renderer in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RendererTitle) */ normField: string; /** * Indicates if a percentage is used in the normalization of the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#RendererTitle) */ normByPct: boolean; } /** * Describes the schema of the SizeRampElement used as a [legendElement](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#legendElement). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#SizeRampElement) */ export interface SizeRampElement { /** * The type of this element is always `size-ramp`. * * [Read more...](global.html#type) */ type: string; /** * The title of the size ramp as displayed in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#SizeRampElement) */ title?: string | RampTitle; /** * The individual size stops rendered in the legend that correspond to the size visual variable in the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#SizeRampElement) */ infos: SizeRampStop[]; } /** * Describes the schema of the SizeRampStop element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#SizeRampStop) */ export interface SizeRampStop { /** * The label in the legend describing features with the given `symbol` and `value`. * * [Read more...](global.html) */ label: string; /** * The value of the size visual variable [stop](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#stops). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#SizeRampStop) */ value?: any; /** * The symbol corresponding to the value of the stop in the renderer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#SizeRampStop) */ symbol: Symbol; /** * The size of the visual variable [stop](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html#stops) in points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#SizeRampStop) */ size?: number; /** * The width of the outline in points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#SizeRampStop) */ outlineSize?: number; /** * The HTML element rendered in the legend representing features with the given value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#SizeRampStop) */ preview?: HTMLElement; } /** * Describes the schema of the SymbolTableElement used as a [legendElement](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#legendElement). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#SymbolTableElement) */ export interface SymbolTableElement { /** * The type of this element is always `symbol-table`. * * [Read more...](global.html#type) */ type: string; /** * The title of the renderer as displayed in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#SymbolTableElement) */ title?: string | RendererTitle; /** * Only used for renderers set to ImageryLayers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#SymbolTableElement) */ legendType?: string; /** * An array of each symbol/category/break rendered for the symbol table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#SymbolTableElement) */ infos: SymbolTableElementType[]; } /** * Properties defining the scheme of the SymbolTableElementInfo. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#SymbolTableElementInfo) */ export interface SymbolTableElementInfo { /** * The title of the renderer as displayed in the Legend. * * [Read more...](global.html) */ label: string | RampTitle; /** * The value corresponding with the given `symbol` in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#SymbolTableElementInfo) */ value?: any; /** * The symbol for the corresponding `value` in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#SymbolTableElementInfo) */ symbol: Symbol; /** * The size of the symbol in points. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#SymbolTableElementInfo) */ size?: number; /** * A preview of the symbol element as displayed in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#SymbolTableElementInfo) */ preview?: HTMLElement; } /** * Properties defining the scheme of each SymbolTableElementType. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html#SymbolTableElementType) */ export type SymbolTableElementType = ImageSymbolTableElementInfo | SymbolTableElementInfo; export interface LegendLayerInfos { /** * Specifies a title for the layer to display above its symbols and descriptions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#layerInfos) */ title?: string; /** * A layer to display in the legend. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#layerInfos) */ layer: Layer; /** * Only applicable if the `layer` is a [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html), [SubtypeGroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SubtypeGroupLayer.html) or [WMSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#layerInfos) */ sublayerIds?: number[]; } export interface LegendStyle { /** * Specifies the style of the legend. * * [Read more...](global.html#type) */ type: "classic" | "card"; /** * When a `card` type is specified, you can specify one of the following layout options. * * @default stack * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#style) */ layout?: "auto" | "side-by-side" | "stack"; } export class LineOfSight extends Widget { /** * The line of sight analysis object being created or modified by the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight.html#analysis) */ readonly analysis: LineOfSightAnalysis; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/LineOfSight#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight.html#iconClass) */ iconClass: string; /** * A reference to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight.html#view) */ view: SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight.html#viewModel) */ viewModel: LineOfSightViewModel; /** * The LineOfSight widget is a 3D analysis tool that allows you to perform visibility analysis in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight.html) */ constructor(properties?: LineOfSightProperties); } interface LineOfSightProperties extends WidgetProperties { /** * The line of sight analysis object being created or modified by the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight.html#analysis) */ analysis?: LineOfSightAnalysisProperties; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/LineOfSight#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight.html#iconClass) */ iconClass?: string; /** * A reference to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight.html#view) */ view?: SceneViewProperties; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight.html#viewModel) */ viewModel?: LineOfSightViewModelProperties; } export class LineOfSightTarget extends Accessor { /** * The first [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) intersected by the line of sight. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight-LineOfSightTarget.html#intersectedGraphic) */ readonly intersectedGraphic: Graphic; /** * A [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing the location where the line of sight first intersects the ground or 3D objects in the scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight-LineOfSightTarget.html#intersectedLocation) */ readonly intersectedLocation: Point; /** * A [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing the location of the target. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight-LineOfSightTarget.html#location) */ location: Point; /** * Whether the target is visible from the observer or not. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight-LineOfSightTarget.html#visible) */ readonly visible: boolean; /** * This class represents a target point for a [LineOfSight](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight.html) analysis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight-LineOfSightTarget.html) */ constructor(properties?: LineOfSightTargetProperties); } interface LineOfSightTargetProperties { /** * A [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing the location of the target. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight-LineOfSightTarget.html#location) */ location?: PointProperties; } export class LineOfSightViewModel extends Accessor { /** * The line of sight analysis object being created or modified by the view model. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight-LineOfSightViewModel.html#analysis) */ readonly analysis: LineOfSightAnalysis; /** * The observer's viewpoint from which lines of sight will be drawn towards the targets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight-LineOfSightViewModel.html#observer) */ observer: Point; /** * The view model's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight-LineOfSightViewModel.html#state) */ readonly state: "disabled" | "ready" | "creating" | "created"; /** * A collection of [LineOfSightTarget](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight-LineOfSightTarget.html) containing the target location and the analysis results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight-LineOfSightViewModel.html#targets) */ targets: Collection; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight-LineOfSightViewModel.html#view) */ view: SceneView; /** * Provides the logic for the [LineOfSight](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight-LineOfSightViewModel.html) */ constructor(properties?: LineOfSightViewModelProperties); /** * Clears the current analysis results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight-LineOfSightViewModel.html#clear) */ clear(): void; /** * If stopped, this method continues the line of sight analysis and the user can add more targets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight-LineOfSightViewModel.html#continue) */ continue(): void; /** * Starts a new line of sight analysis. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight-LineOfSightViewModel.html#start) */ start(): void; /** * Stops the current line of sight analysis, keeping the results in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight-LineOfSightViewModel.html#stop) */ stop(): void; } interface LineOfSightViewModelProperties { /** * The line of sight analysis object being created or modified by the view model. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight-LineOfSightViewModel.html#analysis) */ analysis?: LineOfSightAnalysisProperties; /** * The observer's viewpoint from which lines of sight will be drawn towards the targets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight-LineOfSightViewModel.html#observer) */ observer?: PointProperties; /** * A collection of [LineOfSightTarget](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight-LineOfSightTarget.html) containing the target location and the analysis results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight-LineOfSightViewModel.html#targets) */ targets?: CollectionProperties; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight-LineOfSightViewModel.html#view) */ view?: SceneViewProperties; } export interface Locate extends Widget, GoTo { } export class Locate { /** * The browser's Geolocation API Position options for locating. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#geolocationOptions) */ geolocationOptions: any; /** * Indicates whether the widget should navigate the view to the position and scale of the geolocated result. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#goToLocationEnabled) */ goToLocationEnabled: boolean; /** * The graphic used to show the user's location on the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#graphic) */ graphic: Graphic; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/DirectionPad#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#iconClass) */ iconClass: string; /** * Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) of the result graphic from the [locate()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#locate) method. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#popupEnabled) */ popupEnabled: boolean; /** * Indicates whether the widget will automatically rotate to the device heading based on the Geolocation APIs [`GeolocationCoordinates.heading`](https://developer.mozilla.org/en-US/docs/Web/API/GeolocationCoordinates/heading) property. * * @default true * @deprecated since 4.29. Use Track widget instead * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#rotationEnabled) */ rotationEnabled: boolean; /** * Indicates the scale to set on the view when navigating to the position of the geolocated result once a location is returned from the [track](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#event-track) event. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#scale) */ scale: number; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#viewModel) */ viewModel: LocateViewModel; /** * Provides a simple widget that animates the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) to the user's current location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html) */ constructor(properties?: LocateProperties); /** * This function provides the ability to interrupt and cancel the process of programmatically obtaining the location of the user's device. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#cancelLocate) */ cancelLocate(): void; /** * Animates the view to the user's location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#locate) */ locate(): Promise; on(name: "locate", eventHandler: LocateLocateEventHandler): IHandle; on(name: "locate-error", eventHandler: LocateLocateErrorEventHandler): IHandle; } interface LocateProperties extends WidgetProperties, GoToProperties { /** * The browser's Geolocation API Position options for locating. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#geolocationOptions) */ geolocationOptions?: any; /** * Indicates whether the widget should navigate the view to the position and scale of the geolocated result. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#goToLocationEnabled) */ goToLocationEnabled?: boolean; /** * The graphic used to show the user's location on the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#graphic) */ graphic?: GraphicProperties; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/DirectionPad#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#iconClass) */ iconClass?: string; /** * Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) of the result graphic from the [locate()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#locate) method. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#popupEnabled) */ popupEnabled?: boolean; /** * Indicates whether the widget will automatically rotate to the device heading based on the Geolocation APIs [`GeolocationCoordinates.heading`](https://developer.mozilla.org/en-US/docs/Web/API/GeolocationCoordinates/heading) property. * * @default true * @deprecated since 4.29. Use Track widget instead * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#rotationEnabled) */ rotationEnabled?: boolean; /** * Indicates the scale to set on the view when navigating to the position of the geolocated result once a location is returned from the [track](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#event-track) event. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#scale) */ scale?: number; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#viewModel) */ viewModel?: LocateViewModelProperties; } export interface LocateViewModel extends Accessor, Evented, GeolocationPositioning, GoTo { } export class LocateViewModel { /** * Error that caused the last [locate-error](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#event:locate-error) event to fire. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#error) */ error: any | Error; /** * Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) of the result graphic from the [locate()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#locate) method. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#popupEnabled) */ popupEnabled: boolean; /** * The current state of the widget. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#state) */ readonly state: "disabled" | "ready" | "locating" | "error"; /** * Provides the logic for the [Locate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html) widget, which animates the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) to the user's current location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html) */ constructor(properties?: LocateViewModelProperties); /** * This function provides the ability to interrupt and cancel the process of programmatically obtaining the location of the user's device. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#cancelLocate) */ cancelLocate(): void; /** * Animates the view to the user's location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#locate) */ locate(): Promise; on(name: "locate-error", eventHandler: LocateViewModelLocateErrorEventHandler): IHandle; } interface LocateViewModelProperties extends GeolocationPositioningProperties, GoToProperties { /** * Error that caused the last [locate-error](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#event:locate-error) event to fire. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#error) */ error?: any | Error; /** * Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) of the result graphic from the [locate()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#locate) method. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#popupEnabled) */ popupEnabled?: boolean; } export interface LocateViewModelLocateErrorEvent { error: any | Error; } export interface LocateLocateErrorEvent { error: Error; } export interface LocateLocateEvent { position: any; } export class Measurement extends Widget { /** * Specifies the current measurement tool to display. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement.html#activeTool) */ activeTool: "area" | "distance" | "direct-line"; /** * The measurement widget that is currently being used. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement.html#activeWidget) */ readonly activeWidget: AreaMeasurement2D | AreaMeasurement3D | DirectLineMeasurement3D | DistanceMeasurement2D; /** * Unit system (imperial, metric) or specific unit used for displaying the area values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement.html#areaUnit) */ areaUnit: SystemOrAreaUnit; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Measurement#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement.html#iconClass) */ iconClass: string; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement.html#linearUnit) */ linearUnit: SystemOrLengthUnit; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement.html#viewModel) */ viewModel: MeasurementViewModel; /** * The Measurement widget groups and manages multiple measurement tools and allows you to easily switch between them using the [activeTool](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement.html#activeTool) property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement.html) */ constructor(properties?: MeasurementProperties); /** * Removes all measurement widgets and associated graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement.html#clear) */ clear(): void; /** * Starts a new measurement for the active measurement widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement.html#startMeasurement) */ startMeasurement(): void; } interface MeasurementProperties extends WidgetProperties { /** * Specifies the current measurement tool to display. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement.html#activeTool) */ activeTool?: "area" | "distance" | "direct-line"; /** * Unit system (imperial, metric) or specific unit used for displaying the area values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement.html#areaUnit) */ areaUnit?: | "imperial" | "metric" | "square-millimeters" | "square-centimeters" | "square-decimeters" | "square-meters" | "square-kilometers" | "square-inches" | "square-feet" | "square-yards" | "square-miles" | "square-us-feet" | "acres" | "ares" | "hectares"; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Measurement#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement.html#iconClass) */ iconClass?: string; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement.html#linearUnit) */ linearUnit?: | "imperial" | "metric" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement.html#viewModel) */ viewModel?: MeasurementViewModelProperties; } export class MeasurementViewModel extends Accessor { /** * Specifies the current measurement tool to display. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement-MeasurementViewModel.html#activeTool) */ activeTool: "area" | "distance" | "direct-line"; /** * View model of the active measurement widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement-MeasurementViewModel.html#activeViewModel) */ activeViewModel: | AreaMeasurement2DViewModel | AreaMeasurement3DViewModel | DirectLineMeasurement3DViewModel | DistanceMeasurement2DViewModel; /** * Unit system (imperial, metric) or specific unit used for displaying the area values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement-MeasurementViewModel.html#areaUnit) */ areaUnit: SystemOrAreaUnit; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement-MeasurementViewModel.html#linearUnit) */ linearUnit: SystemOrLengthUnit; /** * The ViewModel's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement-MeasurementViewModel.html#state) */ readonly state: "disabled" | "ready" | "measuring" | "measured"; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement-MeasurementViewModel.html#view) */ view: MapView | SceneView; /** * Provides the logic for the [Measurement](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement-MeasurementViewModel.html) */ constructor(properties?: MeasurementViewModelProperties); } interface MeasurementViewModelProperties { /** * Specifies the current measurement tool to display. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement-MeasurementViewModel.html#activeTool) */ activeTool?: "area" | "distance" | "direct-line"; /** * View model of the active measurement widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement-MeasurementViewModel.html#activeViewModel) */ activeViewModel?: | AreaMeasurement2DViewModel | AreaMeasurement3DViewModelProperties | DirectLineMeasurement3DViewModelProperties | DistanceMeasurement2DViewModelProperties; /** * Unit system (imperial, metric) or specific unit used for displaying the area values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement-MeasurementViewModel.html#areaUnit) */ areaUnit?: | "imperial" | "metric" | "square-millimeters" | "square-centimeters" | "square-decimeters" | "square-meters" | "square-kilometers" | "square-inches" | "square-feet" | "square-yards" | "square-miles" | "square-us-feet" | "acres" | "ares" | "hectares"; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement-MeasurementViewModel.html#linearUnit) */ linearUnit?: | "imperial" | "metric" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement-MeasurementViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } export class NavigationToggle extends Widget { /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/DirectionPad#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html#iconClass) */ iconClass: string; /** * Sets the layout of the widget to either `horizontal` or `vertical`. * * @default vertical * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html#layout) */ layout: "vertical" | "horizontal"; /** * A reference to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html#view) */ view: SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html#viewModel) */ viewModel: NavigationToggleViewModel; /** * Provides two simple buttons for toggling the [navigation mode](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#navigationMode) of a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html) */ constructor(properties?: NavigationToggleProperties); /** * Toggles the navigation mode of the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html#view) from `pan` to `rotate` or vice versa. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html#toggle) */ toggle(): void; } interface NavigationToggleProperties extends WidgetProperties { /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/DirectionPad#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html#iconClass) */ iconClass?: string; /** * Sets the layout of the widget to either `horizontal` or `vertical`. * * @default vertical * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html#layout) */ layout?: "vertical" | "horizontal"; /** * A reference to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html#view) */ view?: SceneViewProperties; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html#viewModel) */ viewModel?: NavigationToggleViewModelProperties; } export class NavigationToggleViewModel extends Accessor { /** * The navigation mode of the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#view). * * @default pan * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#navigationMode) */ navigationMode: "pan" | "rotate"; /** * The state of the widget. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#state) */ readonly state: "disabled" | "ready"; /** * The view associated with the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#view) */ view: SceneView; /** * Provides the logic for the [NavigationToggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html) widget, which provides two simple buttons for toggling the [navigation mode](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#navigationMode) of a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html) */ constructor(properties?: NavigationToggleViewModelProperties); /** * Toggles the navigation mode of the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#view) from `pan` to `rotate` or vice versa. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#toggle) */ toggle(): void; } interface NavigationToggleViewModelProperties { /** * The navigation mode of the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#view). * * @default pan * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#navigationMode) */ navigationMode?: "pan" | "rotate"; /** * The view associated with the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#view) */ view?: SceneViewProperties; } export class OrientedImageryViewer extends Widget { /** * Toggles the visibility of the current footprint polygon associated with the selected image loaded in the viewer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#currentCoverageVisible) */ currentCoverageVisible: boolean; /** * When `false`, the view click interaction is enabled for the oriented imagery viewer widget. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#disabled) */ disabled: boolean; /** * Indicates if the image gallery functionality is available in the widget. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#galleryOpened) */ galleryOpened: boolean; /** * Indicates if the image enhancement tool is active. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#imageEnhancementToolActive) */ imageEnhancementToolActive: boolean; /** * When `true`, the image gallery functionality is available in the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#imageGalleryEnabled) */ readonly imageGalleryEnabled: boolean; /** * Indicates if the additional footprint polygons are visible for the selected image loaded in the viewer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#isAdditionalCoverageVisible) */ isAdditionalCoverageVisible: boolean; /** * Indicates if the additional camera locations are visible for the selected image loaded in the viewer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#isAdditionalPointSourcesVisible) */ isAdditionalPointSourcesVisible: boolean; /** * Specifies the current [OrientedImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html) to use. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#layer) */ layer: OrientedImageryLayer; /** * Indicates if the map-image location tool is available in the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#mapImageConversionToolState) */ mapImageConversionToolState: boolean; /** * When `true`, the navigation tool is available in the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#navigationToolActive) */ navigationToolActive: boolean; /** * This property provides the location of an image pixel in Map coordinates when using map-image conversion tool. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#referencePoint) */ readonly referencePoint: Point; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#viewModel) */ viewModel: OrientedImageryViewerViewModel; /** * The oriented imagery viewer widget allows the user to explore and use their oriented images. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html) */ constructor(properties?: OrientedImageryViewerProperties); } interface OrientedImageryViewerProperties extends WidgetProperties { /** * Toggles the visibility of the current footprint polygon associated with the selected image loaded in the viewer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#currentCoverageVisible) */ currentCoverageVisible?: boolean; /** * When `false`, the view click interaction is enabled for the oriented imagery viewer widget. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#disabled) */ disabled?: boolean; /** * Indicates if the image gallery functionality is available in the widget. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#galleryOpened) */ galleryOpened?: boolean; /** * Indicates if the image enhancement tool is active. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#imageEnhancementToolActive) */ imageEnhancementToolActive?: boolean; /** * Indicates if the additional footprint polygons are visible for the selected image loaded in the viewer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#isAdditionalCoverageVisible) */ isAdditionalCoverageVisible?: boolean; /** * Indicates if the additional camera locations are visible for the selected image loaded in the viewer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#isAdditionalPointSourcesVisible) */ isAdditionalPointSourcesVisible?: boolean; /** * Specifies the current [OrientedImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html) to use. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#layer) */ layer?: OrientedImageryLayerProperties; /** * Indicates if the map-image location tool is available in the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#mapImageConversionToolState) */ mapImageConversionToolState?: boolean; /** * When `true`, the navigation tool is available in the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#navigationToolActive) */ navigationToolActive?: boolean; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#viewModel) */ viewModel?: OrientedImageryViewerViewModelProperties; } export class OrientedImageryViewerViewModel extends Accessor { /** * Changes the image brightness loaded in the viewer. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#brightness) */ brightness: number; /** * Changes the image contrast loaded in the viewer. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#contrast) */ contrast: number; /** * Toggles the visibility of the current footprint polygon associated with the selected image loaded in the viewer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#currentCoverageVisible) */ currentCoverageVisible: boolean; /** * When `false`, the view click interaction enabled for the oriented imagery viewer widget. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#disabled) */ disabled: boolean; /** * When `true`, the image gallery functionality is available in the widget. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#imageGalleryEnabled) */ imageGalleryEnabled: boolean; /** * Indicates if the image has been loaded onto the oriented imagery viewer. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#imageLoaded) */ imageLoaded: boolean; /** * Indicates if the additional footprint polygons are visible for the selected image loaded in the viewer. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#isAdditionalCoverageVisible) */ isAdditionalCoverageVisible: boolean; /** * Indicates if the additional camera locations are visible for the selected image loaded in the viewer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#isAdditionalPointSourcesVisible) */ isAdditionalPointSourcesVisible: boolean; /** * [OrientedImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html) associated with the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#layer) */ layer: OrientedImageryLayer; /** * Indicates if the map-image location tool available in the widget. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#mapImageConversionToolState) */ mapImageConversionToolState: boolean; /** * Changes the image sharpness loaded in the viewer. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#sharpness) */ sharpness: number; /** * Provides the logic for the [OrientedImageryViewer](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html) */ constructor(properties?: OrientedImageryViewerViewModelProperties); } interface OrientedImageryViewerViewModelProperties { /** * Changes the image brightness loaded in the viewer. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#brightness) */ brightness?: number; /** * Changes the image contrast loaded in the viewer. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#contrast) */ contrast?: number; /** * Toggles the visibility of the current footprint polygon associated with the selected image loaded in the viewer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#currentCoverageVisible) */ currentCoverageVisible?: boolean; /** * When `false`, the view click interaction enabled for the oriented imagery viewer widget. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#disabled) */ disabled?: boolean; /** * When `true`, the image gallery functionality is available in the widget. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#imageGalleryEnabled) */ imageGalleryEnabled?: boolean; /** * Indicates if the image has been loaded onto the oriented imagery viewer. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#imageLoaded) */ imageLoaded?: boolean; /** * Indicates if the additional footprint polygons are visible for the selected image loaded in the viewer. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#isAdditionalCoverageVisible) */ isAdditionalCoverageVisible?: boolean; /** * Indicates if the additional camera locations are visible for the selected image loaded in the viewer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#isAdditionalPointSourcesVisible) */ isAdditionalPointSourcesVisible?: boolean; /** * [OrientedImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html) associated with the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#layer) */ layer?: OrientedImageryLayerProperties; /** * Indicates if the map-image location tool available in the widget. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#mapImageConversionToolState) */ mapImageConversionToolState?: boolean; /** * Changes the image sharpness loaded in the viewer. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#sharpness) */ sharpness?: number; } export interface Popup extends Widget, GoTo, Evented { } export class Popup { /** * Defines actions that may be executed by clicking the icon or image symbolizing them in the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#actions) */ actions: Collection; /** * Position of the popup in relation to the selected feature. * * @default auto * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#alignment) */ alignment: "auto" | "top-center" | "top-right" | "bottom-left" | "bottom-center" | "bottom-right" | Function; /** * This closes the popup when the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) camera or [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) changes. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#autoCloseEnabled) */ autoCloseEnabled: boolean; /** * This property indicates to the `Popup` that it needs to allow or disallow the click event propagation. * * @default true * @deprecated since 4.27. Use {@link module:esri/core/MapView#popupEnabled MapView/SceneView.popupEnabled} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#autoOpenEnabled) */ autoOpenEnabled: boolean; /** * Indicates whether the popup displays its content. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#collapsed) */ readonly collapsed: boolean; /** * Indicates whether to enable collapse functionality for the popup. * * @default true * @deprecated since 4.29. Use {@link module:esri/widgets/Popup~VisibleElements PopupVisibleElements.collapseButton} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#collapseEnabled) */ collapseEnabled: boolean; /** * The content of the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#content) */ content: string | HTMLElement | Widget; /** * Dock position in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#currentDockPosition) */ readonly currentDockPosition: | "auto" | "top-center" | "top-right" | "top-left" | "bottom-left" | "bottom-center" | "bottom-right"; /** * Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#defaultPopupTemplateEnabled) */ defaultPopupTemplateEnabled: boolean; /** * Indicates whether the placement of the popup is docked to the side of the view. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#dockEnabled) */ dockEnabled: boolean; /** * Docking the popup allows for a better user experience, particularly when opening popups in apps on mobile devices. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#dockOptions) */ dockOptions: PopupDockOptions; /** * The number of selected [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#features) available to the popup. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#featureCount) */ readonly featureCount: number; /** * An array of features associated with the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#features) */ features: Graphic[]; /** * Indicates the heading level to use for the [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#title) of the popup. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#headingLevel) */ headingLevel: number; /** * Highlight the selected popup feature using the [highlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#highlightOptions) set on the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or the [highlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlightOptions) set on the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#highlightEnabled) */ highlightEnabled: boolean; /** * Point used to position the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#location) */ location: Point; /** * An array of pending Promises that have not yet been fulfilled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#promises) */ promises: Promise[]; /** * The selected feature accessed by the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeature) */ readonly selectedFeature: Graphic; /** * Index of the feature that is [selected](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeature). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeatureIndex) */ selectedFeatureIndex: number; /** * Returns a reference to the current [Feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html) that the Popup is using. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeatureWidget) */ readonly selectedFeatureWidget: Feature; /** * Indicates whether to display a spinner at the popup location prior to its display when it has pending promises. * * @deprecated since 4.29. Use {@link module:esri/widgets/Popup~VisibleElements PopupVisibleElements.spinner} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#spinnerEnabled) */ spinnerEnabled: boolean; /** * The title of the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#title) */ title: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#view) */ view: MapView | SceneView; /** * This is a class that contains all the logic (properties and methods) that controls this widget's behavior. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#viewModel) */ viewModel: PopupViewModel; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#visibleElements) */ visibleElements: PopupVisibleElements; /** * The Popup widget allows users to view content from feature attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) */ constructor(properties?: PopupProperties); /** * Use this method to remove focus from the Widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#blur) */ blur(): void; /** * Removes [promises](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#promises), [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#features), [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#content), [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#title) and [location](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#location) from the Popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#clear) */ clear(): void; /** * Closes the popup by setting its [visible](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#visible) property to `false`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#close) */ close(): void; /** * Use this method to return feature(s) at a given screen location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#fetchFeatures) */ fetchFeatures(screenPoint: PopupFetchFeaturesScreenPoint, options?: PopupFetchFeaturesOptions): Promise; /** * Use this method to give focus to the Widget if the widget is able to be focused. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#focus) */ focus(): void; /** * Selects the feature at the next index in relation to the selected feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#next) */ next(): PopupViewModel; /** * Opens the popup at the given location with content defined either explicitly with `content` or driven from the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) of input features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#open) */ open(options?: PopupOpenOptions): void; /** * Selects the feature at the previous index in relation to the selected feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#previous) */ previous(): PopupViewModel; /** * Positions the popup on the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#reposition) */ reposition(): void; /** * Triggers the [trigger-action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#event-trigger-action) event and executes the [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#actions) at the specified index in the [actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#actions) array. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#triggerAction) */ triggerAction(actionIndex: number): void; on(name: "trigger-action", eventHandler: PopupTriggerActionEventHandler): IHandle; } interface PopupProperties extends WidgetProperties, GoToProperties { /** * Defines actions that may be executed by clicking the icon or image symbolizing them in the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#actions) */ actions?: CollectionProperties< (ActionButtonProperties & { type: "button" }) | (ActionToggleProperties & { type: "toggle" }) >; /** * Position of the popup in relation to the selected feature. * * @default auto * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#alignment) */ alignment?: "auto" | "top-center" | "top-right" | "bottom-left" | "bottom-center" | "bottom-right" | Function; /** * This closes the popup when the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) camera or [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) changes. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#autoCloseEnabled) */ autoCloseEnabled?: boolean; /** * This property indicates to the `Popup` that it needs to allow or disallow the click event propagation. * * @default true * @deprecated since 4.27. Use {@link module:esri/core/MapView#popupEnabled MapView/SceneView.popupEnabled} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#autoOpenEnabled) */ autoOpenEnabled?: boolean; /** * Indicates whether to enable collapse functionality for the popup. * * @default true * @deprecated since 4.29. Use {@link module:esri/widgets/Popup~VisibleElements PopupVisibleElements.collapseButton} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#collapseEnabled) */ collapseEnabled?: boolean; /** * The content of the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#content) */ content?: string | HTMLElement | WidgetProperties; /** * Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#defaultPopupTemplateEnabled) */ defaultPopupTemplateEnabled?: boolean; /** * Indicates whether the placement of the popup is docked to the side of the view. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#dockEnabled) */ dockEnabled?: boolean; /** * Docking the popup allows for a better user experience, particularly when opening popups in apps on mobile devices. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#dockOptions) */ dockOptions?: PopupDockOptions; /** * An array of features associated with the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#features) */ features?: GraphicProperties[]; /** * Indicates the heading level to use for the [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#title) of the popup. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#headingLevel) */ headingLevel?: number; /** * Highlight the selected popup feature using the [highlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#highlightOptions) set on the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or the [highlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlightOptions) set on the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#highlightEnabled) */ highlightEnabled?: boolean; /** * Point used to position the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#location) */ location?: PointProperties; /** * An array of pending Promises that have not yet been fulfilled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#promises) */ promises?: Promise[]; /** * Index of the feature that is [selected](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeature). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeatureIndex) */ selectedFeatureIndex?: number; /** * Indicates whether to display a spinner at the popup location prior to its display when it has pending promises. * * @deprecated since 4.29. Use {@link module:esri/widgets/Popup~VisibleElements PopupVisibleElements.spinner} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#spinnerEnabled) */ spinnerEnabled?: boolean; /** * The title of the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#title) */ title?: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * This is a class that contains all the logic (properties and methods) that controls this widget's behavior. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#viewModel) */ viewModel?: PopupViewModelProperties; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#visibleElements) */ visibleElements?: PopupVisibleElements; } export class PopupViewModel extends FeaturesViewModel { /** * This property indicates to the `Popup` that it needs to allow or disallow the click event propagation. * * @default true * @deprecated since 4.27. Use {@link module:esri/core/MapView#popupEnabled MapView/SceneView.popupEnabled} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#autoOpenEnabled) */ autoOpenEnabled: boolean; /** * Provides the logic for the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) widget, which allows users to view content from feature attributes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html) */ constructor(properties?: PopupViewModelProperties); } interface PopupViewModelProperties extends FeaturesViewModelProperties { /** * This property indicates to the `Popup` that it needs to allow or disallow the click event propagation. * * @default true * @deprecated since 4.27. Use {@link module:esri/core/MapView#popupEnabled MapView/SceneView.popupEnabled} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#autoOpenEnabled) */ autoOpenEnabled?: boolean; } /** * Optional properties to use with the [fetchFeatures](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#fetchFeatures) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#FetchFeaturesOptions) */ export interface PopupFetchFeaturesOptions { /** * The `click` event for either the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#FetchFeaturesOptions) */ event?: any; /** * The signal object that can be used to abort the asynchronous task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#FetchFeaturesOptions) */ signal?: AbortSignal; } /** * The resulting features returned from the [fetchFeatures](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#fetchFeatures) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#FetchPopupFeaturesResult) */ export interface FetchPopupFeaturesResult { /** * An array of promises containing graphics from the selected location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#FetchPopupFeaturesResult) */ allGraphicsPromise?: Promise; /** * The resulting location of the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hitTest) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest)'s' `hitTest`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#FetchPopupFeaturesResult) */ location?: Point; } export interface PopupDockOptions { /** * Defines the dimensions of the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) at which to dock the popup. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#dockOptions) */ breakpoint?: boolean | PopupDockOptionsBreakpoint; /** * If `true`, displays the dock button. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#dockOptions) */ buttonEnabled?: boolean; /** * The position in the view at which to dock the popup. * * @default auto * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#dockOptions) */ position?: string | Function; } export interface PopupDockOptionsBreakpoint { /** * The maximum width of the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) at which the popup will be set to dockEnabled automatically. * * @default 544 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#dockOptions) */ width?: number; /** * The maximum height of the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) at which the popup will be set to dockEnabled automatically. * * @default 544 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#dockOptions) */ height?: number; } export interface PopupFetchFeaturesScreenPoint { /** * The x coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#fetchFeatures) */ x: number; /** * The y coordinate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#fetchFeatures) */ y: number; } export interface PopupOpenOptions { /** * Sets the [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#title) of the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#open) */ title?: string; /** * Sets the [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#content) of the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#open) */ content?: string | HTMLElement | Widget; /** * Sets the popup's [location](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#location), which is the geometry used to position the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#open) */ location?: Geometry; /** * When `true`, indicates the popup should fetch the content of this feature and display it. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#open) */ fetchFeatures?: boolean; /** * Sets the popup's [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#features), which populate the title and content of the popup based on each graphic's [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#open) */ features?: Graphic[]; /** * Sets pending [promises](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#promises) on the popup. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#open) */ promises?: Promise[]; /** * **Since:** 4.5 This property enables multiple features in a popup to display in a list rather than displaying the first selected feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#open) */ featureMenuOpen?: boolean; /** * When `true` indicates the popup should update its [location](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#location) for each paginated feature based on the [selected feature's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeature) geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#open) */ updateLocationEnabled?: boolean; /** * **Since:** 4.5 When `true`, indicates that only the popup header will display. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#open) */ collapsed?: boolean; /** * **Since:** 4.23 When `true`, indicates that the focus should be on the popup after it has been opened. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#open) */ shouldFocus?: boolean; } export interface PopupTriggerActionEvent { action: ActionButton | ActionToggle; } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#VisibleElements) */ export interface PopupVisibleElements { /** * **Since 4.29.** Indicates whether to display the action bar that holds the feature's [actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#actions). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#VisibleElements) */ actionBar?: boolean; /** * Indicates whether to display a close button on the widget dialog. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#VisibleElements) */ closeButton?: boolean; /** * **Since 4.29.** Indicates whether to display the collapse button on the widget dialog. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#VisibleElements) */ collapseButton?: boolean; /** * Indicates whether pagination for feature navigation will be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#VisibleElements) */ featureNavigation?: boolean; /** * **Since 4.29.** Indicates whether to display the widget heading. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#VisibleElements) */ heading?: boolean; /** * **Since 4.29.** Indicates whether to display the widget's loading spinner. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#VisibleElements) */ spinner?: boolean; } export class Print extends Widget { /** * Specify the print output file format(s) that the user can select based on the options available from the print service. * * @default "all" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#allowedFormats) */ allowedFormats: string | string[]; /** * Specify the print output layout(s) that the user can select based on the options available from the print service. * * @default "all" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#allowedLayouts) */ allowedLayouts: string | string[]; /** * The collection of links exported from the Print widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#exportedLinks) */ readonly exportedLinks: Collection; /** * This option allows passing extra parameters (in addition to [templateOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#templateOptions)) to the print (export webmap) requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#extraParameters) */ extraParameters: any; /** * Indicates the heading level to use for the "Exported files" text where users can access the exported map printout. * * @default 3 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#headingLevel) */ headingLevel: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Print#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#iconClass) */ iconClass: string; /** * Indicates whether or not to include [defaultTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#defaultTemplates). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#includeDefaultTemplates) */ includeDefaultTemplates: boolean; /** * It is possible to search a specified portal instance's [locator services](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#portal) */ portal: Portal; /** * The URL of the REST endpoint of the Export Web Map Task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#printServiceUrl) */ printServiceUrl: string; /** * An object containing an array of `customTextElements` name-value pair objects for each print template in a custom print service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#templateCustomTextElements) */ templateCustomTextElements: any[]; /** * Defines the layout template options used by the [Print](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html) widget to generate the print page. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#templateOptions) */ templateOptions: TemplateOptions; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#view) */ view: MapView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#viewModel) */ viewModel: PrintViewModel; /** * The Print widget connects your application with a [printing service](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-the-portal-to-print-maps.htm) to allow the map to be printed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html) */ constructor(properties?: PrintProperties); on(name: "complete", eventHandler: PrintCompleteEventHandler): IHandle; on(name: "submit", eventHandler: PrintSubmitEventHandler): IHandle; } interface PrintProperties extends WidgetProperties { /** * Specify the print output file format(s) that the user can select based on the options available from the print service. * * @default "all" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#allowedFormats) */ allowedFormats?: string | string[]; /** * Specify the print output layout(s) that the user can select based on the options available from the print service. * * @default "all" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#allowedLayouts) */ allowedLayouts?: string | string[]; /** * This option allows passing extra parameters (in addition to [templateOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#templateOptions)) to the print (export webmap) requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#extraParameters) */ extraParameters?: any; /** * Indicates the heading level to use for the "Exported files" text where users can access the exported map printout. * * @default 3 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#headingLevel) */ headingLevel?: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Print#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#iconClass) */ iconClass?: string; /** * Indicates whether or not to include [defaultTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#defaultTemplates). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#includeDefaultTemplates) */ includeDefaultTemplates?: boolean; /** * It is possible to search a specified portal instance's [locator services](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#portal) */ portal?: PortalProperties; /** * The URL of the REST endpoint of the Export Web Map Task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#printServiceUrl) */ printServiceUrl?: string; /** * An object containing an array of `customTextElements` name-value pair objects for each print template in a custom print service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#templateCustomTextElements) */ templateCustomTextElements?: any[]; /** * Defines the layout template options used by the [Print](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html) widget to generate the print page. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#templateOptions) */ templateOptions?: TemplateOptionsProperties; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#view) */ view?: MapViewProperties; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#viewModel) */ viewModel?: PrintViewModelProperties; } export class CustomTemplate extends Accessor { /** * The template's description. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-CustomTemplate.html#description) */ readonly description: string; /** * The output format for the printed map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-CustomTemplate.html#format) */ format: "pdf" | "png32" | "png8" | "jpg" | "gif" | "eps" | "svg" | "svgz"; /** * The text that appears inside the [Print Widget's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html) `Select template` button. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-CustomTemplate.html#label) */ readonly label: string; /** * The layout used for the print output. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-CustomTemplate.html#layout) */ readonly layout: | "map-only" | "a3-landscape" | "a3-portrait" | "a4-landscape" | "a4-portrait" | "letter-ansi-a-landscape" | "letter-ansi-a-portrait" | "tabloid-ansi-b-landscape" | "tabloid-ansi-b-portrait"; /** * Defines the layout elements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-CustomTemplate.html#layoutOptions) */ readonly layoutOptions: CustomTemplateLayoutOptions; /** * Defines the custom layout template options used by the [Print](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html) widget to generate the print page. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-CustomTemplate.html) */ constructor(properties?: CustomTemplateProperties); } interface CustomTemplateProperties { /** * The output format for the printed map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-CustomTemplate.html#format) */ format?: "pdf" | "png32" | "png8" | "jpg" | "gif" | "eps" | "svg" | "svgz"; } export interface CustomTemplateLayoutOptions { /** * Indicates whether the legend will be included in the print-out. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-CustomTemplate.html#layoutOptions) */ legend?: boolean; /** * Indicates whether the north arrow will be included in the print-out. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-CustomTemplate.html#layoutOptions) */ northArrow?: boolean; } export class PrintViewModel extends Accessor { /** * Specify the print output file format(s) that the user can select based on the options available from the print service. * * @default "all" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#allowedFormats) */ allowedFormats: string | string[]; /** * Specify the print output layout(s) that the user can select based on the options available from the print service. * * @default "all" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#allowedLayouts) */ allowedLayouts: string | string[]; /** * A collection of print templates defined on the Portal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#defaultTemplates) */ readonly defaultTemplates: Collection; /** * The effective URL of the REST endpoint of the Export Web Map Task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#effectivePrintServiceUrl) */ readonly effectivePrintServiceUrl: string; /** * Returns an array of objects of all print templates available on the custom print service to see which templates were published with `customTextElements`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#effectiveTemplateCustomTextElements) */ readonly effectiveTemplateCustomTextElements: any[]; /** * This option allows passing extra parameters to the print (export webmap) requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#extraParameters) */ extraParameters: any; /** * Indicates whether or not to include [defaultTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#defaultTemplates). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#includeDefaultTemplates) */ includeDefaultTemplates: boolean; /** * It is possible to search a specified portal instance's [locator services](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#portal) */ portal: Portal; /** * The URL of the REST endpoint of the Export Web Map Task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#printServiceUrl) */ printServiceUrl: string; /** * Print timeout value in milliseconds. * * @default 120000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#printTimeout) */ printTimeout: number; /** * The view model's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#state) */ readonly state: "disabled" | "initializing" | "ready" | "error"; /** * An object containing an array of `customTextElements` name-value pair objects for each print template in a custom print service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#templateCustomTextElements) */ templateCustomTextElements: any[]; /** * The service metadata that contains the [format](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#format) and [layout](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#layout) information for the printout. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#templatesInfo) */ readonly templatesInfo: any; /** * The time interval in milliseconds between each job status request sent to an asynchronous GP task. * * @default 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#updateDelay) */ updateDelay: number; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#view) */ view: MapView; /** * Provides the logic for the [Print](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html) */ constructor(properties?: PrintViewModelProperties); /** * This method should be called to load the view model's printing resources. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#load) */ load(): Promise; /** * Prints (exports) the current MapView according to selected options. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#print) */ print(template: PrintTemplate): Promise; } interface PrintViewModelProperties { /** * Specify the print output file format(s) that the user can select based on the options available from the print service. * * @default "all" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#allowedFormats) */ allowedFormats?: string | string[]; /** * Specify the print output layout(s) that the user can select based on the options available from the print service. * * @default "all" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#allowedLayouts) */ allowedLayouts?: string | string[]; /** * This option allows passing extra parameters to the print (export webmap) requests. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#extraParameters) */ extraParameters?: any; /** * Indicates whether or not to include [defaultTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#defaultTemplates). * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#includeDefaultTemplates) */ includeDefaultTemplates?: boolean; /** * It is possible to search a specified portal instance's [locator services](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#portal) */ portal?: PortalProperties; /** * The URL of the REST endpoint of the Export Web Map Task. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#printServiceUrl) */ printServiceUrl?: string; /** * Print timeout value in milliseconds. * * @default 120000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#printTimeout) */ printTimeout?: number; /** * An object containing an array of `customTextElements` name-value pair objects for each print template in a custom print service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#templateCustomTextElements) */ templateCustomTextElements?: any[]; /** * The time interval in milliseconds between each job status request sent to an asynchronous GP task. * * @default 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#updateDelay) */ updateDelay?: number; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#view) */ view?: MapViewProperties; } export class TemplateOptions extends Accessor { /** * When `false`, the attribution is not displayed on the printout. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#attributionEnabled) */ attributionEnabled: boolean; /** * The text used for the author if the specified layout contains an author text element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#author) */ author: string; /** * The text used for the copyright if the specified layout contains an copyright text element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#copyright) */ copyright: string; /** * Use this prop to display text fields for custom text elements from the print service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#customTextElements) */ customTextElements: any[]; /** * Resolution in dots per inch. * * @default 96 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#dpi) */ dpi: string; /** * This property only applies when the [layout](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#layout) value is `map-only`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#fileName) */ fileName: string; /** * When true, the feature's attributes are included in feature collection layers even when they are not needed for rendering. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#forceFeatureAttributes) */ forceFeatureAttributes: boolean; /** * The output format for the printed map. * * @default pdf * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#format) */ format: "pdf" | "png32" | "png8" | "jpg" | "gif" | "eps" | "svg" | "svgz"; /** * Map height. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#height) */ height: number; /** * When `true`, tables will be included in the printout request. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#includeTables) */ includeTables: boolean; /** * The layout used for the print output. * * @default letter-ansi-a-landscape * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#layout) */ layout: | "map-only" | "a3-landscape" | "a3-portrait" | "a4-landscape" | "a4-portrait" | "letter-ansi-a-landscape" | "letter-ansi-a-portrait" | "tabloid-ansi-b-landscape" | "tabloid-ansi-b-portrait"; /** * A custom layout hosted as a [portal item](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#layoutItem) */ layoutItem: PortalItem; /** * When `false`, the legend is not displayed on the printout. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#legendEnabled) */ legendEnabled: boolean; /** * When `true`, the north arrow will be included on the printout. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#northArrowEnabled) */ northArrowEnabled: boolean; /** * The map scale of the printed map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#scale) */ scale: number; /** * Define whether the printed map should preserve map scale or map extent. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#scaleEnabled) */ scaleEnabled: boolean; /** * The text used for the map title if the specified layout contains a title text element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#title) */ title: string; /** * Map width. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#width) */ width: number; /** * Defines the layout template options used by the [Print](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html) widget to generate printed output. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html) */ constructor(properties?: TemplateOptionsProperties); } interface TemplateOptionsProperties { /** * When `false`, the attribution is not displayed on the printout. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#attributionEnabled) */ attributionEnabled?: boolean; /** * The text used for the author if the specified layout contains an author text element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#author) */ author?: string; /** * The text used for the copyright if the specified layout contains an copyright text element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#copyright) */ copyright?: string; /** * Use this prop to display text fields for custom text elements from the print service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#customTextElements) */ customTextElements?: any[]; /** * Resolution in dots per inch. * * @default 96 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#dpi) */ dpi?: string; /** * This property only applies when the [layout](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#layout) value is `map-only`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#fileName) */ fileName?: string; /** * When true, the feature's attributes are included in feature collection layers even when they are not needed for rendering. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#forceFeatureAttributes) */ forceFeatureAttributes?: boolean; /** * The output format for the printed map. * * @default pdf * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#format) */ format?: "pdf" | "png32" | "png8" | "jpg" | "gif" | "eps" | "svg" | "svgz"; /** * Map height. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#height) */ height?: number; /** * When `true`, tables will be included in the printout request. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#includeTables) */ includeTables?: boolean; /** * The layout used for the print output. * * @default letter-ansi-a-landscape * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#layout) */ layout?: | "map-only" | "a3-landscape" | "a3-portrait" | "a4-landscape" | "a4-portrait" | "letter-ansi-a-landscape" | "letter-ansi-a-portrait" | "tabloid-ansi-b-landscape" | "tabloid-ansi-b-portrait"; /** * A custom layout hosted as a [portal item](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#layoutItem) */ layoutItem?: PortalItemProperties; /** * When `false`, the legend is not displayed on the printout. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#legendEnabled) */ legendEnabled?: boolean; /** * When `true`, the north arrow will be included on the printout. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#northArrowEnabled) */ northArrowEnabled?: boolean; /** * The map scale of the printed map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#scale) */ scale?: number; /** * Define whether the printed map should preserve map scale or map extent. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#scaleEnabled) */ scaleEnabled?: boolean; /** * The text used for the map title if the specified layout contains a title text element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#title) */ title?: string; /** * Map width. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#width) */ width?: number; } export interface PrintCompleteEvent { results: PrintCompleteEventResults; } /** * Represents an exported map request from the result of the Print widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#FileLink) */ export interface FileLink { /** * The location of the FileLink element in the array. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#FileLink) */ count: number; /** * The [error](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html) from the Print widget, if any. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#FileLink) */ error: string; /** * The [file](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#format) type of the print-out. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#FileLink) */ extension: string; /** * The [fileName](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#fileName) or [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#title) of the print-out. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#FileLink) */ name: string; /** * The state of the print-out. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#FileLink) */ state: string; /** * The [printServiceUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#printServiceUrl) of the print-out. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#FileLink) */ url: string; } export interface PrintSubmitEvent { results: PrintSubmitEventResults; } export interface PrintCompleteEventResults { link: Collection; } export interface PrintSubmitEventResults { link: Collection; } export class ScaleBar extends Widget { /** * The style for the scale bar. * * @default "line" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar.html#style) */ style: "ruler" | "line"; /** * Units to use for the scale bar. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar.html#unit) */ unit: "metric" | "imperial" | "dual" | "non-metric"; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar.html#view) */ view: MapView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar.html#viewModel) */ viewModel: ScaleBarViewModel; /** * The ScaleBar widget displays a scale bar on the map or in a specified HTML node. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar.html) */ constructor(properties?: ScaleBarProperties); } interface ScaleBarProperties extends WidgetProperties { /** * The style for the scale bar. * * @default "line" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar.html#style) */ style?: "ruler" | "line"; /** * Units to use for the scale bar. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar.html#unit) */ unit?: "metric" | "imperial" | "dual" | "non-metric"; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar.html#view) */ view?: MapViewProperties; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar.html#viewModel) */ viewModel?: ScaleBarViewModelProperties; } export class ScaleBarViewModel extends Accessor { /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar-ScaleBarViewModel.html#view) */ view: MapView; /** * Provides the logic for the [ScaleBar](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar-ScaleBarViewModel.html) */ constructor(properties?: ScaleBarViewModelProperties); } interface ScaleBarViewModelProperties { /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar-ScaleBarViewModel.html#view) */ view?: MapViewProperties; } export class ScaleRangeSlider extends Widget { /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#disabled) */ disabled: boolean; /** * When provided, the initial [minScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#minScale) and [maxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#maxScale) values will match the layer's. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#layer) */ layer: Layer; /** * The maximum scale of the active scale range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#maxScale) */ maxScale: number; /** * The lowest possible maximum scale value on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#maxScaleLimit) */ maxScaleLimit: number; /** * The minimum scale of the active scale range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#minScale) */ minScale: number; /** * The highest possible minimum scale value on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#minScaleLimit) */ minScaleLimit: number; /** * The mode of the widget, indicating which slider thumbs can be adjusted. * * @default "range" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#mode) */ mode: "range" | "max-scale-only" | "min-scale-only"; /** * The region that the scale thumbnails will focus on. * * @default "US" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#region) */ region: SupportedRegion; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#viewModel) */ viewModel: ScaleRangeSliderViewModel; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#visibleElements) */ visibleElements: ScaleRangeSliderVisibleElements; /** * The ScaleRangeSlider widget allows the user to set a minimum and maximum scale based on named scale ranges. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html) */ constructor(properties?: ScaleRangeSliderProperties); } interface ScaleRangeSliderProperties extends WidgetProperties { /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#disabled) */ disabled?: boolean; /** * When provided, the initial [minScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#minScale) and [maxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#maxScale) values will match the layer's. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#layer) */ layer?: LayerProperties; /** * The maximum scale of the active scale range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#maxScale) */ maxScale?: number; /** * The lowest possible maximum scale value on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#maxScaleLimit) */ maxScaleLimit?: number; /** * The minimum scale of the active scale range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#minScale) */ minScale?: number; /** * The highest possible minimum scale value on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#minScaleLimit) */ minScaleLimit?: number; /** * The mode of the widget, indicating which slider thumbs can be adjusted. * * @default "range" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#mode) */ mode?: "range" | "max-scale-only" | "min-scale-only"; /** * The region that the scale thumbnails will focus on. * * @default "US" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#region) */ region?: | "AE" | "AR" | "AT" | "AU" | "BE" | "BG" | "BO" | "BR" | "CA" | "CH" | "CI" | "CL" | "CN" | "CO" | "CR" | "CZ" | "DE" | "DK" | "EE" | "EG" | "ES" | "FI" | "FR" | "GB" | "GL" | "GR" | "GT" | "HK" | "ID" | "IE" | "IL" | "IN" | "IQ" | "IS" | "IT" | "JP" | "KE" | "KR" | "KW" | "LI" | "LT" | "LU" | "LV" | "MA" | "MG" | "ML" | "MO" | "MX" | "MY" | "NI" | "NL" | "NO" | "NZ" | "PE" | "PL" | "PR" | "PT" | "RO" | "RU" | "RW" | "SE" | "SG" | "SK" | "SR" | "SV" | "TH" | "TN" | "TW" | "US" | "VE" | "VI" | "ZA"; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#viewModel) */ viewModel?: ScaleRangeSliderViewModelProperties; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#visibleElements) */ visibleElements?: ScaleRangeSliderVisibleElements; } export class ScaleRanges extends Accessor { /** * The ScaleRanges class represents the ranges of scales for the [ScaleRangeSlider](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRanges.html) */ constructor(properties?: ScaleRangesProperties); /** * Clamps the scale to the closest minScale or maxScale on the scale range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRanges.html#clampScale) */ clampScale(scale: number): number; /** * Determines whether the given scale is within the current scale range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRanges.html#contains) */ contains(scale: number): boolean; /** * Finds the scale range name at a given index. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRanges.html#findScaleRangeByIndex) */ findScaleRangeByIndex(index: number): NamedScaleRange; /** * Helper to create a ScaleRanges object from a minimum and maximum scale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRanges.html#fromScaleRange) */ fromScaleRange(minScale: number, maxScale: number): ScaleRanges; /** * Determines if the input scale value can be considered to be at the smallest scale range edge. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRanges.html#isMaxScaleEdge) */ isMaxScaleEdge(scale: void): boolean; /** * Determines if the input scale value can be considered to be at the largest scale range edge. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRanges.html#isMinScaleEdge) */ isMinScaleEdge(scale: void): boolean; } interface ScaleRangesProperties { } /** * The NamedScaleRange provides the minimum and maximum scale of an named scale id. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRanges.html#NamedScaleRange) */ export interface NamedScaleRange { /** * The named scale range, such as "room" or "metropolitan area". * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRanges.html#NamedScaleRange) */ id: string; /** * The minimum scale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRanges.html#NamedScaleRange) */ minScale: number; /** * The maximum scale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRanges.html#NamedScaleRange) */ maxScale: number; } export class ScaleRangeSliderViewModel extends Accessor { /** * When provided, the initial [minScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#minScale) and [maxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#maxScale) values will match the layer's. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#layer) */ layer: Layer; /** * The maximum scale of the active scale range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#maxScale) */ maxScale: number; /** * The lowest possible maximum scale value from the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#maxScaleLimit) */ maxScaleLimit: number; /** * The minimum scale of the active scale range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#minScale) */ minScale: number; /** * The highest possible minimum scale value from the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#minScaleLimit) */ minScaleLimit: number; /** * The valid scale ranges available based on the slider position. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#scaleRanges) */ readonly scaleRanges: ScaleRanges; /** * The [SliderViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html) for supporting the scale range slider widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#sliderViewModel) */ sliderViewModel: SliderViewModel; /** * The current state of the widget. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#state) */ readonly state: "disabled" | "ready"; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#view) */ view: MapView | SceneView; /** * Provides the logic for the [ScaleRangeSlider](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html) */ constructor(properties?: ScaleRangeSliderViewModelProperties); /** * Utility method for converting scale-to-slider values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#mapScaleToSlider) */ mapScaleToSlider(scale: number): number; /** * Utility method for converting slider-to-scale values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#mapSliderToScale) */ mapSliderToScale(value: number): number; } interface ScaleRangeSliderViewModelProperties { /** * When provided, the initial [minScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#minScale) and [maxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#maxScale) values will match the layer's. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#layer) */ layer?: LayerProperties; /** * The maximum scale of the active scale range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#maxScale) */ maxScale?: number; /** * The lowest possible maximum scale value from the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#maxScaleLimit) */ maxScaleLimit?: number; /** * The minimum scale of the active scale range. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#minScale) */ minScale?: number; /** * The highest possible minimum scale value from the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#minScaleLimit) */ minScaleLimit?: number; /** * The [SliderViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html) for supporting the scale range slider widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#sliderViewModel) */ sliderViewModel?: SliderViewModelProperties; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } /** * The region that the scale thumbnails will focus on. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#SupportedRegion) */ export type SupportedRegion = | "AE" | "AR" | "AT" | "AU" | "BE" | "BG" | "BO" | "BR" | "CA" | "CH" | "CI" | "CL" | "CN" | "CO" | "CR" | "CZ" | "DE" | "DK" | "EE" | "EG" | "ES" | "FI" | "FR" | "GB" | "GL" | "GR" | "GT" | "HK" | "ID" | "IE" | "IL" | "IN" | "IQ" | "IS" | "IT" | "JP" | "KE" | "KR" | "KW" | "LI" | "LT" | "LU" | "LV" | "MA" | "MG" | "ML" | "MO" | "MX" | "MY" | "NI" | "NL" | "NO" | "NZ" | "PE" | "PL" | "PR" | "PT" | "RO" | "RU" | "RW" | "SE" | "SG" | "SK" | "SR" | "SV" | "TH" | "TN" | "TW" | "US" | "VE" | "VI" | "ZA"; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#VisibleElements) */ export interface ScaleRangeSliderVisibleElements { /** * Indicates whether the preview thumbnail of the scale is visible. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#VisibleElements) */ preview?: boolean; /** * _Since 4.24_ Indicates whether the scale dropdown menus are visible. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#VisibleElements) */ scaleMenus?: boolean | VisibleElementsScaleMenus; } export interface VisibleElementsScaleMenus { /** * Indicates whether the minimum scale dropdown menu is visible. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#VisibleElements) */ minScaleMenu?: boolean; /** * Indicates whether the maximum scale dropdown menu is visible. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#VisibleElements) */ maxScaleMenu?: boolean; } export interface widgetsSearch extends Widget, GoTo { } export class widgetsSearch { /** * The current active menu of the Search widget. * * @default none * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#activeMenu) */ activeMenu: "none" | "suggestion" | "source" | "warning"; /** * The [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#sources) object currently selected. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#activeSource) */ readonly activeSource: LayerSearchSource | LocatorSearchSource; /** * The selected source's index. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#activeSourceIndex) */ activeSourceIndex: number; /** * String value used as a hint for input text when searching on multiple sources. * * @default "Find address or place" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#allPlaceholder) */ allPlaceholder: string; /** * The combined collection of [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) and [sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#allSources) */ readonly allSources: Collection; /** * Indicates whether to automatically select and zoom to the first geocoded result. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#autoSelect) */ autoSelect: boolean; /** * A read-only property that is a [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [LayerSearchSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html) and/or [LocatorSearchSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#defaultSources) */ readonly defaultSources: Collection; /** * When true, the widget is visually withdrawn and cannot be interacted with. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#disabled) */ disabled: boolean; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Search#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#iconClass) */ iconClass: string; /** * Indicates whether or not to include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#includeDefaultSources) */ includeDefaultSources: boolean | Function; /** * Enables location services within the widget. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#locationEnabled) */ locationEnabled: boolean; /** * The maximum number of results returned by the widget if not specified by the source. * * @default 6 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#maxResults) */ maxResults: number; /** * The maximum number of suggestions returned by the widget if not specified by the source. * * @default 6 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#maxSuggestions) */ maxSuggestions: number; /** * The minimum number of characters needed for the search if not specified by the source. * * @default 3 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#minSuggestCharacters) */ minSuggestCharacters: number; /** * Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) on feature click. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#popupEnabled) */ popupEnabled: boolean; /** * A customized [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) for the selected feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * It is possible to search a specified portal instance's [locator services](http://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm) Use this property to set this [ArcGIS Portal](https://enterprise.arcgis.com/en/portal/) instance to search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#portal) */ portal: Portal; /** * The graphic used to highlight the resulting feature or location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#resultGraphic) */ readonly resultGraphic: Graphic; /** * Indicates if the [resultGraphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#resultGraphic) will display at the location of the selected feature. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#resultGraphicEnabled) */ resultGraphicEnabled: boolean; /** * An array of objects, each containing a [SearchResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResult) from the search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#results) */ readonly results: any[]; /** * Indicates whether to display the option to search all sources. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#searchAllEnabled) */ searchAllEnabled: boolean; /** * The value of the search box input text string. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#searchTerm) */ searchTerm: string; /** * The result selected from a search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#selectedResult) */ readonly selectedResult: SearchResult; /** * The Search widget may be used to search features in a [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html)/[feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) service feature layer(s), [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) with an associated feature layer, [BuildingComponentSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html) with an associated feature layer, [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html), [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html) or [OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html), or [table](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchTable.html), or geocode locations with a [locator](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#sources) */ sources: Collection; /** * An array of results from the [suggest method](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#suggest). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#suggestions) */ readonly suggestions: SuggestResult[]; /** * Enable suggestions for the widget. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#suggestionsEnabled) */ suggestionsEnabled: boolean; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#viewModel) */ viewModel: SearchViewModel; /** * The Search widget provides a way to perform search operations on [locator service(s)](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html), [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html)/[feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) service feature layer(s), [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) with an associated feature layer, [BuildingComponentSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html) with an associated feature layer, [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html), [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html), [OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html), and/or [table(s)](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchTable.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html) */ constructor(properties?: widgetsSearchProperties); /** * Unfocuses the widget's text input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#blur) */ blur(): void; /** * Clears the current searchTerm, search results, suggest results, graphic, and graphics layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#clear) */ clear(): void; /** * Brings focus to the widget's text input. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#focus) */ focus(): void; /** * Depending on the sources specified, search() queries the feature layer(s) and/or performs address matching using any specified [locator(s)](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html) and returns any applicable results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#search) */ search(searchTerm?: string | Geometry | SuggestResult | number[][]): Promise; /** * Performs a suggest() request on the active Locator. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#suggest) */ suggest(value?: string): Promise; on(name: "search-blur", eventHandler: SearchSearchBlurEventHandler): IHandle; on(name: "search-focus", eventHandler: SearchSearchFocusEventHandler): IHandle; on(name: "search-clear", eventHandler: SearchSearchClearEventHandler): IHandle; on(name: "search-start", eventHandler: SearchSearchStartEventHandler): IHandle; on(name: "suggest-start", eventHandler: SearchSuggestStartEventHandler): IHandle; on(name: "search-complete", eventHandler: SearchSearchCompleteEventHandler): IHandle; on(name: "select-result", eventHandler: SearchSelectResultEventHandler): IHandle; on(name: "suggest-complete", eventHandler: SearchSuggestCompleteEventHandler): IHandle; } interface widgetsSearchProperties extends WidgetProperties, GoToProperties { /** * The current active menu of the Search widget. * * @default none * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#activeMenu) */ activeMenu?: "none" | "suggestion" | "source" | "warning"; /** * The selected source's index. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#activeSourceIndex) */ activeSourceIndex?: number; /** * String value used as a hint for input text when searching on multiple sources. * * @default "Find address or place" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#allPlaceholder) */ allPlaceholder?: string; /** * Indicates whether to automatically select and zoom to the first geocoded result. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#autoSelect) */ autoSelect?: boolean; /** * When true, the widget is visually withdrawn and cannot be interacted with. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#disabled) */ disabled?: boolean; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Search#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#iconClass) */ iconClass?: string; /** * Indicates whether or not to include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#includeDefaultSources) */ includeDefaultSources?: boolean | Function; /** * Enables location services within the widget. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#locationEnabled) */ locationEnabled?: boolean; /** * The maximum number of results returned by the widget if not specified by the source. * * @default 6 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#maxResults) */ maxResults?: number; /** * The maximum number of suggestions returned by the widget if not specified by the source. * * @default 6 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#maxSuggestions) */ maxSuggestions?: number; /** * The minimum number of characters needed for the search if not specified by the source. * * @default 3 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#minSuggestCharacters) */ minSuggestCharacters?: number; /** * Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) on feature click. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#popupEnabled) */ popupEnabled?: boolean; /** * A customized [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) for the selected feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * It is possible to search a specified portal instance's [locator services](http://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm) Use this property to set this [ArcGIS Portal](https://enterprise.arcgis.com/en/portal/) instance to search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#portal) */ portal?: PortalProperties; /** * Indicates if the [resultGraphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#resultGraphic) will display at the location of the selected feature. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#resultGraphicEnabled) */ resultGraphicEnabled?: boolean; /** * Indicates whether to display the option to search all sources. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#searchAllEnabled) */ searchAllEnabled?: boolean; /** * The value of the search box input text string. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#searchTerm) */ searchTerm?: string; /** * The Search widget may be used to search features in a [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html)/[feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) service feature layer(s), [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) with an associated feature layer, [BuildingComponentSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html) with an associated feature layer, [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html), [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html) or [OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html), or [table](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchTable.html), or geocode locations with a [locator](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#sources) */ sources?: CollectionProperties; /** * Enable suggestions for the widget. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#suggestionsEnabled) */ suggestionsEnabled?: boolean; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#viewModel) */ viewModel?: SearchViewModelProperties; } export interface LayerSearchSource extends SearchSource, JSONSupport { } export class LayerSearchSource { /** * The results are displayed using this field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html#displayField) */ displayField: string; /** * Indicates to only return results that match the search value exactly. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html#exactMatch) */ exactMatch: boolean; /** * The layer queried in the search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html#layer) */ layer: Layer; /** * The name of the source for display. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html#name) */ name: string; /** * One or more field names used to order the query results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html#orderByFields) */ orderByFields: string[]; /** * An array of string values representing the names of fields in the feature layer to search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html#searchFields) */ searchFields: string[]; /** * A template string used to display multiple fields in a defined order when results are displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html#searchTemplate) */ searchTemplate: string; /** * A template string used to display multiple fields in a defined order when suggestions are displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html#suggestionTemplate) */ suggestionTemplate: string; /** * The following properties define a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html)-based [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#sources) whose features may be searched by a [Search](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html) widget instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html) */ constructor(properties?: LayerSearchSourceProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html#clone) */ clone(): LayerSearchSource; static fromJSON(json: any): LayerSearchSource; } interface LayerSearchSourceProperties extends SearchSourceProperties { /** * The results are displayed using this field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html#displayField) */ displayField?: string; /** * Indicates to only return results that match the search value exactly. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html#exactMatch) */ exactMatch?: boolean; /** * The layer queried in the search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html#layer) */ layer?: LayerProperties; /** * The name of the source for display. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html#name) */ name?: string; /** * One or more field names used to order the query results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html#orderByFields) */ orderByFields?: string[]; /** * An array of string values representing the names of fields in the feature layer to search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html#searchFields) */ searchFields?: string[]; /** * A template string used to display multiple fields in a defined order when results are displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html#searchTemplate) */ searchTemplate?: string; /** * A template string used to display multiple fields in a defined order when suggestions are displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html#suggestionTemplate) */ suggestionTemplate?: string; } export interface LocatorSearchSource extends SearchSource, JSONSupport { } export class LocatorSearchSource { /** * An authorization string used to access a resource or service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#apiKey) */ apiKey: string; /** * A string array which limits the results to one or more categories. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#categories) */ categories: string[]; /** * Constricts search results to a specified country code. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#countryCode) */ countryCode: string; /** * Sets the scale of the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale) for the resulting search result, if the locator service doesn’t return an extent with a scale. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#defaultZoomScale) */ defaultZoomScale: number; /** * This property controls prioritization of [Search](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html) widget result candidates depending on the view scale. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#localSearchDisabled) */ localSearchDisabled: boolean; /** * Defines the type of location, either `street` or `rooftop`, of the point returned from the [World Geocoding Service](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#locationType) */ locationType: "rooftop" | "street"; /** * The name of the source for display. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#name) */ name: string; /** * A template string used to display multiple fields in a defined order when results are displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#searchTemplate) */ searchTemplate: string; /** * The field name of the Single Line Address Field in the REST services directory for the locator service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#singleLineFieldName) */ singleLineFieldName: string; /** * URL to the ArcGIS Server REST resource that represents a locator service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#url) */ url: string; /** * The following properties define a [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#sources) pointing to a [url](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#url) that represents a locator service, which may be used to geocode locations with a [Search](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html) widget instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html) */ constructor(properties?: LocatorSearchSourceProperties); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#clone) */ clone(): LocatorSearchSource; static fromJSON(json: any): LocatorSearchSource; } interface LocatorSearchSourceProperties extends SearchSourceProperties { /** * An authorization string used to access a resource or service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#apiKey) */ apiKey?: string; /** * A string array which limits the results to one or more categories. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#categories) */ categories?: string[]; /** * Constricts search results to a specified country code. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#countryCode) */ countryCode?: string; /** * Sets the scale of the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale) for the resulting search result, if the locator service doesn’t return an extent with a scale. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#defaultZoomScale) */ defaultZoomScale?: number; /** * This property controls prioritization of [Search](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html) widget result candidates depending on the view scale. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#localSearchDisabled) */ localSearchDisabled?: boolean; /** * Defines the type of location, either `street` or `rooftop`, of the point returned from the [World Geocoding Service](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#locationType) */ locationType?: "rooftop" | "street"; /** * The name of the source for display. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#name) */ name?: string; /** * A template string used to display multiple fields in a defined order when results are displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#searchTemplate) */ searchTemplate?: string; /** * The field name of the Single Line Address Field in the REST services directory for the locator service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#singleLineFieldName) */ singleLineFieldName?: string; /** * URL to the ArcGIS Server REST resource that represents a locator service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#url) */ url?: string; } export class SearchResultRenderer extends Widget { /** * Indicates whether to display the `Show more results` link within the search result's popup. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchResultRenderer.html#showMoreResultsOpen) */ showMoreResultsOpen: boolean; /** * The view model for this Search widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchResultRenderer.html#viewModel) */ viewModel: SearchViewModel; /** * The `SearchResultRenderer` renders the [Search](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html) widget results and allows expanding a DOM element to show alternative matches. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchResultRenderer.html) */ constructor(properties?: SearchResultRendererProperties); } interface SearchResultRendererProperties extends WidgetProperties { /** * Indicates whether to display the `Show more results` link within the search result's popup. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchResultRenderer.html#showMoreResultsOpen) */ showMoreResultsOpen?: boolean; /** * The view model for this Search widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchResultRenderer.html#viewModel) */ viewModel?: SearchViewModelProperties; } export interface SearchSource extends Accessor, JSONSupport, Identifiable { } export class SearchSource { /** * Indicates whether to automatically navigate to the selected result once selected. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#autoNavigate) */ autoNavigate: boolean; /** * For filtering suggests or search results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#filter) */ filter: SearchSourceFilter; /** * Function used to get search results. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#getResults) */ getResults: GetResultsHandler; /** * Function used to get search suggestions. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#getSuggestions) */ getSuggestions: GetSuggestionsParameters; /** * Indicates the maximum number of search results to return. * * @default 6 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#maxResults) */ maxResults: number; /** * Indicates the maximum number of suggestions to return for the widget's input. * * @default 6 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#maxSuggestions) */ maxSuggestions: number; /** * Indicates the minimum number of characters required before querying for a suggestion. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#minSuggestCharacters) */ minSuggestCharacters: number; /** * Specifies the fields returned with the search results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#outFields) */ outFields: string[]; /** * Used as a hint for the source input text. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#placeholder) */ placeholder: string; /** * Indicates whether to display a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) when a selected result is clicked. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#popupEnabled) */ popupEnabled: boolean; /** * The popup template used to display search results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * Specify this to prefix the user's input of the search text. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#prefix) */ prefix: string; /** * Indicates whether to show a graphic on the map for the selected source using the [resultSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#resultSymbol). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#resultGraphicEnabled) */ resultGraphicEnabled: boolean; /** * The symbol used to display the result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#resultSymbol) */ resultSymbol: Symbol; /** * Specify this to add a suffix to the user's input for the search value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#suffix) */ suffix: string; /** * Indicates whether to display suggestions as the user enters input text in the widget. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#suggestionsEnabled) */ suggestionsEnabled: boolean; /** * Indicates whether to constrain the search results to the view's extent. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#withinViewEnabled) */ withinViewEnabled: boolean; /** * The set zoom scale for the resulting search result. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#zoomScale) */ zoomScale: number; /** * The following properties define generic [sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#sources) properties for use in the [Search](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html) */ constructor(properties?: SearchSourceProperties); static fromJSON(json: any): SearchSource; } interface SearchSourceProperties { /** * Indicates whether to automatically navigate to the selected result once selected. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#autoNavigate) */ autoNavigate?: boolean; /** * For filtering suggests or search results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#filter) */ filter?: SearchSourceFilter; /** * Function used to get search results. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#getResults) */ getResults?: GetResultsHandler; /** * Function used to get search suggestions. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#getSuggestions) */ getSuggestions?: GetSuggestionsParameters; /** * Indicates the maximum number of search results to return. * * @default 6 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#maxResults) */ maxResults?: number; /** * Indicates the maximum number of suggestions to return for the widget's input. * * @default 6 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#maxSuggestions) */ maxSuggestions?: number; /** * Indicates the minimum number of characters required before querying for a suggestion. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#minSuggestCharacters) */ minSuggestCharacters?: number; /** * Specifies the fields returned with the search results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#outFields) */ outFields?: string[]; /** * Used as a hint for the source input text. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#placeholder) */ placeholder?: string; /** * Indicates whether to display a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) when a selected result is clicked. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#popupEnabled) */ popupEnabled?: boolean; /** * The popup template used to display search results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * Specify this to prefix the user's input of the search text. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#prefix) */ prefix?: string; /** * Indicates whether to show a graphic on the map for the selected source using the [resultSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#resultSymbol). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#resultGraphicEnabled) */ resultGraphicEnabled?: boolean; /** * The symbol used to display the result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#resultSymbol) */ resultSymbol?: SymbolProperties; /** * Specify this to add a suffix to the user's input for the search value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#suffix) */ suffix?: string; /** * Indicates whether to display suggestions as the user enters input text in the widget. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#suggestionsEnabled) */ suggestionsEnabled?: boolean; /** * Indicates whether to constrain the search results to the view's extent. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#withinViewEnabled) */ withinViewEnabled?: boolean; /** * The set zoom scale for the resulting search result. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#zoomScale) */ zoomScale?: number; } export type GetResultsHandler = (params: any) => Promise; export type GetSuggestionsParameters = (params: any) => Promise; export interface SearchSourceFilter { /** * The where clause specified for filtering suggests or search results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#filter) */ where?: string; /** * The filter geometry for suggests or search results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#filter) */ geometry?: Geometry; } export interface SearchViewModel extends Accessor, Evented, GoTo { } export class SearchViewModel { /** * The [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources) object currently selected. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#activeSource) */ readonly activeSource: LayerSearchSource | LocatorSearchSource; /** * The selected source's index. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#activeSourceIndex) */ activeSourceIndex: number; /** * String value used as a hint for input text when searching on multiple sources. * * @default "Find address or place" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#allPlaceholder) */ allPlaceholder: string; /** * The combined collection of [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) and [sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#allSources) */ readonly allSources: Collection; /** * Indicates whether to automatically select and zoom to the first geocoded result. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#autoSelect) */ autoSelect: boolean; /** * A read-only property that is a [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [LayerSearchSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html) and/or [LocatorSearchSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) */ readonly defaultSources: Collection; /** * The default [symbol(s)](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol.html) for the search result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSymbols) */ defaultSymbols: SearchViewModelDefaultSymbols; /** * Indicates whether or not to include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#includeDefaultSources) */ includeDefaultSources: boolean | Function; /** * Indicates whether location services are enabled within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#locationEnabled) */ locationEnabled: boolean; /** * The maximum character length of the search text. * * @default 128 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#maxInputLength) */ maxInputLength: number; /** * The maximum number of results returned by the widget if not specified by the source. * * @default 6 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#maxResults) */ maxResults: number; /** * The maximum number of suggestions returned by the widget if not specified by the source. * * @default 6 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#maxSuggestions) */ maxSuggestions: number; /** * The minimum number of characters needed for the search if not specified by the source. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#minSuggestCharacters) */ minSuggestCharacters: number; /** * The placeholder used by the [activeSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#activeSource). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#placeholder) */ readonly placeholder: string; /** * Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) on feature click. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#popupEnabled) */ popupEnabled: boolean; /** * A customized [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) for the selected feature. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * It is possible to search a specified portal instance's [locator services](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm) Use this property to set this [ArcGIS Portal](https://enterprise.arcgis.com/en/portal/) instance to search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#portal) */ portal: Portal; /** * The graphic used to highlight the resulting feature or location. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#resultGraphic) */ readonly resultGraphic: Graphic; /** * Indicates if the [resultGraphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#resultGraphic) will display at the location of the selected feature. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#resultGraphicEnabled) */ resultGraphicEnabled: boolean; /** * An array of current results from the search. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#results) */ readonly results: any[]; /** * Indicates whether to display the option to search all sources. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#searchAllEnabled) */ searchAllEnabled: boolean; /** * The value of the search box input text string. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#searchTerm) */ searchTerm: string; /** * The result selected from a search. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#selectedResult) */ readonly selectedResult: any; /** * The selected SuggestResult. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#selectedSuggestion) */ readonly selectedSuggestion: Geometry | SearchViewModelSuggestResult; /** * The Search widget may be used to search features in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or [table](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchTable.html), or geocode locations with a [locator](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources) */ sources: Collection; /** * The current state of the widget. * * @default ready * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#state) */ readonly state: "ready" | "disabled" | "searching" | "loading"; /** * The millisecond delay after keyup and before making a [suggest](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#suggest) network request. * * @default 350 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#suggestionDelay) */ suggestionDelay: number; /** * An array of results from the [suggest method](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#suggest). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#suggestions) */ readonly suggestions: SearchViewModelSuggestResult[]; /** * Enable suggestions for the widget. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#suggestionsEnabled) */ suggestionsEnabled: boolean; /** * Indicates whether the `View` or `Portal` is loading resources prior to use. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#updating) */ readonly updating: boolean; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#view) */ view: MapView | SceneView; /** * Provides the logic for the [Search](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html) widget, which performs search operations on [locator service(s)](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html), [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html)/[feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) service feature layer(s), and/or [table(s)](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchTable.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html) */ constructor(properties?: SearchViewModelProperties); /** * Clears the current value, search results, suggest results, graphic, and graphics layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#clear) */ clear(): void; /** * Depending on the sources specified, `search()` queries the feature layer(s) and/or performs address matching using any specified [Locator(s)](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html) and returns the applicable results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#search) */ search(searchTerm?: string | Geometry | SearchViewModelSuggestResult | number[][]): Promise; /** * Returns search results near your current location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#searchNearby) */ searchNearby(): Promise; /** * Performs a suggest() request on the active Locator. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#suggest) */ suggest(value?: string): Promise; on(name: "search-clear", eventHandler: SearchViewModelSearchClearEventHandler): IHandle; on(name: "search-start", eventHandler: SearchViewModelSearchStartEventHandler): IHandle; on(name: "suggest-start", eventHandler: SearchViewModelSuggestStartEventHandler): IHandle; on(name: "search-complete", eventHandler: SearchViewModelSearchCompleteEventHandler): IHandle; on(name: "select-result", eventHandler: SearchViewModelSelectResultEventHandler): IHandle; on(name: "suggest-complete", eventHandler: SearchViewModelSuggestCompleteEventHandler): IHandle; } interface SearchViewModelProperties extends GoToProperties { /** * The selected source's index. * * @default 0 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#activeSourceIndex) */ activeSourceIndex?: number; /** * String value used as a hint for input text when searching on multiple sources. * * @default "Find address or place" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#allPlaceholder) */ allPlaceholder?: string; /** * Indicates whether to automatically select and zoom to the first geocoded result. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#autoSelect) */ autoSelect?: boolean; /** * The default [symbol(s)](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol.html) for the search result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSymbols) */ defaultSymbols?: SearchViewModelDefaultSymbols; /** * Indicates whether or not to include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#includeDefaultSources) */ includeDefaultSources?: boolean | Function; /** * Indicates whether location services are enabled within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#locationEnabled) */ locationEnabled?: boolean; /** * The maximum character length of the search text. * * @default 128 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#maxInputLength) */ maxInputLength?: number; /** * The maximum number of results returned by the widget if not specified by the source. * * @default 6 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#maxResults) */ maxResults?: number; /** * The maximum number of suggestions returned by the widget if not specified by the source. * * @default 6 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#maxSuggestions) */ maxSuggestions?: number; /** * The minimum number of characters needed for the search if not specified by the source. * * @default 1 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#minSuggestCharacters) */ minSuggestCharacters?: number; /** * Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) on feature click. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#popupEnabled) */ popupEnabled?: boolean; /** * A customized [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) for the selected feature. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * It is possible to search a specified portal instance's [locator services](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm) Use this property to set this [ArcGIS Portal](https://enterprise.arcgis.com/en/portal/) instance to search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#portal) */ portal?: PortalProperties; /** * Indicates if the [resultGraphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#resultGraphic) will display at the location of the selected feature. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#resultGraphicEnabled) */ resultGraphicEnabled?: boolean; /** * Indicates whether to display the option to search all sources. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#searchAllEnabled) */ searchAllEnabled?: boolean; /** * The value of the search box input text string. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#searchTerm) */ searchTerm?: string; /** * The Search widget may be used to search features in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or [table](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchTable.html), or geocode locations with a [locator](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources) */ sources?: CollectionProperties; /** * The millisecond delay after keyup and before making a [suggest](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#suggest) network request. * * @default 350 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#suggestionDelay) */ suggestionDelay?: number; /** * Enable suggestions for the widget. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#suggestionsEnabled) */ suggestionsEnabled?: boolean; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } export interface SearchViewModelSearchClearEvent { } export interface SearchViewModelSearchCompleteEvent { activeSourceIndex: number; errors: Error[]; numResults: number; results: SearchViewModelSearchCompleteEventResults[]; searchTerm: string; } /** * When resolved, returns this response after calling [search](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#search). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResponse) */ export interface SearchViewModelSearchResponse { /** * The index of the source from which the search result was obtained. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResponse) */ activeSourceIndex: number; /** * An array of error objects returned from the search results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResponse) */ errors: Error[]; /** * The number of search results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResponse) */ numResults: number; /** * The searched expression * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResponse) */ searchTerm: string; /** * An array of objects representing the results of search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResponse) */ results: SearchViewModelSearchResponseResults[]; } /** * The result object returned from the [search](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#search). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResult) */ export interface SearchViewModelSearchResult { /** * The extent, or bounding box, of the returned feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResult) */ extent: Extent; /** * The resulting feature or location obtained from the search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResult) */ feature: Graphic; /** * The name of the result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResult) */ name: string; } export interface SearchViewModelSearchStartEvent { } export interface SearchViewModelDefaultSymbols { /** * A [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [PointSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html), [TextSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html), [CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html), or [WebStyleSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html) used for representing the point geometry that is being drawn for the search result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSymbols) */ point?: SimpleMarkerSymbol | PointSymbol3D | TextSymbol | CIMSymbol | WebStyleSymbol; /** * A [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html), [PolygonSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PolygonSymbol3D.html), or [CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html) used for representing the polygon geometry that is being drawn for the search result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSymbols) */ polygon?: SimpleFillSymbol | PolygonSymbol3D | CIMSymbol; /** * A [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), [LineSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3D.html), or [CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html) used for representing the polyline geometry that is being drawn for the search result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSymbols) */ polyline?: SimpleLineSymbol | LineSymbol3D | CIMSymbol; } export interface SearchViewModelSelectResultEvent { result: SearchViewModelSelectResultEventResult; source: any; sourceIndex: number; } export interface SearchViewModelSuggestCompleteEvent { activeSourceIndex: number; errors: Error[]; numResults: number; results: SearchViewModelSuggestCompleteEventResults[]; searchTerm: string; } /** * When resolved, returns this response after calling [suggest](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#suggest). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResponse) */ export interface SearchViewModelSuggestResponse { /** * The index of the source from which suggestions are obtained. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResponse) */ activeSourceIndex: number; /** * An array of error objects returned from the suggest results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResponse) */ errors: Error[]; /** * The number of suggest results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResponse) */ numResults: number; /** * The search expression used for the suggest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResponse) */ searchTerm: string; /** * An array of objects representing the results of suggest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResponse) */ results: SearchViewModelSuggestResponseResults[]; } /** * The result object returned from a [suggest](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#suggest). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResult) */ export interface SearchViewModelSuggestResult { /** * The key related to the suggest result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResult) */ key: string; /** * The string name of the suggested location to geocode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResult) */ text: string; /** * The index of the currently selected result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResult) */ sourceIndex: number; } export interface SearchViewModelSuggestStartEvent { } export interface SearchViewModelSearchCompleteEventResults { results: SearchResult[]; sourceIndex: number; source: any[]; } export interface SearchViewModelSearchResponseResults { /** * An array of search results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResponse) */ results: SearchViewModelSearchResult[]; /** * The index of the currently selected source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResponse) */ sourceIndex: number; /** * The [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources) of the selected result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResponse) */ source: any; } export interface SearchViewModelSelectResultEventResult { extent: Extent; feature: Graphic; name: string; } export interface SearchViewModelSuggestCompleteEventResults { results: SearchViewModelSuggestResult[]; sourceIndex: number; source: any; } export interface SearchViewModelSuggestResponseResults { /** * An array of suggest results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResponse) */ results: SearchViewModelSuggestResult[]; /** * The index of the currently selected source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResponse) */ sourceIndex: number; /** * The [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources) of the selected result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResponse) */ source: any; } export interface SearchSearchBlurEvent { } export interface SearchSearchClearEvent { } export interface SearchSearchCompleteEvent { activeSourceIndex: number; errors: Error[]; numResults: number; results: SearchSearchCompleteEventResults[]; searchTerm: string; } export interface SearchSearchFocusEvent { } /** * When resolved, returns this response after calling [search](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#search). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResponse) */ export interface SearchResponse { /** * The index of the source from which the search result was obtained. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResponse) */ activeSourceIndex: number; /** * An array of error objects returned from the search results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResponse) */ errors: Error[]; /** * The number of search results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResponse) */ numResults: number; /** * The searched expression * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResponse) */ searchTerm: string; /** * An array of objects representing the results of search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResponse) */ results: SearchResponseResults[]; } /** * The result object returned from a [search()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#search). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResult) */ export interface SearchResult { /** * The extent, or bounding box, of the returned feature. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResult) */ extent: Extent; /** * The resulting feature or location obtained from the search. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResult) */ feature: Graphic; /** * The name of the result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResult) */ name: string; /** * The target of the result, which is a [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used for either [MapView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) or [SceneView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) navigation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResult) */ target: Graphic; } export interface SearchSearchStartEvent { } export interface SearchSelectResultEvent { result: SearchSelectResultEventResult; source: any; sourceIndex: number; } export interface SearchSuggestCompleteEvent { activeSourceIndex: number; errors: Error[]; numResults: number; results: SearchSuggestCompleteEventResults[]; searchTerm: string; } /** * When resolved, returns this response after calling [suggest](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#suggest). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResponse) */ export interface SuggestResponse { /** * The index of the source from which suggestions are obtained. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResponse) */ activeSourceIndex: number; /** * An array of error objects returned from the suggest results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResponse) */ errors: Error[]; /** * The number of suggest results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResponse) */ numResults: number; /** * The search expression used for the suggest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResponse) */ searchTerm: string; /** * An array of objects representing the results of suggest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResponse) */ results: SuggestResponseResults[]; } /** * The result object returned from a [suggest()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#suggest). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResult) */ export interface SuggestResult { /** * The key related to the suggest result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResult) */ key: string; /** * The string name of the suggested location to geocode. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResult) */ text: string; /** * The index of the currently selected result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResult) */ sourceIndex: number; } export interface SearchSuggestStartEvent { } export interface SearchSearchCompleteEventResults { results: SearchResult[]; sourceIndex: number; source: any; } export interface SearchResponseResults { /** * An array of search results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResponse) */ results: SearchResult[]; /** * The index of the currently selected source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResponse) */ sourceIndex: number; /** * The [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#sources) of the selected result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResponse) */ source: any; } export interface SearchSelectResultEventResult { extent: Extent; feature: Graphic; name: string; } export interface SearchSuggestCompleteEventResults { results: SuggestResult[]; sourceIndex: number; source: any; } export interface SuggestResponseResults { /** * An array of suggest results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResponse) */ results: SuggestResult[]; /** * The index of the currently selected source. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResponse) */ sourceIndex: number; /** * The [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#sources) of the selected result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResponse) */ source: any; } export class ShadowCast extends Widget { /** * Indicates the heading level to use for the titles "Time range" and "Visualization". * * @default 4 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html#headingLevel) */ headingLevel: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/ShadowCast#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html#iconClass) */ iconClass: string; /** * A reference to the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html#view) */ view: SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html#viewModel) */ viewModel: ShadowCastViewModel; /** * This property provides the ability to display or hide the individual elements of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html#visibleElements) */ visibleElements: ShadowCastVisibleElements; /** * The ShadowCast widget displays the cumulative shadows of 3D features in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html) */ constructor(properties?: ShadowCastProperties); } interface ShadowCastProperties extends WidgetProperties { /** * Indicates the heading level to use for the titles "Time range" and "Visualization". * * @default 4 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html#headingLevel) */ headingLevel?: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/ShadowCast#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html#iconClass) */ iconClass?: string; /** * A reference to the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html#view) */ view?: SceneViewProperties; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html#viewModel) */ viewModel?: ShadowCastViewModelProperties; /** * This property provides the ability to display or hide the individual elements of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html#visibleElements) */ visibleElements?: ShadowCastVisibleElements; } export class ShadowCastViewModel extends Accessor { /** * The calendar date used to calculate the shadow cast. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#date) */ date: Date; /** * The configuration used when the widget's [visualizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType) is set to "discrete". * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#discreteOptions) */ discreteOptions: ShadowCastViewModelDiscreteOptions; /** * The configuration used when the widget's [visualizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType) is set to "duration". * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#durationOptions) */ durationOptions: ShadowCastViewModelDurationOptions; /** * Time (in milliseconds from midnight of the [date](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#date)) when the shadow cast computation should stop. * * @default 16 * 3600 * 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#endTimeOfDay) */ endTimeOfDay: number; /** * Time (in milliseconds from midnight of the [date](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#date)) when the shadow cast computation should start. * * @default 10 * 3600 * 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#startTimeOfDay) */ startTimeOfDay: number; /** * The current state of the view model that can be used for rendering the UI of the widget. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#state) */ readonly state: "disabled" | "ready"; /** * The configuration used when the widget's [visualizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType) is set to "threshold". * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#thresholdOptions) */ thresholdOptions: ShadowCastViewModelThresholdOptions; /** * The difference in hours between UTC time and the times displayed in the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#utcOffset) */ utcOffset: number; /** * A reference to the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#view) */ view: SceneView; /** * Type of visualization to use when showing the shadows. * * @default "threshold" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType) */ visualizationType: "threshold" | "duration" | "discrete"; /** * Provides the logic for the [ShadowCast](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html) */ constructor(properties?: ShadowCastViewModelProperties); /** * Returns the time (in milliseconds) spent in shadow for a certain point on the screen. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#getDuration) */ getDuration(point: SceneViewScreenPoint): number; /** * Starts the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#start) */ start(): void; /** * Stops the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#stop) */ stop(): void; } interface ShadowCastViewModelProperties { /** * The calendar date used to calculate the shadow cast. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#date) */ date?: DateProperties; /** * The configuration used when the widget's [visualizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType) is set to "discrete". * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#discreteOptions) */ discreteOptions?: ShadowCastViewModelDiscreteOptionsProperties; /** * The configuration used when the widget's [visualizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType) is set to "duration". * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#durationOptions) */ durationOptions?: ShadowCastViewModelDurationOptionsProperties; /** * Time (in milliseconds from midnight of the [date](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#date)) when the shadow cast computation should stop. * * @default 16 * 3600 * 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#endTimeOfDay) */ endTimeOfDay?: number; /** * Time (in milliseconds from midnight of the [date](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#date)) when the shadow cast computation should start. * * @default 10 * 3600 * 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#startTimeOfDay) */ startTimeOfDay?: number; /** * The configuration used when the widget's [visualizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType) is set to "threshold". * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#thresholdOptions) */ thresholdOptions?: ShadowCastViewModelThresholdOptionsProperties; /** * The difference in hours between UTC time and the times displayed in the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#utcOffset) */ utcOffset?: number; /** * A reference to the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#view) */ view?: SceneViewProperties; /** * Type of visualization to use when showing the shadows. * * @default "threshold" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType) */ visualizationType?: "threshold" | "duration" | "discrete"; } export interface ShadowCastViewModelDiscreteOptionsProperties { /** * Color of the shadow visualization. * * @default [50, 50, 50, 0.7] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#discreteOptions) */ color?: Color; /** * Individual shadows are displayed at this time interval, starting with the [startTimeOfDay](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#startTimeOfDay). * * @default 15 * 60 * 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#discreteOptions) */ interval?: number; /** * Values (in milliseconds) selectable in the UI for the interval used to display shadows. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#discreteOptions) */ intervalOptions?: CollectionProperties; } export interface ShadowCastViewModelDiscreteOptions extends AnonymousAccessor { /** * Color of the shadow visualization. * * @default [50, 50, 50, 0.7] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#discreteOptions) */ color?: Color; /** * Individual shadows are displayed at this time interval, starting with the [startTimeOfDay](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#startTimeOfDay). * * @default 15 * 60 * 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#discreteOptions) */ interval?: number; /** * Values (in milliseconds) selectable in the UI for the interval used to display shadows. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#discreteOptions) */ intervalOptions?: Collection; } export interface ShadowCastViewModelDurationOptionsProperties { /** * Color of the shadow cast. * * @default [50, 50, 50, 0.7] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#durationOptions) */ color?: Color; /** * Mode in which the cumulative shadow duration should be displayed: as a continuous surface or as an hourly aggregation of values. * * @default "continuous" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#durationOptions) */ mode?: "continuous" | "hourly"; } export interface ShadowCastViewModelDurationOptions extends AnonymousAccessor { /** * Color of the shadow cast. * * @default [50, 50, 50, 0.7] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#durationOptions) */ color?: Color; /** * Mode in which the cumulative shadow duration should be displayed: as a continuous surface or as an hourly aggregation of values. * * @default "continuous" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#durationOptions) */ mode?: "continuous" | "hourly"; } export interface ShadowCastViewModelThresholdOptionsProperties { /** * Color of the shadow visualization. * * @default [255, 0 , 0, 0.7] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#thresholdOptions) */ color?: Color; /** * Time period in milliseconds. * * @default 4 * 3600 * 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#thresholdOptions) */ value?: number; /** * The minimum time period (in milliseconds) selectable in the UI for the threshold value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#thresholdOptions) */ minValue?: number; /** * The maximum time period (in milliseconds) selectable in the UI for the threshold value. * * @default 8 * 3600 * 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#thresholdOptions) */ maxValue?: number; } export interface ShadowCastViewModelThresholdOptions extends AnonymousAccessor { /** * Color of the shadow visualization. * * @default [255, 0 , 0, 0.7] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#thresholdOptions) */ color?: Color; /** * Time period in milliseconds. * * @default 4 * 3600 * 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#thresholdOptions) */ value?: number; /** * The minimum time period (in milliseconds) selectable in the UI for the threshold value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#thresholdOptions) */ minValue?: number; /** * The maximum time period (in milliseconds) selectable in the UI for the threshold value. * * @default 8 * 3600 * 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#thresholdOptions) */ maxValue?: number; } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html#VisibleElements) */ export interface ShadowCastVisibleElements { /** * When set to `false`, the slider used to select a time range for the analysis is not displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html#VisibleElements) */ timeRangeSlider?: boolean; /** * When set to `false`, the dropdown used to select a timezone for the time range is not displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html#VisibleElements) */ timezone?: boolean; /** * When set to `false`, the date picker is not displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html#VisibleElements) */ datePicker?: boolean; /** * When set to `false`, the options for the various visualization modes are not displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html#VisibleElements) */ visualizationOptions?: boolean; /** * When set to `false`, the color picker is not displayed in the options for any of the visualization modes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html#VisibleElements) */ colorPicker?: boolean; /** * When set to `false`, the tooltip with the accumulated shadow time is not displayed when hovering the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html#VisibleElements) */ tooltip?: boolean; } export class Sketch extends Widget { /** * When creating new graphics (for example after [create()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#create) has been called), this property reflects the create tool being used. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#activeTool) */ readonly activeTool: | "point" | "polyline" | "polygon" | "circle" | "rectangle" | "move" | "transform" | "reshape" | "rectangle-selection" | "lasso-selection"; /** * Property controlling the visibility and order of create tool buttons. * * @default ["point", "polyline", "polygon", "rectangle", "circle"] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#availableCreateTools) */ availableCreateTools: string[]; /** * The graphic that is being created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#createGraphic) */ readonly createGraphic: Graphic; /** * Defines the default behavior once the [create](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#create) operation is completed. * * @default continuous * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#creationMode) */ creationMode: "single" | "continuous" | "update"; /** * Default create options set for the Sketch widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultCreateOptions) */ defaultCreateOptions: SketchDefaultCreateOptions; /** * Default update options set for the Sketch widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultUpdateOptions) */ defaultUpdateOptions: SketchDefaultUpdateOptions; /** * The Sketch widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Sketch#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#iconClass) */ iconClass: string; /** * Options to configure the sketch labels shown next to each segment of the geometry being created or updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#labelOptions) */ labelOptions: SketchLabelOptions; /** * The [GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) associated with the Sketch widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#layer) */ layer: GraphicsLayer; /** * Determines the layout/orientation of the Sketch widget. * * @default horizontal * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#layout) */ layout: "vertical" | "horizontal"; /** * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) for sketching. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#snappingOptions) */ snappingOptions: SnappingOptions; /** * The Sketch widget's state. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#state) */ readonly state: "ready" | "disabled" | "active"; /** * Options to configure the tooltip shown next to the cursor when creating or updating graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#tooltipOptions) */ tooltipOptions: SketchTooltipOptions; /** * An array of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) that are being updated by the Sketch widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#updateGraphics) */ readonly updateGraphics: Collection; /** * Options to configure how values are displayed and input when creating or updating graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#valueOptions) */ valueOptions: SketchValueOptions; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#view) */ view: MapView | SceneView; /** * The view model for the Sketch widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#viewModel) */ viewModel: SketchViewModel; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#visibleElements) */ visibleElements: SketchVisibleElements; /** * Sketch widget provides a simple UI for creating and updating graphics on a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html) */ constructor(properties?: SketchProperties); /** * Cancels the active operation and fires the [create](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-create) or [update](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-update) event. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#cancel) */ cancel(): void; /** * Completes the active operation and fires the [create](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-create) or [update](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-update) event and changes the event's state to `complete`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#complete) */ complete(): void; /** * Create a graphic with the geometry specified in the `tool` parameter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#create) */ create(tool: "point" | "polyline" | "polygon" | "rectangle" | "circle", createOptions?: SketchCreateCreateOptions): void; /** * Deletes the selected graphics used in the update workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#delete) */ delete(): void; /** * Duplicates current graphics used in the update workflow and automatically adds them to the associated layer * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#duplicate) */ duplicate(): void; /** * Incrementally redo actions recorded in the stack. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#redo) */ redo(): void; /** * Incrementally undo actions recorded in the stack. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#undo) */ undo(): void; /** * Initializes an update operation for the specified graphic(s) and fires [update](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-update) event. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#update) */ update(graphics: Graphic | Graphic[], updateOptions?: SketchUpdateUpdateOptions): Promise; on(name: "delete", eventHandler: SketchDeleteEventHandler): IHandle; on(name: "create", eventHandler: SketchCreateEventHandler): IHandle; on(name: "update", eventHandler: SketchUpdateEventHandler): IHandle; on(name: "redo", eventHandler: SketchRedoEventHandler): IHandle; on(name: "undo", eventHandler: SketchUndoEventHandler): IHandle; } interface SketchProperties extends WidgetProperties { /** * Property controlling the visibility and order of create tool buttons. * * @default ["point", "polyline", "polygon", "rectangle", "circle"] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#availableCreateTools) */ availableCreateTools?: string[]; /** * Defines the default behavior once the [create](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#create) operation is completed. * * @default continuous * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#creationMode) */ creationMode?: "single" | "continuous" | "update"; /** * Default create options set for the Sketch widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultCreateOptions) */ defaultCreateOptions?: SketchDefaultCreateOptions; /** * Default update options set for the Sketch widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultUpdateOptions) */ defaultUpdateOptions?: SketchDefaultUpdateOptions; /** * The Sketch widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Sketch#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#iconClass) */ iconClass?: string; /** * Options to configure the sketch labels shown next to each segment of the geometry being created or updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#labelOptions) */ labelOptions?: SketchLabelOptionsProperties; /** * The [GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) associated with the Sketch widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#layer) */ layer?: GraphicsLayerProperties; /** * Determines the layout/orientation of the Sketch widget. * * @default horizontal * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#layout) */ layout?: "vertical" | "horizontal"; /** * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) for sketching. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#snappingOptions) */ snappingOptions?: SnappingOptionsProperties; /** * Options to configure the tooltip shown next to the cursor when creating or updating graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#tooltipOptions) */ tooltipOptions?: SketchTooltipOptionsProperties; /** * Options to configure how values are displayed and input when creating or updating graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#valueOptions) */ valueOptions?: SketchValueOptionsProperties; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for the Sketch widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#viewModel) */ viewModel?: SketchViewModelProperties; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#visibleElements) */ visibleElements?: SketchVisibleElements; } export interface SketchViewModel extends Accessor, Evented { } export class SketchViewModel { /** * The [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html) displayed when actively creating a new `polygon` graphic using the [`polygon`](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#activeTool) tool. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#activeFillSymbol) */ activeFillSymbol: SimpleFillSymbol; /** * When creating new graphics (for example after [create()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#create) has been called), this property reflects the create tool being used. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#activeTool) */ readonly activeTool: | "point" | "multipoint" | "polyline" | "polygon" | "circle" | "mesh" | "rectangle" | "move" | "transform" | "reshape"; /** * The graphic that is being created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#createGraphic) */ readonly createGraphic: Graphic; /** * Default create options set for the SketchViewModel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#defaultCreateOptions) */ defaultCreateOptions: SketchViewModelDefaultCreateOptions; /** * Default update options set for the SketchViewModel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#defaultUpdateOptions) */ defaultUpdateOptions: SketchViewModelDefaultUpdateOptions; /** * Options to configure the sketch labels shown next to each segment of the geometry being created or updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#labelOptions) */ labelOptions: SketchLabelOptions; /** * The [GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) associated with the SketchViewModel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#layer) */ layer: GraphicsLayer; /** * A [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [PointSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html), [TextSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html), [CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html), or [WebStyleSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html) used for representing the point geometry that is being drawn. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#pointSymbol) */ pointSymbol: SimpleMarkerSymbol | PointSymbol3D | TextSymbol | CIMSymbol | WebStyleSymbol; /** * A [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html), [PolygonSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PolygonSymbol3D.html), or [CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html) used for representing the polygon geometry that is being drawn. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#polygonSymbol) */ polygonSymbol: SimpleFillSymbol | PolygonSymbol3D | CIMSymbol; /** * A [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), [LineSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3D.html), or [CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html) used for representing the polyline geometry that is being drawn. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#polylineSymbol) */ polylineSymbol: SimpleLineSymbol | LineSymbol3D | CIMSymbol; /** * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) for sketching. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#snappingOptions) */ snappingOptions: SnappingOptions; /** * The sketch view model's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#state) */ readonly state: "ready" | "disabled" | "active"; /** * Options to configure the tooltip shown next to the cursor when creating or updating graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#tooltipOptions) */ tooltipOptions: SketchTooltipOptions; /** * An array of graphics that are being updated by the SketchViewModel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#updateGraphics) */ readonly updateGraphics: Collection; /** * Indicates if a graphic can be selected to be updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#updateOnGraphicClick) */ updateOnGraphicClick: boolean; /** * Options to configure how values are displayed and input when creating or updating graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#valueOptions) */ valueOptions: SketchValueOptions; /** * The view in which geometries will be sketched by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#view) */ view: MapView | SceneView; /** * Provides the logic for the [Sketch](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html) */ constructor(properties?: SketchViewModelProperties); /** * Cancels the active operation and fires the [create](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#event-create) or [update](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#event-update) event If called in the middle of a create operation, `cancel()` discards the partially created graphic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#cancel) */ cancel(): void; /** * Indicates if it is possible to perform a [redo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#redo) action in the current update session. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#canRedo) */ canRedo(): boolean; /** * Indicates if it is possible to perform an [undo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#undo) action in the current update session. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#canUndo) */ canUndo(): boolean; /** * Completes the active operation and fires the [create](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#event-create) or [update](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#event-update) event and changes the event's state to `complete`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#complete) */ complete(): void; /** * Create a graphic with the geometry specified in the `tool` parameter. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#create) */ create(tool: "point" | "multipoint" | "polyline" | "polygon" | "rectangle" | "circle" | "mesh", createOptions?: SketchViewModelCreateCreateOptions): void; /** * Deletes the selected graphics used in the update workflow. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#delete) */ delete(): void; /** * Duplicates current graphics used in the update workflow and automatically adds them to the associated layer * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#duplicate) */ duplicate(): void; /** * Allows creation of a graphic similar to create with the difference that the geometry can be provided directly for the graphic being created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#place) */ place(geometry: Mesh): void; /** * Incrementally redo actions recorded in the stack. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#redo) */ redo(): void; /** * Incrementally undo actions recorded in the stack. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#undo) */ undo(): void; /** * Initializes an update operation for the specified graphic(s) and fires [update](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#event-update) event. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#update) */ update(graphics: Graphic | Graphic[], updateOptions?: SketchViewModelUpdateUpdateOptions): Promise; on(name: "delete", eventHandler: SketchViewModelDeleteEventHandler): IHandle; on(name: "create", eventHandler: SketchViewModelCreateEventHandler): IHandle; on(name: "update", eventHandler: SketchViewModelUpdateEventHandler): IHandle; on(name: "redo", eventHandler: SketchViewModelRedoEventHandler): IHandle; on(name: "undo", eventHandler: SketchViewModelUndoEventHandler): IHandle; } interface SketchViewModelProperties { /** * The [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html) displayed when actively creating a new `polygon` graphic using the [`polygon`](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#activeTool) tool. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#activeFillSymbol) */ activeFillSymbol?: SimpleFillSymbolProperties; /** * Default create options set for the SketchViewModel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#defaultCreateOptions) */ defaultCreateOptions?: SketchViewModelDefaultCreateOptions; /** * Default update options set for the SketchViewModel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#defaultUpdateOptions) */ defaultUpdateOptions?: SketchViewModelDefaultUpdateOptions; /** * Options to configure the sketch labels shown next to each segment of the geometry being created or updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#labelOptions) */ labelOptions?: SketchLabelOptionsProperties; /** * The [GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) associated with the SketchViewModel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#layer) */ layer?: GraphicsLayerProperties; /** * A [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [PointSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html), [TextSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html), [CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html), or [WebStyleSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html) used for representing the point geometry that is being drawn. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#pointSymbol) */ pointSymbol?: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (TextSymbolProperties & { type: "text" }) | (CIMSymbolProperties & { type: "cim" }) | (WebStyleSymbolProperties & { type: "web-style" }); /** * A [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html), [PolygonSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PolygonSymbol3D.html), or [CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html) used for representing the polygon geometry that is being drawn. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#polygonSymbol) */ polygonSymbol?: | (SimpleFillSymbolProperties & { type: "simple-fill" }) | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (CIMSymbolProperties & { type: "cim" }); /** * A [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), [LineSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3D.html), or [CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html) used for representing the polyline geometry that is being drawn. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#polylineSymbol) */ polylineSymbol?: | (SimpleLineSymbolProperties & { type: "simple-line" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (CIMSymbolProperties & { type: "cim" }); /** * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) for sketching. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#snappingOptions) */ snappingOptions?: SnappingOptionsProperties; /** * Options to configure the tooltip shown next to the cursor when creating or updating graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#tooltipOptions) */ tooltipOptions?: SketchTooltipOptionsProperties; /** * Indicates if a graphic can be selected to be updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#updateOnGraphicClick) */ updateOnGraphicClick?: boolean; /** * Options to configure how values are displayed and input when creating or updating graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#valueOptions) */ valueOptions?: SketchValueOptionsProperties; /** * The view in which geometries will be sketched by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } export interface SketchViewModelCreateEvent { graphic: Graphic; state: "start" | "active" | "complete" | "cancel"; tool: "point" | "multipoint" | "polyline" | "polygon" | "rectangle" | "circle" | "mesh"; toolEventInfo: CreateToolEventInfo; type: "create"; } export interface SketchViewModelDeleteEvent { graphics: Graphic[]; tool: "move" | "reshape" | "transform"; type: "delete"; } export interface SketchViewModelRedoEvent { graphics: Graphic[]; tool: | "point" | "multipoint" | "polyline" | "polygon" | "rectangle" | "circle" | "mesh" | "move" | "transform" | "reshape"; type: "redo"; } export interface SketchViewModelCreateCreateOptions { /** * The default z-value of the newly created geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#create) */ defaultZ?: number; /** * Controls whether the created geometry has z-values or not. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#create) */ hasZ?: boolean; /** * Specifies how the graphic can be created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#create) */ mode?: "hybrid" | "freehand" | "click"; /** * Controls whether or not the width and height of the drawn geometry are kept equal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#create) */ preserveAspectRatio?: boolean; } export interface SketchViewModelDefaultCreateOptions { /** * The default z-value of the newly created geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#defaultCreateOptions) */ defaultZ?: number; /** * Controls whether the created geometry has z-values or not. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#defaultCreateOptions) */ hasZ?: boolean; /** * Create operation mode how the graphic can be created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#defaultCreateOptions) */ mode?: "hybrid" | "freehand" | "click"; /** * Controls whether or not the width and height of the drawn geometry are kept equal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#defaultCreateOptions) */ preserveAspectRatio?: boolean; } export interface SketchViewModelDefaultUpdateOptions { /** * Name of the update tool. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#defaultUpdateOptions) */ tool?: "move" | "transform" | "reshape"; /** * Indicates if the `rotation` operation will be enabled when updating graphics. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#defaultUpdateOptions) */ enableRotation?: boolean; /** * Indicates if the `scale` operation will be enabled when updating graphics. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#defaultUpdateOptions) */ enableScaling?: boolean; /** * Indicates if z-values can be modified when updating the graphic. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#defaultUpdateOptions) */ enableZ?: boolean; /** * Indicates whether more than one selection can be made at once. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#defaultUpdateOptions) */ multipleSelectionEnabled?: boolean; /** * Indicates if the uniform scale operation will be enabled when updating graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#defaultUpdateOptions) */ preserveAspectRatio?: boolean; /** * Indicates if the graphic being updated can be toggled between `transform` and `reshape` update options. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#defaultUpdateOptions) */ toggleToolOnClick?: boolean; /** * Changes the behavior for the `reshape` tool. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#defaultUpdateOptions) */ reshapeOptions?: SketchViewModelDefaultUpdateOptionsReshapeOptions; /** * Options that control when to display or hide highlights for update operations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#defaultUpdateOptions) */ highlightOptions?: SketchViewModelDefaultUpdateOptionsHighlightOptions; } export interface SketchViewModelDefaultUpdateOptionsHighlightOptions { /** * Indicates if highlighting is enabled for update operations. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#defaultUpdateOptions) */ enabled?: boolean; } export interface SketchViewModelDefaultUpdateOptionsReshapeOptions { /** * Sets the reshape operation on the edge. * * @default "split" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#defaultUpdateOptions) */ edgeOperation?: "none" | "split" | "offset"; /** * Sets the move constraints for the whole shape. * * @default "move" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#defaultUpdateOptions) */ shapeOperation?: "none" | "move" | "move-xy"; /** * Sets the move constraints for the vertex. * * @default "move" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#defaultUpdateOptions) */ vertexOperation?: "move" | "move-xy"; } export interface SketchViewModelUpdateUpdateOptions { /** * Name of the update tool. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#update) */ tool?: "transform" | "reshape" | "move"; /** * Indicates if the `rotation` operation will be enabled when updating graphics. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#update) */ enableRotation?: boolean; /** * Indicates if the `scale` operation will be enabled when updating graphics. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#update) */ enableScaling?: boolean; /** * Indicates if z-values can be modified when updating the graphic. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#update) */ enableZ?: boolean; /** * Indicates whether more than one selection can be made at once. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#update) */ multipleSelectionEnabled?: boolean; /** * Indicates if the uniform scale operation will be enabled when updating graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#update) */ preserveAspectRatio?: boolean; /** * Indicates if the graphic being updated can be toggled between `transform` and `reshape` update options. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#update) */ toggleToolOnClick?: boolean; } export interface SketchViewModelUndoEvent { graphics: Graphic[]; tool: | "point" | "multipoint" | "polyline" | "polygon" | "rectangle" | "circle" | "mesh" | "move" | "transform" | "reshape"; type: "undo"; } export interface SketchViewModelUpdateEvent { aborted: boolean; graphics: Graphic[]; state: "start" | "active" | "complete"; tool: "move" | "transform" | "reshape"; toolEventInfo: UpdateToolEventInfo; type: "update"; } export interface SketchCreateEvent { graphic: Graphic; state: "start" | "active" | "complete" | "cancel"; tool: "point" | "polyline" | "polygon" | "rectangle" | "circle"; toolEventInfo: CreateToolEventInfo; type: "create"; } /** * This information is returned as `toolEventInfo` parameter for the [create](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-create) event when the graphic is being created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#CreateToolEventInfo) */ export type CreateToolEventInfo = VertexAddEventInfo | CursorUpdateEventInfo; /** * This information is returned as `toolEventInfo` parameter for the [create](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-create) event when the user moves the cursor on the view while the graphic is being created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#CursorUpdateEventInfo) */ export interface CursorUpdateEventInfo { type: "cursor-update"; /** * An array of numbers representing the coordinates of the cursor location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#CursorUpdateEventInfo) */ coordinates: number[]; } export interface SketchDeleteEvent { graphics: Graphic[]; tool: "move" | "reshape" | "transform"; type: "delete"; } /** * This information is returned as `toolEventInfo` parameter for the [update](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-update) event while the user is moving the graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#MoveEventInfo) */ export interface MoveEventInfo { /** * Returns information indicating the stage of the move operation. * * [Read more...](global.html#type) */ type: "move-start" | "move" | "move-stop"; /** * Number of pixels moved on the x-axis from the last known position. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#MoveEventInfo) */ dx: number; /** * Number of pixels moved on the y-axis from the last known position. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#MoveEventInfo) */ dy: number; /** * The instance of the graphic that is being moved. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#MoveEventInfo) */ mover: Graphic; } export interface SketchRedoEvent { graphics: Graphic[]; tool: "point" | "polyline" | "polygon" | "rectangle" | "circle" | "move" | "transform" | "reshape"; type: "redo"; } /** * This information is returned as `toolEventInfo` parameter for the [update](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-update) event while the user is reshaping the graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#ReshapeEventInfo) */ export interface ReshapeEventInfo { /** * Returns information indicating the stage of the reshape operation. * * [Read more...](global.html#type) */ type: "reshape-start" | "reshape" | "reshape-stop"; } /** * This information is returned as `toolEventInfo` parameter for the [update](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-update) event while the user is rotating the graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#RotateEventInfo) */ export interface RotateEventInfo { /** * Returns information indicating the stage of the rotate operation. * * [Read more...](global.html#type) */ type: "rotate-start" | "rotate" | "rotate-stop"; /** * Angle of rotation in degrees. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#RotateEventInfo) */ angle: number; } /** * This information is returned as `toolEventInfo` parameter for the [update](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-update) event while the user is scaling or resizing the graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#ScaleEventInfo) */ export interface ScaleEventInfo { /** * Returns information indicating the stage of the scale operation. * * [Read more...](global.html#type) */ type: "scale-start" | "scale" | "scale-stop"; /** * The x scale factor used to enlarge or shrink the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#ScaleEventInfo) */ xScale: number; /** * The y scale factor used to enlarge or shrink the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#ScaleEventInfo) */ yScale: number; } /** * This information is returned as `toolEventInfo` parameter for the [update](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-update) event while the user is selecting or deselecting graphics using `Shift+Left-click`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#SelectionChangeEventInfo) */ export interface SelectionChangeEventInfo { type: "selection-change"; /** * An array of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) representing the latest graphic selected. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#SelectionChangeEventInfo) */ added: Graphic[]; /** * An array of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) representing the latest graphic deselected. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#SelectionChangeEventInfo) */ removed: Graphic[]; } export interface SketchCreateCreateOptions { /** * The default z-value of the newly created geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#create) */ defaultZ?: number; /** * Controls whether the created geometry has z-values or not. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#create) */ hasZ?: boolean; /** * Specifies how the graphic can be created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#create) */ mode?: "hybrid" | "freehand" | "click"; /** * Controls whether or not the width and height of the drawn geometry are kept equal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#create) */ preserveAspectRatio?: boolean; } export interface SketchDefaultCreateOptions { /** * The default z-value of the newly created geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultCreateOptions) */ defaultZ?: number; /** * Controls whether the created geometry has z-values or not. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultCreateOptions) */ hasZ?: boolean; /** * Create operation mode how the graphic can be created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultCreateOptions) */ mode?: "hybrid" | "freehand" | "click"; /** * Controls whether or not the width and height of the drawn geometry are kept equal. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultCreateOptions) */ preserveAspectRatio?: boolean; } export interface SketchDefaultUpdateOptions { /** * Name of the update tool. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultUpdateOptions) */ tool?: "move" | "transform" | "reshape"; /** * Indicates if the `rotation` operation will be enabled when updating graphics. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultUpdateOptions) */ enableRotation?: boolean; /** * Indicates if the `scale` operation will be enabled when updating graphics. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultUpdateOptions) */ enableScaling?: boolean; /** * Indicates if z-values can be modified when updating the graphic. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultUpdateOptions) */ enableZ?: boolean; /** * Indicates whether more than one selection can be made at once. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultUpdateOptions) */ multipleSelectionEnabled?: boolean; /** * Indicates if the uniform scale operation will be enabled when updating graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultUpdateOptions) */ preserveAspectRatio?: boolean; /** * Indicates if the graphic being updated can be toggled between `transform` and `reshape` update options. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultUpdateOptions) */ toggleToolOnClick?: boolean; /** * Changes the behavior for the `reshape` tool. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultUpdateOptions) */ reshapeOptions?: SketchDefaultUpdateOptionsReshapeOptions; /** * Options that control when to display or hide highlights for update operations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultUpdateOptions) */ highlightOptions?: SketchDefaultUpdateOptionsHighlightOptions; } export interface SketchDefaultUpdateOptionsHighlightOptions { /** * Indicates if highlighting is enabled for update operations. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultUpdateOptions) */ enabled?: boolean; } export interface SketchDefaultUpdateOptionsReshapeOptions { /** * Sets the reshape operation on the edge. * * @default "split" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultUpdateOptions) */ edgeOperation?: "none" | "split" | "offset"; /** * Sets the move constraints for the whole shape. * * @default "move" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultUpdateOptions) */ shapeOperation?: "none" | "move" | "move-xy"; /** * Sets the move constraints for the vertex. * * @default "move" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultUpdateOptions) */ vertexOperation?: "move" | "move-xy"; } export interface SketchUpdateUpdateOptions { /** * Name of the update tool. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#update) */ tool?: "transform" | "reshape" | "move"; /** * Indicates if the `rotation` operation will be enabled when updating graphics. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#update) */ enableRotation?: boolean; /** * Indicates if the `scale` operation will be enabled when updating graphics. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#update) */ enableScaling?: boolean; /** * Indicates if z-values can be modified when updating the graphic. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#update) */ enableZ?: boolean; /** * Indicates whether more than one selection can be made at once. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#update) */ multipleSelectionEnabled?: boolean; /** * Indicates if the uniform scale operation will be enabled when updating graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#update) */ preserveAspectRatio?: boolean; /** * Indicates if the graphic being updated can be toggled between `transform` and `reshape` update options. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#update) */ toggleToolOnClick?: boolean; } export interface SketchUndoEvent { graphics: Graphic[]; tool: "point" | "polyline" | "polygon" | "rectangle" | "circle" | "move" | "transform" | "reshape"; type: "undo"; } export interface SketchUpdateEvent { aborted: boolean; graphics: Graphic[]; state: "start" | "active" | "complete"; tool: "move" | "transform" | "reshape"; toolEventInfo: UpdateToolEventInfo; type: "update"; } /** * This information is returned as `toolEventInfo` parameter for the [update](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-update) event when the user is updating graphics. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#UpdateToolEventInfo) */ export type UpdateToolEventInfo = | MoveEventInfo | ReshapeEventInfo | RotateEventInfo | ScaleEventInfo | SelectionChangeEventInfo | VertexAddEventInfo | VertexRemoveEventInfo; /** * This information is returned as `toolEventInfo` parameter for the [create](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-create) or [update](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-update) event when the user adds vertices to the graphic being created or updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VertexAddEventInfo) */ export interface VertexAddEventInfo { type: "vertex-add"; /** * An array of x,y coordinates representing the vertices added. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VertexAddEventInfo) */ added: number[]; /** * Contains the details of the added vertices to track changes in topology of the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VertexAddEventInfo) */ vertices: VertexAddEventInfoVertices[]; } /** * This information is returned as `toolEventInfo` parameter for the [update](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-update) event when the user is removing vertices from the graphic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VertexRemoveEventInfo) */ export interface VertexRemoveEventInfo { type: "vertex-remove"; /** * An array of x,y coordinates representing the vertices removed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VertexRemoveEventInfo) */ removed: number[]; /** * Contains the details of the removed vertices to track changes in topology of the geometry. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VertexRemoveEventInfo) */ vertices: VertexRemoveEventInfoVertices[]; } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VisibleElements) */ export interface SketchVisibleElements { /** * The available sketch tools within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VisibleElements) */ createTools?: VisibleElementsCreateTools; /** * Indicates whether to display the 'duplicate' button while a graphic is selected. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VisibleElements) */ duplicateButton?: boolean; /** * The available selection tools within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VisibleElements) */ selectionTools?: VisibleElementsSelectionTools; /** * Indicates whether to display the settings menu. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VisibleElements) */ settingsMenu?: boolean; /** * _Since 4.29_. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VisibleElements) */ labelsToggle?: boolean; /** * _Since 4.29_. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VisibleElements) */ tooltipsToggle?: boolean; /** * Indicates whether to display the `SnappingControls` widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VisibleElements) */ snappingControls?: boolean; /** * The available [SnappingControls](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html) elements within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VisibleElements) */ snappingControlsElements?: SketchVisibleElementsSnappingControlsElements; /** * Indicates whether to display the undo/redo menu within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VisibleElements) */ undoRedoMenu?: boolean; } export interface VertexAddEventInfoVertices { /** * An array of x,y coordinates representing the vertices added. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VertexAddEventInfo) */ coordinates: number[]; /** * The ring/path index of the added vertex. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VertexAddEventInfo) */ componentIndex: number; /** * The index of the vertex position. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VertexAddEventInfo) */ vertexIndex: number; } export interface VertexRemoveEventInfoVertices { /** * An array of x,y coordinates representing the vertices removed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VertexRemoveEventInfo) */ coordinates: number[]; /** * The ring/path index of the removed vertex. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VertexRemoveEventInfo) */ componentIndex: number; /** * The index of the vertex position. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VertexRemoveEventInfo) */ vertexIndex: number; } export interface VisibleElementsCreateTools { /** * Indicates whether to display the point sketch tool. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VisibleElements) */ point?: boolean; /** * Indicates whether to display the polyline sketch tool. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VisibleElements) */ polyline?: boolean; /** * Indicates whether to display the polygon sketch tool. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VisibleElements) */ polygon?: boolean; /** * Indicates whether to display the rectangle sketch tool. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VisibleElements) */ rectangle?: boolean; /** * Indicates whether to display the circle sketch tool. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VisibleElements) */ circle?: boolean; } export interface VisibleElementsSelectionTools { /** * Indicates whether to display the `"rectangle-selection"` tool. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VisibleElements) */ "rectangle-selection"?: boolean; /** * Indicates whether to display the `"lasso-selection"` tool. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VisibleElements) */ "lasso-selection"?: boolean; } export interface SketchVisibleElementsSnappingControlsElements { /** * Indicates whether to display the header. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VisibleElements) */ header?: boolean; /** * Indicates whether to display the `enabledToggle` (Enable snapping). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VisibleElements) */ enabledToggle?: boolean; /** * Indicates whether to display the `selfEnabledToggle` (Geometry guides). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VisibleElements) */ selfEnabledToggle?: boolean; /** * Indicates whether to display the `featureEnabledToggle` (Feature to feature). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VisibleElements) */ featureEnabledToggle?: boolean; /** * Indicates whether to display the [FeatureSnappingLayerSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-FeatureSnappingLayerSource.html) layerList. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#VisibleElements) */ layerList?: boolean; } export class Slice extends Widget { /** * The slice analysis object being created or modified by the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice.html#analysis) */ readonly analysis: SliceAnalysis; /** * Indicates the heading level to use for the "Excluded layers" heading. * * @default 3 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice.html#headingLevel) */ headingLevel: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Slice#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice.html#iconClass) */ iconClass: string; /** * A reference to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice.html#view) */ view: SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice.html#viewModel) */ viewModel: SliceViewModel; /** * The Slice widget is a 3D analysis tool that can be used to reveal occluded content in a {@link module:esri/views/SceneView}. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice.html) */ constructor(properties?: SliceProperties); } interface SliceProperties extends WidgetProperties { /** * The slice analysis object being created or modified by the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice.html#analysis) */ analysis?: SliceAnalysisProperties; /** * Indicates the heading level to use for the "Excluded layers" heading. * * @default 3 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice.html#headingLevel) */ headingLevel?: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Slice#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice.html#iconClass) */ iconClass?: string; /** * A reference to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice.html#view) */ view?: SceneViewProperties; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice.html#viewModel) */ viewModel?: SliceViewModelProperties; } export class SliceViewModel extends Accessor { /** * The slice analysis object being created or modified by the view model. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice-SliceViewModel.html#analysis) */ readonly analysis: SliceAnalysis; /** * Add layers to this collection to exclude them from the slice. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice-SliceViewModel.html#excludedLayers) */ excludedLayers: Collection; /** * Indicates whether the [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html) and layers that are draped on the ground surface are excluded from the slice. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice-SliceViewModel.html#excludeGroundSurface) */ excludeGroundSurface: boolean; /** * The shape used to slice elements in a 3D scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice-SliceViewModel.html#shape) */ shape: SlicePlane; /** * The view model's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice-SliceViewModel.html#state) */ readonly state: "disabled" | "ready" | "slicing" | "sliced"; /** * Enable tilting the slice shape. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice-SliceViewModel.html#tiltEnabled) */ tiltEnabled: boolean; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice-SliceViewModel.html#view) */ view: SceneView; /** * Provides the logic for the [Slice](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice-SliceViewModel.html) */ constructor(properties?: SliceViewModelProperties); /** * Clears the [shape](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice-SliceViewModel.html#shape) of the slice, effectively removing it from the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice-SliceViewModel.html#clear) */ clear(): void; /** * Starts the interactive creation of a new slice, clearing the previous [shape](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice-SliceViewModel.html#shape). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice-SliceViewModel.html#start) */ start(): void; } interface SliceViewModelProperties { /** * The slice analysis object being created or modified by the view model. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice-SliceViewModel.html#analysis) */ analysis?: SliceAnalysisProperties; /** * Add layers to this collection to exclude them from the slice. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice-SliceViewModel.html#excludedLayers) */ excludedLayers?: CollectionProperties< LayerProperties | (BuildingComponentSublayerProperties & { type: "building-component" }) >; /** * Indicates whether the [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html) and layers that are draped on the ground surface are excluded from the slice. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice-SliceViewModel.html#excludeGroundSurface) */ excludeGroundSurface?: boolean; /** * The shape used to slice elements in a 3D scene. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice-SliceViewModel.html#shape) */ shape?: SlicePlaneProperties; /** * Enable tilting the slice shape. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice-SliceViewModel.html#tiltEnabled) */ tiltEnabled?: boolean; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice-SliceViewModel.html#view) */ view?: SceneViewProperties; } export class Slider extends Widget { /** * When `true`, sets the slider to a disabled state so the user cannot interact with it. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#disabled) */ disabled: boolean; /** * Indicates if the user can drag the segment between thumbs to update thumb positions. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#draggableSegmentsEnabled) */ draggableSegmentsEnabled: boolean; /** * When set, the user is restricted from moving slider thumbs to positions higher than this value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#effectiveMax) */ effectiveMax: number; /** * When set, the user is restricted from moving slider thumbs to positions less than this value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#effectiveMin) */ effectiveMin: number; /** * The HTML Element nodes representing the slider segment between the [min](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#min) and [effectiveMin](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#effectiveMin), and the segment between the [effectiveMax](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#effectiveMax) and [max](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#max). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#effectiveSegmentElements) */ readonly effectiveSegmentElements: Collection; /** * A function that provides the developer with access to the input elements when [rangeLabelInputsEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#rangeLabelInputsEnabled) and/or [labelInputsEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#labelInputsEnabled) are set to `true`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#inputCreatedFunction) */ inputCreatedFunction: InputCreatedFunction; /** * A function used to format user inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#inputFormatFunction) */ inputFormatFunction: SliderLabelFormatter; /** * Function used to parse slider inputs formatted by the [inputFormatFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#inputFormatFunction). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#inputParseFunction) */ inputParseFunction: InputParser; /** * The HTML Element nodes representing [labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#labels) attached to slider thumbs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#labelElements) */ readonly labelElements: Collection; /** * A function used to format labels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#labelFormatFunction) */ labelFormatFunction: SliderLabelFormatter; /** * Indicates whether to enable editing input values via keyboard input when the user clicks a label. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#labelInputsEnabled) */ labelInputsEnabled: boolean; /** * An array of strings associated with 'values' generated using an internal label formatter or the values returned from [labelFormatFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#labelFormatFunction). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#labels) */ readonly labels: string[]; /** * Determines the layout/orientation of the Slider widget. * * @default horizontal * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#layout) */ layout: "horizontal" | "horizontal-reversed" | "vertical" | "vertical-reversed"; /** * The maximum possible data/thumb value of the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#max) */ max: number; /** * The HTML Element node representing the [max](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#max) value label. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#maxLabelElement) */ readonly maxLabelElement: HTMLElement; /** * The minimum possible data/thumb value of the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#min) */ min: number; /** * The HTML Element node representing the [min](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#min) value label. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#minLabelElement) */ readonly minLabelElement: HTMLElement; /** * Defines how slider thumb values should be rounded. * * @default 4 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#precision) */ precision: number; /** * Indicates whether to enable editing range values via keyboard input when the user clicks a [min](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#min) or [max](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#max) label. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#rangeLabelInputsEnabled) */ rangeLabelInputsEnabled: boolean; /** * The HTML Element nodes representing interactive slider segments. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#segmentElements) */ readonly segmentElements: Collection; /** * Indicates if the closest thumb will snap to the clicked location on the track. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#snapOnClickEnabled) */ snapOnClickEnabled: boolean; /** * The current state of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#state) */ readonly state: "ready" | "disabled" | "editing" | "dragging"; /** * Sets steps, or intervals, on the slider that restrict user input to specific values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#steps) */ steps: number | number[]; /** * When `true`, all segments will sync together in updating thumb values when the user drags any segment. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#syncedSegmentsEnabled) */ syncedSegmentsEnabled: boolean; /** * Function that executes each time a thumb is created on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#thumbCreatedFunction) */ thumbCreatedFunction: ThumbCreatedFunction; /** * The HTML Element nodes representing slider thumbs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#thumbElements) */ readonly thumbElements: Collection; /** * When `false`, the user can freely move any slider thumb to any position along the track. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#thumbsConstrained) */ thumbsConstrained: boolean; /** * When set, renders ticks along the slider track. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#tickConfigs) */ tickConfigs: TickConfig[]; /** * The HTML Element nodes representing slider ticks and their associated labels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#tickElements) */ readonly tickElements: Collection>; /** * The HTML Element node representing the slider track. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#trackElement) */ trackElement: HTMLElement; /** * An array of numbers representing absolute thumb positions on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#values) */ values: number[]; /** * The view model for the Slider widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#viewModel) */ viewModel: SliderViewModel; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#visibleElements) */ visibleElements: SliderVisibleElements; /** * A slider widget that can be used for filtering data, or gathering numeric input from a user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html) */ constructor(properties?: SliderProperties); on(name: "max-change", eventHandler: SliderMaxChangeEventHandler): IHandle; on(name: "min-change", eventHandler: SliderMinChangeEventHandler): IHandle; on(name: "segment-click", eventHandler: SliderSegmentClickEventHandler): IHandle; on(name: "segment-drag", eventHandler: SliderSegmentDragEventHandler): IHandle; on(name: "thumb-change", eventHandler: SliderThumbChangeEventHandler): IHandle; on(name: "thumb-click", eventHandler: SliderThumbClickEventHandler): IHandle; on(name: "thumb-drag", eventHandler: SliderThumbDragEventHandler): IHandle; on(name: "track-click", eventHandler: SliderTrackClickEventHandler): IHandle; on(name: "max-click", eventHandler: SliderMaxClickEventHandler): IHandle; on(name: "min-click", eventHandler: SliderMinClickEventHandler): IHandle; on(name: "tick-click", eventHandler: SliderTickClickEventHandler): IHandle; } interface SliderProperties extends WidgetProperties { /** * When `true`, sets the slider to a disabled state so the user cannot interact with it. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#disabled) */ disabled?: boolean; /** * Indicates if the user can drag the segment between thumbs to update thumb positions. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#draggableSegmentsEnabled) */ draggableSegmentsEnabled?: boolean; /** * When set, the user is restricted from moving slider thumbs to positions higher than this value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#effectiveMax) */ effectiveMax?: number; /** * When set, the user is restricted from moving slider thumbs to positions less than this value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#effectiveMin) */ effectiveMin?: number; /** * A function that provides the developer with access to the input elements when [rangeLabelInputsEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#rangeLabelInputsEnabled) and/or [labelInputsEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#labelInputsEnabled) are set to `true`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#inputCreatedFunction) */ inputCreatedFunction?: InputCreatedFunction; /** * A function used to format user inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#inputFormatFunction) */ inputFormatFunction?: SliderLabelFormatter; /** * Function used to parse slider inputs formatted by the [inputFormatFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#inputFormatFunction). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#inputParseFunction) */ inputParseFunction?: InputParser; /** * A function used to format labels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#labelFormatFunction) */ labelFormatFunction?: SliderLabelFormatter; /** * Indicates whether to enable editing input values via keyboard input when the user clicks a label. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#labelInputsEnabled) */ labelInputsEnabled?: boolean; /** * Determines the layout/orientation of the Slider widget. * * @default horizontal * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#layout) */ layout?: "horizontal" | "horizontal-reversed" | "vertical" | "vertical-reversed"; /** * The maximum possible data/thumb value of the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#max) */ max?: number; /** * The minimum possible data/thumb value of the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#min) */ min?: number; /** * Defines how slider thumb values should be rounded. * * @default 4 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#precision) */ precision?: number; /** * Indicates whether to enable editing range values via keyboard input when the user clicks a [min](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#min) or [max](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#max) label. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#rangeLabelInputsEnabled) */ rangeLabelInputsEnabled?: boolean; /** * Indicates if the closest thumb will snap to the clicked location on the track. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#snapOnClickEnabled) */ snapOnClickEnabled?: boolean; /** * Sets steps, or intervals, on the slider that restrict user input to specific values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#steps) */ steps?: number | number[]; /** * When `true`, all segments will sync together in updating thumb values when the user drags any segment. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#syncedSegmentsEnabled) */ syncedSegmentsEnabled?: boolean; /** * Function that executes each time a thumb is created on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#thumbCreatedFunction) */ thumbCreatedFunction?: ThumbCreatedFunction; /** * When `false`, the user can freely move any slider thumb to any position along the track. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#thumbsConstrained) */ thumbsConstrained?: boolean; /** * When set, renders ticks along the slider track. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#tickConfigs) */ tickConfigs?: TickConfig[]; /** * The HTML Element node representing the slider track. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#trackElement) */ trackElement?: HTMLElement; /** * An array of numbers representing absolute thumb positions on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#values) */ values?: number[]; /** * The view model for the Slider widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#viewModel) */ viewModel?: SliderViewModelProperties; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#visibleElements) */ visibleElements?: SliderVisibleElements; } export interface SliderViewModel extends Accessor, Evented { } export class SliderViewModel { /** * When set, the user is restricted from moving slider thumbs to positions higher than this value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#effectiveMax) */ effectiveMax: number; /** * When set, the user is restricted from moving slider thumbs to positions less than this value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#effectiveMin) */ effectiveMin: number; /** * A function used to format user inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#inputFormatFunction) */ inputFormatFunction: SliderLabelFormatter; /** * Function used to parse slider inputs formatted by the [inputFormatFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#inputFormatFunction). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#inputParseFunction) */ inputParseFunction: InputParser; /** * A function used to format labels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#labelFormatFunction) */ labelFormatFunction: SliderLabelFormatter; /** * An array of strings associated with [values](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#values) generated using an internal label formatter or the values returned from [labelFormatFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#labelFormatFunction). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#labels) */ readonly labels: string[]; /** * The maximum possible data/thumb value of the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#max) */ max: number; /** * The minimum possible data/thumb value of the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#min) */ min: number; /** * Defines how slider values should be rounded. * * @default 4 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#precision) */ precision: number; /** * The state of the view model. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#state) */ readonly state: "ready" | "disabled"; /** * When `false`, the user can freely move any slider thumb to any position along the track. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#thumbsConstrained) */ thumbsConstrained: boolean; /** * An array of numbers representing absolute thumb positions on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#values) */ values: number[]; /** * Provides the logic for the [Slider](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html) */ constructor(properties?: SliderViewModelProperties); /** * The default input format function available for use as a fallback in custom formatting implementations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#defaultInputFormatFunction) */ defaultInputFormatFunction(value: number): string; /** * The default input parsing function available for use as a fallback in custom parsing implementations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#defaultInputParseFunction) */ defaultInputParseFunction(value: string): number; /** * The default label format function, available for use as a fallback in custom formatting implementations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#defaultLabelFormatFunction) */ defaultLabelFormatFunction(value: number): string; /** * Returns the effective bounds of the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#getBounds) */ getBounds(): Bounds; /** * Returns the min and max bounds for a 'value' at the provided index. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#getBoundsForValueAtIndex) */ getBoundsForValueAtIndex(index: number): any; /** * Returns the formatted label for a provided value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#getLabelForValue) */ getLabelForValue(value: number, type?: "min" | "max" | "tick" | "values", index?: number): string; /** * Updates a thumb [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#values) based on the provided index. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#setValue) */ setValue(index: number, value: number): void; /** * Rounds the given value to the number of decimal places specified in the [precision](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#precision) property set on the view model. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#toPrecision) */ toPrecision(value: number): string; } interface SliderViewModelProperties { /** * When set, the user is restricted from moving slider thumbs to positions higher than this value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#effectiveMax) */ effectiveMax?: number; /** * When set, the user is restricted from moving slider thumbs to positions less than this value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#effectiveMin) */ effectiveMin?: number; /** * A function used to format user inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#inputFormatFunction) */ inputFormatFunction?: SliderLabelFormatter; /** * Function used to parse slider inputs formatted by the [inputFormatFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#inputFormatFunction). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#inputParseFunction) */ inputParseFunction?: InputParser; /** * A function used to format labels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#labelFormatFunction) */ labelFormatFunction?: SliderLabelFormatter; /** * The maximum possible data/thumb value of the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#max) */ max?: number; /** * The minimum possible data/thumb value of the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#min) */ min?: number; /** * Defines how slider values should be rounded. * * @default 4 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#precision) */ precision?: number; /** * When `false`, the user can freely move any slider thumb to any position along the track. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#thumbsConstrained) */ thumbsConstrained?: boolean; /** * An array of numbers representing absolute thumb positions on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#values) */ values?: number[]; } /** * Represents the effective bounds of the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#Bounds) */ export interface Bounds { /** * The effective min value of the slider, or the minimum value a user can set a thumb on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#Bounds) */ min: number; /** * The effective max value of the slider, or the maximum value a user can set a thumb on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#Bounds) */ max: number; } export type InputCreatedFunction = (inputElement: any, type: "max" | "min" | "thumb", thumbIndex?: number) => void; export type InputParser = ( value: string, type?: "average" | "min" | "max" | "tick" | "value", index?: number, ) => number; export type SliderLabelFormatter = ( value: number, type?: "average" | "min" | "max" | "tick" | "value", index?: number, ) => string; export interface SliderMaxChangeEvent { oldValue: number; type: "max-change"; value: number; } export interface SliderMaxClickEvent { type: "max-click"; value: number; } export interface SliderMinChangeEvent { oldValue: number; type: "min-change"; value: number; } export interface SliderMinClickEvent { type: "min-click"; value: number; } export interface SliderSegmentClickEvent { index: number; thumbIndices: number[]; type: "segment-click"; value: number; } export interface SliderSegmentDragEvent { index: number; state: "start" | "drag"; thumbIndices: number[]; type: "segment-drag"; } export interface SliderThumbChangeEvent { index: number; oldValue: number; type: "thumb-change"; value: number; } export interface SliderThumbClickEvent { index: number; type: "thumb-click"; value: number; } export type ThumbCreatedFunction = ( index: number, value: number, thumbElement: HTMLElement, labelElement?: HTMLElement, ) => void; export interface SliderThumbDragEvent { index: number; state: "drag" | "start" | "stop"; type: "thumb-drag"; value: number; } export interface SliderTickClickEvent { configIndex: number; groupIndex: number; type: "tick-click"; value: number; } /** * Object specification for configuring ticks on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#TickConfig) */ export interface TickConfig { /** * The mode or method of positioning ticks along the slider track. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#TickConfig) */ mode: "count" | "percent" | "position"; /** * Indicates where ticks will be rendered below the track. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#TickConfig) */ values: number | number[]; /** * Indicates whether to render labels for the ticks. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#TickConfig) */ labelsVisible?: boolean; /** * Callback that fires for each tick. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#TickConfig) */ tickCreatedFunction?: TickCreatedFunction; /** * Callback for formatting tick labels. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#TickConfig) */ labelFormatFunction?: SliderLabelFormatter; } export type TickCreatedFunction = (value: number, tickElement: HTMLElement, labelElement?: HTMLElement) => void; /** * The HTML Element nodes representing a single slider tick and its associated label. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#TickElementGroup) */ export interface TickElementGroup { /** * The HTMLElement representing a tick. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#TickElementGroup) */ tickElement?: HTMLElement; /** * The HTMLElement representing the label associated with the tick element. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#TickElementGroup) */ labelElement?: HTMLElement; } export interface SliderTrackClickEvent { type: "track-click"; value: number; } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#VisibleElements) */ export interface SliderVisibleElements { /** * Indicates whether to display labels for slider thumbs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#VisibleElements) */ labels?: boolean; /** * Indicates whether to display [min](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#min) or [max](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#max) range values on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#VisibleElements) */ rangeLabels?: boolean; } export class BinaryColorSizeSlider extends SmartMappingSliderBase { /** * This property indicates whether the position of the outside handles are synced with the middle, or primary, handle. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider.html#handlesSyncedToPrimary) */ handlesSyncedToPrimary: boolean; /** * When `true`, ensures symbol sizes in the `above` range are consistent with symbol sizes in the `below` range for all slider thumb positions. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider.html#persistSizeRangeEnabled) */ persistSizeRangeEnabled: boolean; /** * The size stops from the [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) to link to the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider.html#stops) */ stops: SizeStop[]; /** * Exposes various properties of the widget that can be styled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider.html#style) */ style: BinaryColorSizeSliderStyle; /** * The view model for the BinaryColorSizeSlider widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider.html#viewModel) */ viewModel: BinaryColorSizeSliderViewModel; /** * The BinaryColorSizeSlider widget is intended for authoring and exploring diverging data-driven visualizations in any layer that can be rendered with an above and below theme for a [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider.html) */ constructor(properties?: BinaryColorSizeSliderProperties); /** * A convenience function used to update the properties of a BinaryColorSizeSlider widget instance from the [result](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#ContinuousRendererResult) of the [createContinuousRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider.html#updateFromRendererResult) */ updateFromRendererResult(rendererResult: univariateColorSizeContinuousRendererResult, histogramResult?: HistogramResult): void; /** * A convenience function used to update the input renderer based on the values of the slider [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider.html#stops). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider.html#updateRenderer) */ updateRenderer(renderer: ClassBreaksRenderer): ClassBreaksRenderer; /** * A convenience function used to create a BinaryColorSizeSlider widget instance from the [result](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#ContinuousRendererResult) of the [createContinuousRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider.html#fromRendererResult) */ static fromRendererResult(rendererResult: univariateColorSizeContinuousRendererResult, histogramResult?: HistogramResult): BinaryColorSizeSlider; } interface BinaryColorSizeSliderProperties extends SmartMappingSliderBaseProperties { /** * This property indicates whether the position of the outside handles are synced with the middle, or primary, handle. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider.html#handlesSyncedToPrimary) */ handlesSyncedToPrimary?: boolean; /** * When `true`, ensures symbol sizes in the `above` range are consistent with symbol sizes in the `below` range for all slider thumb positions. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider.html#persistSizeRangeEnabled) */ persistSizeRangeEnabled?: boolean; /** * The size stops from the [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) to link to the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider.html#stops) */ stops?: SizeStopProperties[]; /** * Exposes various properties of the widget that can be styled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider.html#style) */ style?: BinaryColorSizeSliderStyle; /** * The view model for the BinaryColorSizeSlider widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider.html#viewModel) */ viewModel?: BinaryColorSizeSliderViewModelProperties; } export class BinaryColorSizeSliderViewModel extends SizeSliderViewModel { /** * Provides the logic for the [BinaryColorSizeSlider](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider-BinaryColorSizeSliderViewModel.html) */ constructor(properties?: BinaryColorSizeSliderViewModelProperties); } interface BinaryColorSizeSliderViewModelProperties extends SizeSliderViewModelProperties { } export interface BinaryColorSizeSliderStyle { /** * The color of the slider's track above the middle stop value. * * @default new Color([149, 149, 149]) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider.html#style) */ trackAboveFillColor?: Color; /** * The color of the slider's track below the middle stop value. * * @default new Color([149, 149, 149]) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider.html#style) */ trackBelowFillColor?: Color; /** * The background color of the slider's track. * * @default new Color([224, 224, 224]) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider.html#style) */ trackBackgroundColor?: Color; } export class ClassedColorSlider extends SmartMappingSliderBase { /** * An array of class breaks with associated colors. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider.html#breaks) */ breaks: ClassedColorSliderBreaks[]; /** * The view model for the ClassedColorSlider widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider.html#viewModel) */ viewModel: ClassedColorSliderViewModel; /** * The ClassedColorSlider widget is designed for authoring and exploring data-driven visualizations in any layer that can be rendered with color in a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider.html) */ constructor(properties?: ClassedColorSliderProperties); /** * A convenience function used to update the [classBreakInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos) of a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html) associated with this slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider.html#updateClassBreakInfos) */ updateClassBreakInfos(breakInfos: ClassBreakInfo[]): ClassBreakInfo[]; /** * A convenience function used to update the properties a ClassedColorSlider from the result of the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider.html#updateFromRendererResult) */ updateFromRendererResult(rendererResult: ClassBreaksRendererResult, histogramResult?: HistogramResult): void; /** * A convenience function used to create a ClassedColorSlider widget from the result of the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider.html#fromRendererResult) */ static fromRendererResult(rendererResult: ClassBreaksRendererResult, histogramResult?: HistogramResult): ClassedColorSlider; } interface ClassedColorSliderProperties extends SmartMappingSliderBaseProperties { /** * An array of class breaks with associated colors. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider.html#breaks) */ breaks?: ClassedColorSliderBreaks[]; /** * The view model for the ClassedColorSlider widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider.html#viewModel) */ viewModel?: ClassedColorSliderViewModelProperties; } export class ClassedColorSliderViewModel extends SmartMappingSliderViewModel { /** * An array of class breaks with associated colors. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider-ClassedColorSliderViewModel.html#breaks) */ breaks: ClassedColorSliderViewModelBreaks[]; /** * Provides the logic for the [ClassedColorSlider](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider-ClassedColorSliderViewModel.html) */ constructor(properties?: ClassedColorSliderViewModelProperties); /** * Generates the color ramp rendered on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider-ClassedColorSliderViewModel.html#getStopInfo) */ getStopInfo(): StopInfo[]; } interface ClassedColorSliderViewModelProperties extends SmartMappingSliderViewModelProperties { /** * An array of class breaks with associated colors. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider-ClassedColorSliderViewModel.html#breaks) */ breaks?: ClassedColorSliderViewModelBreaks[]; } export interface ClassedColorSliderViewModelBreaks { /** * Features with values within the provided `min` and `max` will be rendered with this color. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider-ClassedColorSliderViewModel.html#breaks) */ color: Color; /** * The max value of the break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider-ClassedColorSliderViewModel.html#breaks) */ max: number; /** * The min value of the break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider-ClassedColorSliderViewModel.html#breaks) */ min: number; } /** * The return object of the [getStopInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider-ClassedColorSliderViewModel.html#getStopInfo) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider-ClassedColorSliderViewModel.html#StopInfo) */ export interface StopInfo { /** * The color of the break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider-ClassedColorSliderViewModel.html#StopInfo) */ color: Color; /** * The offset of the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider-ClassedColorSliderViewModel.html#StopInfo) */ offset: number; } export interface ClassedColorSliderBreaks { /** * Features with values within the provided `min` and `max` will be rendered with this color. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider.html#breaks) */ color: Color; /** * The max value of the break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider.html#breaks) */ max: number; /** * The min value of the break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider.html#breaks) */ min: number; } export class ClassedSizeSlider extends SmartMappingSliderBase { /** * An array of class breaks with associated sizes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider.html#breaks) */ breaks: ClassedSizeSliderBreaks[]; /** * Exposes various properties of the widget that can be styled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider.html#style) */ style: ClassedSizeSliderStyle; /** * The view model for the ClassedSizeSlider widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider.html#viewModel) */ viewModel: ClassedSizeSliderViewModel; /** * The ClassedSizeSlider widget is designed for authoring and exploring data-driven visualizations in any layer that can be rendered with size in a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider.html) */ constructor(properties?: ClassedSizeSliderProperties); /** * A convenience function used to update the [classBreakInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos) of a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html) associated with this slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider.html#updateClassBreakInfos) */ updateClassBreakInfos(breakInfos: ClassBreakInfo[]): ClassBreakInfo[]; /** * A convenience function used to update the properties a ClassedSizeSlider from the result of the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider.html#updateClassBreakInfos) */ updateClassBreakInfos(rendererResult: sizeClassBreaksRendererResult, histogramResult?: HistogramResult): void; /** * A convenience function used to create a ClassedSizeSlider widget from the result of the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider.html#fromRendererResult) */ static fromRendererResult(rendererResult: sizeClassBreaksRendererResult, histogramResult?: HistogramResult): ClassedSizeSlider; } interface ClassedSizeSliderProperties extends SmartMappingSliderBaseProperties { /** * An array of class breaks with associated sizes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider.html#breaks) */ breaks?: ClassedSizeSliderBreaks[]; /** * Exposes various properties of the widget that can be styled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider.html#style) */ style?: ClassedSizeSliderStyle; /** * The view model for the ClassedSizeSlider widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider.html#viewModel) */ viewModel?: ClassedSizeSliderViewModelProperties; } export class ClassedSizeSliderViewModel extends SmartMappingSliderViewModel { /** * An array of class breaks with associated sizes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider-ClassedSizeSliderViewModel.html#breaks) */ breaks: ClassedSizeSliderViewModelBreaks[]; /** * Provides the logic for the [ClassedSizeSlider](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider-ClassedSizeSliderViewModel.html) */ constructor(properties?: ClassedSizeSliderViewModelProperties); } interface ClassedSizeSliderViewModelProperties extends SmartMappingSliderViewModelProperties { /** * An array of class breaks with associated sizes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider-ClassedSizeSliderViewModel.html#breaks) */ breaks?: ClassedSizeSliderViewModelBreaks[]; } export interface ClassedSizeSliderViewModelBreaks { /** * The size in points of the symbol representing features with values within the given `min` and `max`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider-ClassedSizeSliderViewModel.html#breaks) */ size: number; /** * The max value of the break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider-ClassedSizeSliderViewModel.html#breaks) */ max: number; /** * The min value of the break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider-ClassedSizeSliderViewModel.html#breaks) */ min: number; } export interface ClassedSizeSliderBreaks { /** * The size in points of the symbol representing features with values within the given `min` and `max`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider.html#breaks) */ size: number; /** * The max value of the break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider.html#breaks) */ max: number; /** * The min value of the break. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider.html#breaks) */ min: number; } export interface ClassedSizeSliderStyle { /** * The color of the slider's track. * * @default new Color([149, 149, 149]) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider.html#style) */ trackFillColor?: Color; /** * The background color of the slider's track. * * @default new Color([224, 224, 224]) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider.html#style) */ trackBackgroundColor?: Color; } export class ColorSizeSlider extends SmartMappingSliderBase { /** * Only applicable when three thumbs (i.e. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider.html#handlesSyncedToPrimary) */ handlesSyncedToPrimary: boolean; /** * Only applicable when three thumbs (i.e. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider.html#persistSizeRangeEnabled) */ persistSizeRangeEnabled: boolean; /** * When `true`, the slider will render a third handle between the two handles already provided by default. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider.html#primaryHandleEnabled) */ primaryHandleEnabled: boolean; /** * The colors and sizes corresponding with data values in the [ColorVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html) and [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) of the renderer associated with the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider.html#stops) */ stops: ColorSizeStop[]; /** * The view model for the ColorSizeSlider widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider.html#viewModel) */ viewModel: ColorSizeSliderViewModel; /** * The ColorSizeSlider widget is intended for authoring and exploring data-driven visualizations in any layer that can be rendered with a [ColorVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html) and a [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider.html) */ constructor(properties?: ColorSizeSliderProperties); /** * A convenience function used to update the properties of a ColorSizeSlider widget instance from the [result](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#ContinuousRendererResult) of the [univariateColorSize.createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider.html#updateFromRendererResult) */ updateFromRendererResult(rendererResult: univariateColorSizeContinuousRendererResult, histogramResult?: HistogramResult): void; /** * A convenience function used to update a renderer generated with the [univariateColorSize.createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) method with the values obtained from the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider.html#updateRenderer) */ updateRenderer(renderer: ClassBreaksRenderer): ClassBreaksRenderer; /** * A convenience function used to update the visual variables of a renderer generated with the [univariateColorSize.createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) method with the values obtained from the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider.html#updateVisualVariables) */ updateVisualVariables(variables: (ColorVariable | SizeVariable)[]): (ColorVariable | SizeVariable)[]; /** * A convenience function used to create a ColorSizeSlider widget instance from the [result](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#ContinuousRendererResult) of the [univariateColorSize.createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider.html#fromRendererResult) */ static fromRendererResult(rendererResult: univariateColorSizeContinuousRendererResult, histogramResult?: HistogramResult): ColorSizeSlider; } interface ColorSizeSliderProperties extends SmartMappingSliderBaseProperties { /** * Only applicable when three thumbs (i.e. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider.html#handlesSyncedToPrimary) */ handlesSyncedToPrimary?: boolean; /** * Only applicable when three thumbs (i.e. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider.html#persistSizeRangeEnabled) */ persistSizeRangeEnabled?: boolean; /** * When `true`, the slider will render a third handle between the two handles already provided by default. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider.html#primaryHandleEnabled) */ primaryHandleEnabled?: boolean; /** * The colors and sizes corresponding with data values in the [ColorVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html) and [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) of the renderer associated with the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider.html#stops) */ stops?: ColorSizeStopProperties[]; /** * The view model for the ColorSizeSlider widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider.html#viewModel) */ viewModel?: ColorSizeSliderViewModelProperties; } export class ColorSizeSliderViewModel extends SizeSliderViewModel { /** * The colors and sizes corresponding with data values in the [ColorVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html) and [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) of the renderer associated with the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider-ColorSizeSliderViewModel.html#stops) */ stops: ColorSizeStop[]; /** * Provides the logic for the [ColorSizeSlider](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider-ColorSizeSliderViewModel.html) */ constructor(properties?: ColorSizeSliderViewModelProperties); /** * Generates the color ramp gradient rendered on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider-ColorSizeSliderViewModel.html#getStopInfo) */ getStopInfo(): ColorSizeSliderViewModelStopInfo[]; } interface ColorSizeSliderViewModelProperties extends SizeSliderViewModelProperties { /** * The colors and sizes corresponding with data values in the [ColorVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html) and [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) of the renderer associated with the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider-ColorSizeSliderViewModel.html#stops) */ stops?: ColorSizeStopProperties[]; } /** * The return object of the [getStopInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider-ColorSizeSliderViewModel.html#getStopInfo) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider-ColorSizeSliderViewModel.html#StopInfo) */ export interface ColorSizeSliderViewModelStopInfo { /** * The color of the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider-ColorSizeSliderViewModel.html#StopInfo) */ color: Color; /** * The offset of the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider-ColorSizeSliderViewModel.html#StopInfo) */ offset: number; } export class ColorSlider extends SmartMappingSliderBase { /** * Only applicable when three thumbs (i.e. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSlider.html#handlesSyncedToPrimary) */ handlesSyncedToPrimary: boolean; /** * When `true`, the slider will render a third handle between the two handles already provided by default. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSlider.html#primaryHandleEnabled) */ primaryHandleEnabled: boolean; /** * The color stops from the [ColorVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html) to link to the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSlider.html#stops) */ stops: ColorStop[]; /** * The view model for the ColorSlider widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSlider.html#viewModel) */ viewModel: ColorSliderViewModel; /** * The ColorSlider widget is intended for authoring and exploring data-driven visualizations in any layer that can be rendered with a [ColorVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSlider.html) */ constructor(properties?: ColorSliderProperties); /** * A convenience function used to update the properties of a ColorSlider widget instance from the [result](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#ContinuousRendererResult) of the [createContinuousRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSlider.html#updateFromRendererResult) */ updateFromRendererResult(rendererResult: ContinuousRendererResult, histogramResult?: HistogramResult): void; /** * A convenience function used to create a ColorSlider widget instance from the [result](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#ContinuousRendererResult) of the [createContinuousRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSlider.html#fromRendererResult) */ static fromRendererResult(rendererResult: ContinuousRendererResult, histogramResult?: HistogramResult): ColorSlider; } interface ColorSliderProperties extends SmartMappingSliderBaseProperties { /** * Only applicable when three thumbs (i.e. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSlider.html#handlesSyncedToPrimary) */ handlesSyncedToPrimary?: boolean; /** * When `true`, the slider will render a third handle between the two handles already provided by default. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSlider.html#primaryHandleEnabled) */ primaryHandleEnabled?: boolean; /** * The color stops from the [ColorVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html) to link to the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSlider.html#stops) */ stops?: ColorStopProperties[]; /** * The view model for the ColorSlider widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSlider.html#viewModel) */ viewModel?: ColorSliderViewModelProperties; } export class ColorSliderViewModel extends SmartMappingPrimaryHandleSliderViewModel { /** * The color stops from the [ColorVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html) to link to the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSlider-ColorSliderViewModel.html#stops) */ stops: ColorStop[]; /** * Provides the logic for the [ColorSlider](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSlider.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSlider-ColorSliderViewModel.html) */ constructor(properties?: ColorSliderViewModelProperties); /** * Generates the color ramp gradient rendered on the slider track. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSlider-ColorSliderViewModel.html#getStopInfo) */ getStopInfo(): ColorSliderViewModelStopInfo[]; } interface ColorSliderViewModelProperties extends SmartMappingPrimaryHandleSliderViewModelProperties { /** * The color stops from the [ColorVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html) to link to the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSlider-ColorSliderViewModel.html#stops) */ stops?: ColorStopProperties[]; } /** * The return object of the [getStopInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSlider-ColorSliderViewModel.html#getStopInfo) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSlider-ColorSliderViewModel.html#StopInfo) */ export interface ColorSliderViewModelStopInfo { /** * The color of the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSlider-ColorSliderViewModel.html#StopInfo) */ color: Color; /** * The offset of the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSlider-ColorSliderViewModel.html#StopInfo) */ offset: number; } export class HeatmapSlider extends Widget { /** * The colorStops of the [HeatmapRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html) to associate with the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-HeatmapSlider.html#stops) */ stops: HeatmapColorStop[]; /** * The view model for the Heatmap widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-HeatmapSlider.html#viewModel) */ viewModel: HeatmapSliderViewModel; /** * The HeatmapSlider widget is intended for authoring and exploring data-driven visualizations in any layer that can be rendered with a [HeatmapRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-HeatmapSlider.html) */ constructor(properties?: HeatmapSliderProperties); on(name: "thumb-change", eventHandler: HeatmapSliderThumbChangeEventHandler): IHandle; on(name: "thumb-drag", eventHandler: HeatmapSliderThumbDragEventHandler): IHandle; /** * A convenience function used to create a HeatmapSlider widget instance from the [result](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#HeatmapRendererResult) of the [heatmapRendererCreator.createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#createRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-HeatmapSlider.html#fromHeatmapRendererResult) */ static fromHeatmapRendererResult(rendererResult: HeatmapRendererResult): HeatmapSlider; } interface HeatmapSliderProperties extends WidgetProperties { /** * The colorStops of the [HeatmapRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html) to associate with the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-HeatmapSlider.html#stops) */ stops?: HeatmapColorStopProperties[]; /** * The view model for the Heatmap widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-HeatmapSlider.html#viewModel) */ viewModel?: HeatmapSliderViewModelProperties; } export class HeatmapSliderViewModel extends SmartMappingSliderViewModel { /** * The colorStops of the [HeatmapRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html) to associate with the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-HeatmapSlider-HeatmapSliderViewModel.html#stops) */ stops: HeatmapColorStop[]; /** * Provides the logic for the [HeatmapSlider](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-HeatmapSlider.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-HeatmapSlider-HeatmapSliderViewModel.html) */ constructor(properties?: HeatmapSliderViewModelProperties); /** * Generates the color ramp gradient rendered on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-HeatmapSlider-HeatmapSliderViewModel.html#getStopInfo) */ getStopInfo(): HeatmapSliderViewModelStopInfo[]; } interface HeatmapSliderViewModelProperties extends SmartMappingSliderViewModelProperties { /** * The colorStops of the [HeatmapRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html) to associate with the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-HeatmapSlider-HeatmapSliderViewModel.html#stops) */ stops?: HeatmapColorStopProperties[]; } /** * The return object of the [getColorStopInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-HeatmapSlider-HeatmapSliderViewModel.html#getColorStopInfo) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-HeatmapSlider-HeatmapSliderViewModel.html#StopInfo) */ export interface HeatmapSliderViewModelStopInfo { /** * The color of the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-HeatmapSlider-HeatmapSliderViewModel.html#StopInfo) */ color: Color; /** * The offset of the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-HeatmapSlider-HeatmapSliderViewModel.html#StopInfo) */ offset: number; } export interface HeatmapSliderThumbChangeEvent { index: number; oldValue: number; type: "thumb-change"; value: number; } export interface HeatmapSliderThumbDragEvent { index: number; state: "start" | "drag"; type: "thumb-drag"; value: number; } export class OpacitySlider extends SmartMappingSliderBase { /** * The opacity stops from the [OpacityVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-OpacityVariable.html) to link to the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-OpacitySlider.html#stops) */ stops: OpacityStop[]; /** * Exposes various properties of the widget that can be styled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-OpacitySlider.html#style) */ style: OpacitySliderStyle; /** * The view model for the OpacitySlider widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-OpacitySlider.html#viewModel) */ viewModel: OpacitySliderViewModel; /** * The OpacitySlider widget is intended for authoring and exploring data-driven visualizations in any layer that can be rendered with an [OpacityVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-OpacityVariable.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-OpacitySlider.html) */ constructor(properties?: OpacitySliderProperties); /** * A convenience function used to update the properties of an OpacitySlider widget instance from the [result](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#VisualVariableResult) of the [createVisualVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#createVisualVariable) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-OpacitySlider.html#updateFromVisualVariableResult) */ updateFromVisualVariableResult(visualVariableResult: opacityVisualVariableResult, histogramResult?: HistogramResult): void; /** * A convenience function used to create an OpacitySlider widget instance from the [result](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#VisualVariableResult) of the [createVisualVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#createVisualVariable) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-OpacitySlider.html#fromVisualVariableResult) */ static fromVisualVariableResult(visualVariableResult: opacityVisualVariableResult, histogramResult?: HistogramResult): OpacitySlider; } interface OpacitySliderProperties extends SmartMappingSliderBaseProperties { /** * The opacity stops from the [OpacityVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-OpacityVariable.html) to link to the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-OpacitySlider.html#stops) */ stops?: OpacityStopProperties[]; /** * Exposes various properties of the widget that can be styled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-OpacitySlider.html#style) */ style?: OpacitySliderStyle; /** * The view model for the OpacitySlider widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-OpacitySlider.html#viewModel) */ viewModel?: OpacitySliderViewModelProperties; } export class OpacitySliderViewModel extends SmartMappingSliderViewModel { /** * The opacity stops from the [OpacityVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-OpacityVariable.html) to link to the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-OpacitySlider-OpacitySliderViewModel.html#stops) */ stops: OpacityStop[]; /** * Provides the logic for the [OpacitySlider](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-OpacitySlider.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-OpacitySlider-OpacitySliderViewModel.html) */ constructor(properties?: OpacitySliderViewModelProperties); /** * Generates the opacity ramp gradient rendered on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-OpacitySlider-OpacitySliderViewModel.html#getStopInfo) */ getStopInfo(): OpacitySliderViewModelStopInfo[]; } interface OpacitySliderViewModelProperties extends SmartMappingSliderViewModelProperties { /** * The opacity stops from the [OpacityVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-OpacityVariable.html) to link to the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-OpacitySlider-OpacitySliderViewModel.html#stops) */ stops?: OpacityStopProperties[]; } /** * The return object of the [getStopInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-OpacitySlider-OpacitySliderViewModel.html#getStopInfo) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-OpacitySlider-OpacitySliderViewModel.html#StopInfo) */ export interface OpacitySliderViewModelStopInfo { /** * The color of the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-OpacitySlider-OpacitySliderViewModel.html#StopInfo) */ color: Color; /** * The offset of the stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-OpacitySlider-OpacitySliderViewModel.html#StopInfo) */ offset: number; } export interface OpacitySliderStyle { /** * The color of the slider's track. * * @default new Color([0, 121, 193]) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-OpacitySlider.html#style) */ trackFillColor?: Color; } export class SizeSlider extends SmartMappingSliderBase { /** * Only applicable when three thumbs (i.e. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider.html#handlesSyncedToPrimary) */ handlesSyncedToPrimary: boolean; /** * Only applicable when three thumbs (i.e. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider.html#persistSizeRangeEnabled) */ persistSizeRangeEnabled: boolean; /** * When `true`, the slider will render a third handle between the two handles already provided by default. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider.html#primaryHandleEnabled) */ primaryHandleEnabled: boolean; /** * The size stops from the [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) to link to the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider.html#stops) */ stops: SizeStop[]; /** * Exposes various properties of the widget that can be styled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider.html#style) */ style: SizeSliderStyle; /** * The view model for the SizeSlider widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider.html#viewModel) */ viewModel: SizeSliderViewModel; /** * The SizeSlider widget is intended for authoring and exploring data-driven visualizations in any layer that can be rendered with a [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider.html) */ constructor(properties?: SizeSliderProperties); /** * A convenience function used to update the properties of a SizeSlider widget instance from the [result](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#ContinuousRendererResult) of the [createContinuousRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider.html#updateFromRendererResult) */ updateFromRendererResult(rendererResult: sizeContinuousRendererResult, histogramResult?: HistogramResult): void; /** * A convenience function used to update the [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) to match the values of the [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider.html#stops) on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider.html#updateVisualVariable) */ updateVisualVariable(sizeVariable: SizeVariable): SizeVariable; /** * A convenience function used to create a SizeSlider widget instance from the [result](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#ContinuousRendererResult) of the [createContinuousRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createContinuousRenderer) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider.html#fromRendererResult) */ static fromRendererResult(rendererResult: sizeContinuousRendererResult, histogramResult?: HistogramResult): SizeSlider; } interface SizeSliderProperties extends SmartMappingSliderBaseProperties { /** * Only applicable when three thumbs (i.e. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider.html#handlesSyncedToPrimary) */ handlesSyncedToPrimary?: boolean; /** * Only applicable when three thumbs (i.e. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider.html#persistSizeRangeEnabled) */ persistSizeRangeEnabled?: boolean; /** * When `true`, the slider will render a third handle between the two handles already provided by default. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider.html#primaryHandleEnabled) */ primaryHandleEnabled?: boolean; /** * The size stops from the [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) to link to the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider.html#stops) */ stops?: SizeStopProperties[]; /** * Exposes various properties of the widget that can be styled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider.html#style) */ style?: SizeSliderStyle; /** * The view model for the SizeSlider widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider.html#viewModel) */ viewModel?: SizeSliderViewModelProperties; } export class SizeSliderViewModel extends SmartMappingPrimaryHandleSliderViewModel { /** * This property is typically used in diverging, or `above-and-below` renderer configurations. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider-SizeSliderViewModel.html#persistSizeRangeEnabled) */ persistSizeRangeEnabled: boolean; /** * The size stops from the [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) to link to the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider-SizeSliderViewModel.html#stops) */ stops: SizeStop[]; /** * Provides the logic for the [SizeSlider](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider-SizeSliderViewModel.html) */ constructor(properties?: SizeSliderViewModelProperties); } interface SizeSliderViewModelProperties extends SmartMappingPrimaryHandleSliderViewModelProperties { /** * This property is typically used in diverging, or `above-and-below` renderer configurations. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider-SizeSliderViewModel.html#persistSizeRangeEnabled) */ persistSizeRangeEnabled?: boolean; /** * The size stops from the [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) to link to the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider-SizeSliderViewModel.html#stops) */ stops?: SizeStopProperties[]; } export interface SizeSliderStyle { /** * The color of the slider's track. * * @default new Color([149, 149, 149]) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider.html#style) */ trackFillColor?: Color; /** * The background color of the slider's track. * * @default new Color([224, 224, 224]) * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider.html#style) */ trackBackgroundColor?: Color; } export class SmartMappingPrimaryHandleSliderViewModel extends SmartMappingSliderViewModel { /** * Only applicable when three thumbs (i.e. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingPrimaryHandleSliderViewModel.html#handlesSyncedToPrimary) */ handlesSyncedToPrimary: boolean; /** * When `true`, the slider will render a third handle between the two handles already provided by default. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingPrimaryHandleSliderViewModel.html#primaryHandleEnabled) */ primaryHandleEnabled: boolean; /** * Shared properties for sliders that have a [primaryHandle](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingPrimaryHandleSliderViewModel.html#primaryHandleEnabled) option. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingPrimaryHandleSliderViewModel.html) */ constructor(properties?: SmartMappingPrimaryHandleSliderViewModelProperties); } interface SmartMappingPrimaryHandleSliderViewModelProperties extends SmartMappingSliderViewModelProperties { /** * Only applicable when three thumbs (i.e. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingPrimaryHandleSliderViewModel.html#handlesSyncedToPrimary) */ handlesSyncedToPrimary?: boolean; /** * When `true`, the slider will render a third handle between the two handles already provided by default. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingPrimaryHandleSliderViewModel.html#primaryHandleEnabled) */ primaryHandleEnabled?: boolean; } export class SmartMappingSliderBase extends Widget { /** * The [Histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html) associated with the data represented on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#histogramConfig) */ histogramConfig: HistogramConfig; /** * A function used to format user inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#inputFormatFunction) */ inputFormatFunction: SmartMappingSliderBaseLabelFormatter; /** * Function used to parse slider inputs formatted by the [inputFormatFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#inputFormatFunction). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#inputParseFunction) */ inputParseFunction: InputParser; /** * A modified version of [Slider.labelFormatFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#labelFormatFunction), which is a custom function used to format labels on the thumbs, min, max, and average values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#labelFormatFunction) */ labelFormatFunction: SmartMappingSliderBaseLabelFormatter; /** * The maximum value or upper bound of the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#max) */ max: number; /** * The minimum value or lower bound of the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#min) */ min: number; /** * Defines how slider thumb values should be rounded. * * @default 4 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#precision) */ precision: number; /** * The state of the view model. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#state) */ readonly state: "ready" | "disabled"; /** * When `true`, all segments will sync together in updating thumb values when the user drags any segment. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#syncedSegmentsEnabled) */ syncedSegmentsEnabled: boolean; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#visibleElements) */ visibleElements: SmartMappingSliderBaseVisibleElements; /** * Zooms the slider track to the bounds provided in this property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#zoomOptions) */ zoomOptions: SmartMappingSliderBaseZoomOptions; /** * The base class for all Smart Mapping slider widgets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html) */ constructor(properties?: SmartMappingSliderBaseProperties); on(name: "max-change", eventHandler: SmartMappingSliderBaseMaxChangeEventHandler): IHandle; on(name: "min-change", eventHandler: SmartMappingSliderBaseMinChangeEventHandler): IHandle; on(name: "segment-drag", eventHandler: SmartMappingSliderBaseSegmentDragEventHandler): IHandle; on(name: "thumb-change", eventHandler: SmartMappingSliderBaseThumbChangeEventHandler): IHandle; on(name: "thumb-drag", eventHandler: SmartMappingSliderBaseThumbDragEventHandler): IHandle; } interface SmartMappingSliderBaseProperties extends WidgetProperties { /** * The [Histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html) associated with the data represented on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#histogramConfig) */ histogramConfig?: HistogramConfig; /** * A function used to format user inputs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#inputFormatFunction) */ inputFormatFunction?: SmartMappingSliderBaseLabelFormatter; /** * Function used to parse slider inputs formatted by the [inputFormatFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#inputFormatFunction). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#inputParseFunction) */ inputParseFunction?: InputParser; /** * A modified version of [Slider.labelFormatFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#labelFormatFunction), which is a custom function used to format labels on the thumbs, min, max, and average values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#labelFormatFunction) */ labelFormatFunction?: SmartMappingSliderBaseLabelFormatter; /** * The maximum value or upper bound of the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#max) */ max?: number; /** * The minimum value or lower bound of the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#min) */ min?: number; /** * Defines how slider thumb values should be rounded. * * @default 4 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#precision) */ precision?: number; /** * When `true`, all segments will sync together in updating thumb values when the user drags any segment. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#syncedSegmentsEnabled) */ syncedSegmentsEnabled?: boolean; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#visibleElements) */ visibleElements?: SmartMappingSliderBaseVisibleElements; /** * Zooms the slider track to the bounds provided in this property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#zoomOptions) */ zoomOptions?: SmartMappingSliderBaseZoomOptions; } /** * Configuration options for defining the slider's [Histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#HistogramConfig) */ export interface HistogramConfig { /** * Indicates the average value of the dataset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#HistogramConfig) */ average?: number; /** * Function for styling bars representing histogram bins. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#HistogramConfig) */ barCreatedFunction?: BarCreatedFunction; /** * The bins of the histogram. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#HistogramConfig) */ bins?: Bin[]; /** * When set, renders lines on the histogram that indicate important or meaningful values to the end user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#HistogramConfig) */ dataLines?: HistogramConfigDataLines[]; /** * Function that fires each time a data line is created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#HistogramConfig) */ dataLineCreatedFunction?: DataLineCreatedFunction; /** * Indicates the standard deviation of the dataset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#HistogramConfig) */ standardDeviation?: number; /** * Indicates the standard deviation of the dataset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#HistogramConfig) */ standardDeviationCount?: number; } export type SmartMappingSliderBaseLabelFormatter = ( value: number, type?: "average" | "min" | "max" | "value", index?: number, ) => string; export interface SmartMappingSliderBaseMaxChangeEvent { oldValue: number; type: "max-change"; value: number; } export interface SmartMappingSliderBaseMinChangeEvent { oldValue: number; type: "min-change"; value: number; } export interface SmartMappingSliderBaseSegmentDragEvent { index: number; state: "start" | "drag"; thumbIndices: number[]; type: "segment-drag"; } export interface SmartMappingSliderBaseVisibleElements { /** * When `true`, displays interactive segments on the track that maintain the interval between two slider thumbs/handles. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#visibleElements) */ interactiveTrack?: boolean; } export interface SmartMappingSliderBaseZoomOptions { /** * The lower bound of the zoom. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#zoomOptions) */ min?: number; /** * The upper bound of the zoom. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#zoomOptions) */ max?: number; } export interface SmartMappingSliderBaseThumbChangeEvent { index: number; oldValue: number; type: "thumb-change"; value: number; } export interface SmartMappingSliderBaseThumbDragEvent { index: number; state: "start" | "drag"; type: "thumb-drag"; value: number; } export interface HistogramConfigDataLines { /** * The value on the data axis of the histogram where a line will be rendered. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#HistogramConfig) */ value?: number; /** * The label associated with the line. * * [Read more...](global.html) */ label?: string | number; } export class SmartMappingSliderViewModel extends SliderViewModel { /** * Enables zooming on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#zoomingEnabled) */ zoomingEnabled: boolean; /** * Zooms the slider track to the bounds provided in this property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#zoomOptions) */ zoomOptions: SmartMappingSliderViewModelZoomOptions; /** * Provides the shared base logic for the smart mapping slider view models. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html) */ constructor(properties?: SmartMappingSliderViewModelProperties); /** * Gets the [max](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#max) value of the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#getUnzoomedMax) */ getUnzoomedMax(): void; /** * Gets the [min](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#min) value of the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#getUnzoomedMin) */ getUnzoomedMin(): void; } interface SmartMappingSliderViewModelProperties extends SliderViewModelProperties { /** * Enables zooming on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#zoomingEnabled) */ zoomingEnabled?: boolean; /** * Zooms the slider track to the bounds provided in this property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#zoomOptions) */ zoomOptions?: SmartMappingSliderViewModelZoomOptions; } export interface SmartMappingSliderViewModelZoomOptions { /** * The lower bound of the zoom. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#zoomOptions) */ min?: number; /** * The upper bound of the zoom. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#zoomOptions) */ max?: number; } /** * Various utils for tying Smart Mapping renderers to the Smart Mapping slider widgets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-support-utils.html) */ interface smartMappingSupportUtils { /** * Formats a UNIX timestamp to a basic date string. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-support-utils.html#formatDateLabel) */ formatDateLabel(value: number): string; /** * Formats a numeric value for display as a label based on the current locale. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-support-utils.html#formatNumberLabel) */ formatNumberLabel(value: number): string; /** * Computes and returns standard deviation values based on the given average and standard deviation. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-support-utils.html#getDeviationValues) */ getDeviationValues(standardDeviation: number, average: number, count: number): number[]; } export const smartMappingSupportUtils: smartMappingSupportUtils; export class DatePicker extends Widget { /** * Indicates whether the date gets updated when the user changes the month in the drop-down. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-DatePicker.html#commitOnMonthChange) */ commitOnMonthChange: boolean; /** * The input value for the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-DatePicker.html#value) */ value: Date; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-DatePicker.html#viewModel) */ viewModel: DatePickerViewModel; /** * The `DatePicker` class provides functionality to easily choose an input date. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-DatePicker.html) */ constructor(properties?: DatePickerProperties); } interface DatePickerProperties extends WidgetProperties { /** * Indicates whether the date gets updated when the user changes the month in the drop-down. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-DatePicker.html#commitOnMonthChange) */ commitOnMonthChange?: boolean; /** * The input value for the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-DatePicker.html#value) */ value?: DateProperties; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-DatePicker.html#viewModel) */ viewModel?: DatePickerViewModelProperties; } export interface DatePickerViewModel extends Accessor, DateTimeElementViewModel { } export class DatePickerViewModel { /** * Provides the logic for the [DatePicker](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-DatePicker.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-DatePickerViewModel.html) */ constructor(properties?: DatePickerViewModelProperties); } interface DatePickerViewModelProperties extends DateTimeElementViewModelProperties { } export class DateTimeElementViewModel { /** * The current state of the widget. * * @default ready * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-DateTimeElementViewModel.html#state) */ state: "ready"; /** * The selected date. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-DateTimeElementViewModel.html#value) */ value: Date; } interface DateTimeElementViewModelProperties { /** * The current state of the widget. * * @default ready * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-DateTimeElementViewModel.html#state) */ state?: "ready"; /** * The selected date. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-DateTimeElementViewModel.html#value) */ value?: DateProperties; } export class GeolocationPositioning { /** * An object used for setting optional position parameters. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GeolocationPositioning.html#geolocationOptions) */ geolocationOptions: any; /** * Indicates whether to navigate the view to the position and scale of the geolocated result. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GeolocationPositioning.html#goToLocationEnabled) */ goToLocationEnabled: boolean; /** * The graphic used to show the user's location on the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GeolocationPositioning.html#graphic) */ graphic: Graphic; /** * Indicates the scale to set on the view when navigating to the position of the geolocated result, after a location is returned from the [track](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GeolocationPositioning.html#event-track) event. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GeolocationPositioning.html#scale) */ scale: number; /** * The view associated with the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GeolocationPositioning.html#view) */ view: MapView | SceneView; } interface GeolocationPositioningProperties { /** * An object used for setting optional position parameters. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GeolocationPositioning.html#geolocationOptions) */ geolocationOptions?: any; /** * Indicates whether to navigate the view to the position and scale of the geolocated result. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GeolocationPositioning.html#goToLocationEnabled) */ goToLocationEnabled?: boolean; /** * The graphic used to show the user's location on the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GeolocationPositioning.html#graphic) */ graphic?: GraphicProperties; /** * Indicates the scale to set on the view when navigating to the position of the geolocated result, after a location is returned from the [track](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GeolocationPositioning.html#event-track) event. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GeolocationPositioning.html#scale) */ scale?: number; /** * The view associated with the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GeolocationPositioning.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } export class GoTo { /** * This function provides the ability to override either the [MapView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) or [SceneView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) methods. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GoTo.html#goToOverride) */ goToOverride: GoToOverride; } interface GoToProperties { /** * This function provides the ability to override either the [MapView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) or [SceneView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) methods. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GoTo.html#goToOverride) */ goToOverride?: GoToOverride; } export class SnappingControls extends Widget { /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/SnappingControls#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html#iconClass) */ iconClass: string; /** * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) for sketching. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html#snappingOptions) */ snappingOptions: SnappingOptions; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html#view) */ view: MapView | SceneView; /** * The view model for the SnappingControls widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html#viewModel) */ viewModel: SnappingControlsViewModel; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html#visibleElements) */ visibleElements: SnappingControlsVisibleElements; /** * The SnappingControls widget provides a user interface to use alongside the [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) class. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html) */ constructor(properties?: SnappingControlsProperties); } interface SnappingControlsProperties extends WidgetProperties { /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/SnappingControls#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html#iconClass) */ iconClass?: string; /** * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) for sketching. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html#snappingOptions) */ snappingOptions?: SnappingOptionsProperties; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for the SnappingControls widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html#viewModel) */ viewModel?: SnappingControlsViewModelProperties; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html#visibleElements) */ visibleElements?: SnappingControlsVisibleElements; } export class SnappingControlsViewModel extends Accessor { /** * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) for sketching. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls-SnappingControlsViewModel.html#snappingOptions) */ snappingOptions: SnappingOptions; /** * The current state of the view model. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls-SnappingControlsViewModel.html#state) */ readonly state: "ready" | "disabled"; /** * The view associated with the SnappingControls widget instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls-SnappingControlsViewModel.html#view) */ view: MapView | SceneView; /** * Provides the logic for the [SnappingControls](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls-SnappingControlsViewModel.html) */ constructor(properties?: SnappingControlsViewModelProperties); } interface SnappingControlsViewModelProperties { /** * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) for sketching. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls-SnappingControlsViewModel.html#snappingOptions) */ snappingOptions?: SnappingOptionsProperties; /** * The view associated with the SnappingControls widget instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls-SnappingControlsViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html#VisibleElements) */ export interface SnappingControlsVisibleElements { /** * Indicates whether to display the header. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html#VisibleElements) */ header?: boolean; /** * Indicates whether to display the `enabledToggle` (Enable snapping). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html#VisibleElements) */ enabledToggle?: boolean; /** * Indicates whether to display the `selfEnabledToggle` (Geometry guides). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html#VisibleElements) */ selfEnabledToggle?: boolean; /** * Indicates whether to display the `featureEnabledToggle` (Feature to feature). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html#VisibleElements) */ featureEnabledToggle?: boolean; /** * Indicates whether to display the [FeatureSnappingLayerSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-FeatureSnappingLayerSource.html) layerList. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html#VisibleElements) */ layerList?: boolean; } export class TimePicker extends Widget { /** * The input value for the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-TimePicker.html#value) */ value: Date; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-TimePicker.html#viewModel) */ viewModel: TimePickerViewModel; /** * The `TimePicker` class provides functionality to easily choose an input date. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-TimePicker.html) */ constructor(properties?: TimePickerProperties); } interface TimePickerProperties extends WidgetProperties { /** * The input value for the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-TimePicker.html#value) */ value?: DateProperties; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-TimePicker.html#viewModel) */ viewModel?: TimePickerViewModelProperties; } export interface TimePickerViewModel extends Accessor, DateTimeElementViewModel { } export class TimePickerViewModel { /** * Provides the logic for the [TimePicker](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-TimePicker.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-TimePickerViewModel.html) */ constructor(properties?: TimePickerViewModelProperties); } interface TimePickerViewModelProperties extends DateTimeElementViewModelProperties { } namespace widget { /** * This convenience decorator is used to help simplify accessibility within the widget keyboard events. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-widget.html#accessibleHandler) */ function accessibleHandler(): Function; /** * Utility method used for creating CSS animation/transition functions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-widget.html#cssTransition) */ function cssTransition(type: "enter" | "exit", className: string): Function; /** * Utility method used to determine if a pressed key should activate button behavior. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-widget.html#isActivationKey) */ function isActivationKey(key: string): boolean; /** * Utility method used to determine if the directionality of the text of the document is right-to-left. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-widget.html#isRTL) */ function isRTL(): boolean; /** * This convenience decorator is used to help simplify localization of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-widget.html#messageBundle) */ function messageBundle(bundleId?: string): Function; /** * This convenience method is used to assign an [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) DOM node reference to a variable. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-widget.html#storeNode) */ function storeNode(node: HTMLElement): void; /** * This convenience decorator helps dispatch view model events on the widget instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-widget.html#vmEvent) */ function vmEvent(eventNames: string | string[]): Function; namespace tsx { /** * This convenience method is used to render the JSX in the [widget.render()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#render) method. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-widget.html#tsx) */ function tsx(selector: string, properties?: any, children?: any): any; namespace JSX { interface IntrinsicElements { [elementName: string]: any; } interface Element { } } } } export type GoToOverride = (view: MapView | SceneView, goToParameters: any) => void; export class Swipe extends Widget { /** * The direction the Swipe widget moves across the view. * * @default "horizontal" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#direction) */ direction: "horizontal" | "vertical"; /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#disabled) */ disabled: boolean; /** * The text that shows in a tooltip when hovering over the handle of the Swipe widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#dragLabel) */ dragLabel: string; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Swipe#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#iconClass) */ iconClass: string; /** * A collection of [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html)s that will show on the left or top side of the Swipe widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#leadingLayers) */ leadingLayers: Collection; /** * The position of the Swipe widget. * * @default 25 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#position) */ position: number; /** * A collection of [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html)s that will show on the right or bottom side of the Swipe widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#trailingLayers) */ trailingLayers: Collection; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#view) */ view: MapView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#viewModel) */ viewModel: SwipeViewModel; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#visibleElements) */ visibleElements: widgetsSwipeVisibleElements; /** * The Swipe widget provides a tool to show a portion of a layer or layers on top of a map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html) */ constructor(properties?: SwipeProperties); } interface SwipeProperties extends WidgetProperties { /** * The direction the Swipe widget moves across the view. * * @default "horizontal" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#direction) */ direction?: "horizontal" | "vertical"; /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#disabled) */ disabled?: boolean; /** * The text that shows in a tooltip when hovering over the handle of the Swipe widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#dragLabel) */ dragLabel?: string; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Swipe#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#iconClass) */ iconClass?: string; /** * A collection of [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html)s that will show on the left or top side of the Swipe widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#leadingLayers) */ leadingLayers?: CollectionProperties; /** * The position of the Swipe widget. * * @default 25 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#position) */ position?: number; /** * A collection of [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html)s that will show on the right or bottom side of the Swipe widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#trailingLayers) */ trailingLayers?: CollectionProperties; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#view) */ view?: MapViewProperties; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#viewModel) */ viewModel?: SwipeViewModelProperties; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#visibleElements) */ visibleElements?: widgetsSwipeVisibleElements; } export class SwipeViewModel extends Accessor { /** * The direction the Swipe widget moves across the view. * * @default "horizontal" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html#direction) */ direction: "horizontal" | "vertical"; /** * A collection of [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html)s that will show on the left or top side of Swipe widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html#leadingLayers) */ leadingLayers: Collection; /** * The position of the Swipe widget. * * @default 25 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html#position) */ position: number; /** * The current state of the widget. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html#state) */ readonly state: "disabled" | "ready"; /** * A collection of [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html)s that will show on the right or bottom side of Swipe widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html#trailingLayers) */ trailingLayers: Collection; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html#view) */ view: MapView; /** * Provides the logic for the [Swipe](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html) */ constructor(properties?: SwipeViewModelProperties); } interface SwipeViewModelProperties { /** * The direction the Swipe widget moves across the view. * * @default "horizontal" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html#direction) */ direction?: "horizontal" | "vertical"; /** * A collection of [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html)s that will show on the left or top side of Swipe widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html#leadingLayers) */ leadingLayers?: CollectionProperties; /** * The position of the Swipe widget. * * @default 25 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html#position) */ position?: number; /** * A collection of [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html)s that will show on the right or bottom side of Swipe widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html#trailingLayers) */ trailingLayers?: CollectionProperties; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html#view) */ view?: MapViewProperties; } export interface widgetsSwipeVisibleElements extends SwipeVisibleElements { /** * Indicates whether the handle from which you drag the widget is visible. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#visibleElements) */ handle: boolean; /** * Indicates whether the divider between the leading and trailing layers is visible. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#visibleElements) */ divider: boolean; } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#VisibleElements) */ export interface SwipeVisibleElements { /** * Indicates whether the handle from which you drag the widget is visible. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#VisibleElements) */ handle: boolean; /** * Indicates whether the divider between the leading and trailing layers is visible. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#VisibleElements) */ divider: boolean; } export class TableList extends Widget { /** * Indicates whether the widget is collapsed. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#collapsed) */ collapsed: boolean; /** * Indicates whether [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html) may be reordered within the list by dragging and dropping. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#dragEnabled) */ dragEnabled: boolean; /** * Placeholder text used in the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#visibleElements) is true. * * @default "" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#filterPlaceholder) */ filterPlaceholder: string; /** * The value of the filter input text string if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#visibleElements) is true. * * @default "" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#filterText) */ filterText: string; /** * Indicates the heading level to use for the [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#title) of the widget. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#headingLevel) */ headingLevel: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/TableList#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#iconClass) */ iconClass: string; /** * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#listItemCreatedFunction) */ listItemCreatedFunction: TableListListItemCreatedHandler; /** * A reference to a [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) containing the tables. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#map) */ map: Map | WebMap; /** * The minimum number of list items required to enable drag and drop reordering with [dragEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#dragEnabled). * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#minDragEnabledItems) */ minDragEnabledItems: number; /** * The minimum number of list items required to display the visibleElements.filter input box. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#minFilterItems) */ minFilterItems: number; /** * Indicates whether more than one [list item](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html) can be selected by a user at a single time. * * @default false * @deprecated since 4.29. Use {@link module:esri/widgets/TableList#selectionMode selectionMode} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#multipleSelectionEnabled) */ multipleSelectionEnabled: boolean; /** * A collection of selected [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html)s representing table list items selected by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#selectedItems) */ selectedItems: Collection; /** * Indicates whether [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html) may be selected by the user. * * @default false * @deprecated since 4.29. Use {@link module:esri/widgets/TableList#selectionMode selectionMode} and {@link module:esri/widgets/TableList#dragEnabled dragEnabled} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#selectionEnabled) */ selectionEnabled: boolean; /** * Specifies the selection mode. * * @default "none" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#selectionMode) */ selectionMode: "multiple" | "none" | "single" | "single-persist"; /** * The collection of table [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html)s displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#tableItems) */ readonly tableItems: Collection; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#viewModel) */ viewModel: TableListViewModel; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#visibleElements) */ visibleElements: TableListVisibleElements; /** * The TableList widget provides a way to display a list of tables associated with a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html) */ constructor(properties?: TableListProperties); /** * Triggers the [trigger-action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#event-trigger-action) event and executes the given [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [action toggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#triggerAction) */ triggerAction(action: ActionButton | ActionToggle, item: TableListListItem): void; on(name: "trigger-action", eventHandler: TableListTriggerActionEventHandler): IHandle; } interface TableListProperties extends WidgetProperties { /** * Indicates whether the widget is collapsed. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#collapsed) */ collapsed?: boolean; /** * Indicates whether [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html) may be reordered within the list by dragging and dropping. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#dragEnabled) */ dragEnabled?: boolean; /** * Placeholder text used in the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#visibleElements) is true. * * @default "" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#filterPlaceholder) */ filterPlaceholder?: string; /** * The value of the filter input text string if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#visibleElements) is true. * * @default "" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#filterText) */ filterText?: string; /** * Indicates the heading level to use for the [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#title) of the widget. * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#headingLevel) */ headingLevel?: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/TableList#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#iconClass) */ iconClass?: string; /** * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#listItemCreatedFunction) */ listItemCreatedFunction?: TableListListItemCreatedHandler; /** * A reference to a [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) containing the tables. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#map) */ map?: MapProperties | WebMapProperties; /** * The minimum number of list items required to enable drag and drop reordering with [dragEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#dragEnabled). * * @default 2 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#minDragEnabledItems) */ minDragEnabledItems?: number; /** * The minimum number of list items required to display the visibleElements.filter input box. * * @default 10 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#minFilterItems) */ minFilterItems?: number; /** * Indicates whether more than one [list item](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html) can be selected by a user at a single time. * * @default false * @deprecated since 4.29. Use {@link module:esri/widgets/TableList#selectionMode selectionMode} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#multipleSelectionEnabled) */ multipleSelectionEnabled?: boolean; /** * A collection of selected [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html)s representing table list items selected by the user. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#selectedItems) */ selectedItems?: CollectionProperties; /** * Indicates whether [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html) may be selected by the user. * * @default false * @deprecated since 4.29. Use {@link module:esri/widgets/TableList#selectionMode selectionMode} and {@link module:esri/widgets/TableList#dragEnabled dragEnabled} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#selectionEnabled) */ selectionEnabled?: boolean; /** * Specifies the selection mode. * * @default "none" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#selectionMode) */ selectionMode?: "multiple" | "none" | "single" | "single-persist"; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#viewModel) */ viewModel?: TableListViewModel; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#visibleElements) */ visibleElements?: TableListVisibleElements; } export class TableListListItem extends Identifiable { /** * Indicates whether the actions panel is open in the TableList. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html#actionsOpen) */ actionsOpen: boolean; /** * A nested 2-dimensional collection of actions that could be triggered on the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html#actionsSections) */ actionsSections: Collection>; /** * The Error object returned if an error occurred. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html#error) */ readonly error: Error; /** * When `true`, hides the layer from the TableList instance. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html#hidden) */ hidden: boolean; /** * The layer associated with the triggered action. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html#layer) */ layer: Layer; /** * Allows you to display custom content for each ListItem in the [TableList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html#panel) */ panel: TableListListItemPanel; /** * Value is `true` when the [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html#layer) is being published. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html#publishing) */ readonly publishing: boolean; /** * The title of the table. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html#title) */ title: string; constructor(); /** * Creates a deep clone of this object. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html#clone) */ clone(): TableListListItem; } export interface TableListListItemPanel extends Widget, Identifiable { } export class TableListListItemPanel { /** * Adds a CSS class used to style a node that represents the panel. * * @default esri-icon-layer-list * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItemPanel.html#className) */ className: string; /** * The content displayed in the ListItem panel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItemPanel.html#content) */ content: Widget | HTMLElement | string | any[]; /** * If `true`, disables the ListItem's panel so the user cannot open or interact with it. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItemPanel.html#disabled) */ disabled: boolean; /** * Indicates whether the panel's content should be rendered as a [Calcite Flow Item](https://developers.arcgis.com/calcite-design-system/components/flow-item/). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItemPanel.html#flowEnabled) */ flowEnabled: boolean; /** * The URL or data URI of an image used to represent the panel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItemPanel.html#image) */ image: string; /** * The panel's parent ListItem that represents a table in the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItemPanel.html#listItem) */ listItem: TableListListItem; /** * Indicates if the panel's content is open and visible to the user. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItemPanel.html#open) */ open: boolean; /** * The title of the panel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItemPanel.html#title) */ title: string; /** * This class allows you to display custom content for each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html) in the [TableList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItemPanel.html) */ constructor(properties?: TableListListItemPanelProperties); } interface TableListListItemPanelProperties extends WidgetProperties { /** * Adds a CSS class used to style a node that represents the panel. * * @default esri-icon-layer-list * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItemPanel.html#className) */ className?: string; /** * The content displayed in the ListItem panel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItemPanel.html#content) */ content?: WidgetProperties | HTMLElement | string | any[]; /** * If `true`, disables the ListItem's panel so the user cannot open or interact with it. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItemPanel.html#disabled) */ disabled?: boolean; /** * Indicates whether the panel's content should be rendered as a [Calcite Flow Item](https://developers.arcgis.com/calcite-design-system/components/flow-item/). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItemPanel.html#flowEnabled) */ flowEnabled?: boolean; /** * The URL or data URI of an image used to represent the panel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItemPanel.html#image) */ image?: string; /** * The panel's parent ListItem that represents a table in the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItemPanel.html#listItem) */ listItem?: TableListListItem; /** * Indicates if the panel's content is open and visible to the user. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItemPanel.html#open) */ open?: boolean; /** * The title of the panel. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItemPanel.html#title) */ title?: string; } /** * Provides the logic for the [TableList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-TableListViewModel.html) */ interface TableListViewModel { /** * Whether to provide an indication if a layer is being published in the [TableList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html). * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-TableListViewModel.html#checkPublishStatusEnabled) */ checkPublishStatusEnabled: boolean; /** * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-TableListViewModel.html#listItemCreatedFunction) */ listItemCreatedFunction: TableListViewModelListItemCreatedHandler; /** * A reference to the [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) containing the tables. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-TableListViewModel.html#map) */ map: Map | WebMap; /** * The view model's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-TableListViewModel.html#state) */ readonly state: "loading" | "ready" | "disabled"; /** * The collection of table [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html)s displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-TableListViewModel.html#tableItems) */ readonly tableItems: Collection; } export const TableListViewModel: TableListViewModel; export type TableListViewModelListItemCreatedHandler = (event: any) => void; export interface TableListViewModelTriggerActionEvent { action: ActionButton | ActionToggle; item: TableListListItem; } export type TableListListItemCreatedHandler = (event: any) => void; export interface TableListTriggerActionEvent { action: ActionButton | ActionToggle; item: TableListListItem; } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#VisibleElements) */ export interface TableListVisibleElements { /** * **Since 4.29** Indicates whether to display a close button in the header. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#VisibleElements) */ closeButton?: boolean; /** * **Since 4.29** Indicates whether to display a collapse button in the header. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#VisibleElements) */ collapseButton?: boolean; /** * **Since 4.25** Indicates whether layer load errors will be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#VisibleElements) */ errors?: boolean; /** * **Since 4.29** Indicates whether to display a filter input box when then number of list items is equal to or greater than the value set in [minFilterItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#minFilterItems), allowing users to filter tables by their title. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#VisibleElements) */ filter?: boolean; /** * **Since 4.29** Determines whether the widget should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#VisibleElements) */ flow?: boolean; /** * **Since 4.29** Indicates whether to display the widget heading. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#VisibleElements) */ heading?: boolean; /** * Indicates whether the status indicators will be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#VisibleElements) */ statusIndicators?: boolean; /** * **Since 4.29** Indicates whether temporary table indicators will be displayed for tables with [layer.persistenceEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#persistenceEnabled) set to `false`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#VisibleElements) */ temporaryTableIndicators?: boolean; } export class TimeSlider extends Widget { /** * Defines actions that will appear in a menu when the user clicks the ellipsis button ![timeSlider-actions-menu](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/timeslider/ellipsis.png) in the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#actions) */ actions: Collection; /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#disabled) */ disabled: boolean; /** * Lists the specific locations on the timeline where handle(s) will snap to when manipulated. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#effectiveStops) */ readonly effectiveStops: Date[]; /** * The temporal extent of the entire slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#fullTimeExtent) */ fullTimeExtent: TimeExtent; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/TimeSlider#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#iconClass) */ iconClass: string; /** * A function used to specify custom formatting and styling of the min, max, and extent labels of the TimeSlider. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#labelFormatFunction) */ labelFormatFunction: DateLabelFormatter; /** * Determines the layout used by the TimeSlider widget. * * @default auto * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#layout) */ layout: "auto" | "compact" | "wide"; /** * When `true`, the time slider will play its animation in a loop. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#loop) */ loop: boolean; /** * The time slider mode. * * @default "time-window" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#mode) */ mode: "instant" | "time-window" | "cumulative-from-start" | "cumulative-from-end"; /** * The time (in milliseconds) between animation steps. * * @default 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#playRate) */ playRate: number; /** * Defines specific locations on the time slider where thumbs will snap to when manipulated. * * @default { count : 10 } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#stops) */ stops: StopsByDates | StopsByCount | StopsByInterval; /** * When set, overrides the default TimeSlider ticks labelling system. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#tickConfigs) */ tickConfigs: TickConfig[]; /** * The current time extent of the time slider. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#timeExtent) */ timeExtent: TimeExtent; /** * Shows/hides time in the display. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#timeVisible) */ timeVisible: boolean; /** * Dates and times displayed in the widget will be displayed in this time zone. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#timeZone) */ timeZone: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#viewModel) */ viewModel: TimeSliderViewModel; /** * The TimeSlider widget simplifies visualization of temporal data in your application. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html) */ constructor(properties?: TimeSliderProperties); /** * Incrementally moves the time extent forward one stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#next) */ next(): void; /** * Initiates the time slider's temporal playback. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#play) */ play(): void; /** * Incrementally moves the time extent back one stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#previous) */ previous(): void; /** * Stops the time slider's temporal playback. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#stop) */ stop(): void; /** * Updates the [time slider](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#TimeSlider) widget definition in the provided [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#updateWebDocument) */ updateWebDocument(webmap: WebMap): void; on(name: "trigger-action", eventHandler: TimeSliderTriggerActionEventHandler): IHandle; /** * Extracts time slider settings from a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html) if the webmap contains a [time slider widget](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#TimeSlider) definition. * * @deprecated since 4.29. Use {@link module:esri/support/timeUtils#getTimeSliderSettingsFromWebMap getTimeSliderSettingsFromWebMap} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#getPropertiesFromWebMap) */ static getPropertiesFromWebMap(webMap: WebMap, signal?: AbortSignal): Promise; } interface TimeSliderProperties extends WidgetProperties { /** * Defines actions that will appear in a menu when the user clicks the ellipsis button ![timeSlider-actions-menu](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/timeslider/ellipsis.png) in the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#actions) */ actions?: CollectionProperties; /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#disabled) */ disabled?: boolean; /** * The temporal extent of the entire slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#fullTimeExtent) */ fullTimeExtent?: TimeExtentProperties; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/TimeSlider#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#iconClass) */ iconClass?: string; /** * A function used to specify custom formatting and styling of the min, max, and extent labels of the TimeSlider. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#labelFormatFunction) */ labelFormatFunction?: DateLabelFormatter; /** * Determines the layout used by the TimeSlider widget. * * @default auto * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#layout) */ layout?: "auto" | "compact" | "wide"; /** * When `true`, the time slider will play its animation in a loop. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#loop) */ loop?: boolean; /** * The time slider mode. * * @default "time-window" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#mode) */ mode?: "instant" | "time-window" | "cumulative-from-start" | "cumulative-from-end"; /** * The time (in milliseconds) between animation steps. * * @default 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#playRate) */ playRate?: number; /** * Defines specific locations on the time slider where thumbs will snap to when manipulated. * * @default { count : 10 } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#stops) */ stops?: StopsByDates | StopsByCount | StopsByInterval; /** * When set, overrides the default TimeSlider ticks labelling system. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#tickConfigs) */ tickConfigs?: TickConfig[]; /** * The current time extent of the time slider. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#timeExtent) */ timeExtent?: TimeExtentProperties; /** * Shows/hides time in the display. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#timeVisible) */ timeVisible?: boolean; /** * Dates and times displayed in the widget will be displayed in this time zone. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#timeZone) */ timeZone?: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#viewModel) */ viewModel?: TimeSliderViewModelProperties; } export class TimeSliderViewModel extends Accessor { /** * Defines actions that will appear in a menu when the user clicks the ellipsis button ![timeSlider-actions-menu](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/timeslider/ellipsis.png) in the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#actions) */ actions: Collection; /** * Defined specific locations on the timeline that the handles will snap to when manipulated. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#effectiveStops) */ readonly effectiveStops: Date[]; /** * The temporal extent of the entire slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#fullTimeExtent) */ fullTimeExtent: TimeExtent; /** * If animating, the time indicator(s) will restart if they reach the edge. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#loop) */ loop: boolean; /** * The time slider mode. * * @default time-window * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#mode) */ mode: "instant" | "time-window" | "cumulative-from-start" | "cumulative-from-end"; /** * The time (in milliseconds) between animation steps. * * @default 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#playRate) */ playRate: number; /** * The view model's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#state) */ readonly state: "disabled" | "ready" | "playing"; /** * Defines specific locations on the time slider where thumbs will snap to when manipulated. * * @default { count : 10 } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#stops) */ stops: StopsByDates | StopsByCount | StopsByInterval; /** * The current time extent of the time slider. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#timeExtent) */ timeExtent: TimeExtent; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#view) */ view: MapView | SceneView; /** * Provides the logic for the [TimeSlider](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html) */ constructor(properties?: TimeSliderViewModelProperties); /** * Incrementally moves the time extent forward one stop * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#next) */ next(): void; /** * Initiates the time slider's temporal playback. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#play) */ play(): void; /** * Incrementally moves the time extent back one stop. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#previous) */ previous(): void; /** * Stops the time slider's temporal playback. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#stop) */ stop(): void; /** * Updates the [time slider](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#TimeSlider) widget definition in the provided [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#updateWebDocument) */ updateWebDocument(webmap: WebMap): void; on(name: "trigger-action", eventHandler: TimeSliderViewModelTriggerActionEventHandler): IHandle; /** * Extracts time slider settings from a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html) if the webmap contains a [time slider widget](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#TimeSlider) definition. * * @deprecated since 4.29. Use {@link module:esri/support/timeUtils#getTimeSliderSettingsFromWebMap getTimeSliderSettingsFromWebMap} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#getPropertiesFromWebMap) */ static getPropertiesFromWebMap(webMap: WebMap, signal?: AbortSignal): Promise; } interface TimeSliderViewModelProperties { /** * Defines actions that will appear in a menu when the user clicks the ellipsis button ![timeSlider-actions-menu](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/timeslider/ellipsis.png) in the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#actions) */ actions?: CollectionProperties; /** * The temporal extent of the entire slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#fullTimeExtent) */ fullTimeExtent?: TimeExtentProperties; /** * If animating, the time indicator(s) will restart if they reach the edge. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#loop) */ loop?: boolean; /** * The time slider mode. * * @default time-window * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#mode) */ mode?: "instant" | "time-window" | "cumulative-from-start" | "cumulative-from-end"; /** * The time (in milliseconds) between animation steps. * * @default 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#playRate) */ playRate?: number; /** * Defines specific locations on the time slider where thumbs will snap to when manipulated. * * @default { count : 10 } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#stops) */ stops?: StopsByDates | StopsByCount | StopsByInterval; /** * The current time extent of the time slider. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#timeExtent) */ timeExtent?: TimeExtentProperties; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } /** * Definition of an action that can be assigned to the [actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#actions) property on the [TimeSlider](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#actions) or the [TimeSliderViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#actions). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#action) */ export interface Action { /** * The name of the icon to display. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#action) */ icon: string; /** * Unique identifier of the action. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#action) */ id: string; /** * The title of the action that will be displayed in the menu. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#action) */ title: string; } export interface TimeSliderViewModelTriggerActionEvent { action: Action; } export type DateLabelFormatter = ( value: Date | Date[], type?: "min" | "max" | "extent", element?: HTMLElement, layout?: "compact" | "wide", ) => void; /** * Divides the time slider's [fullTimeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#fullTimeExtent) into equal parts. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#StopsByCount) */ export interface StopsByCount { /** * Number of evenly spaced divisions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#StopsByCount) */ count: number; /** * The time period to divide. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#StopsByCount) */ timeExtent?: TimeExtent; } /** * Specifies an array of dates for the time slider widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#StopsByDates) */ export interface StopsByDates { /** * Array of dates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#StopsByDates) */ dates: Date[]; } /** * Defines regularly spaced stops on the time slider from a [TimeInterval](https://developers.arcgis.com/javascript/latest/api-reference/esri-TimeInterval.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#StopsByInterval) */ export interface StopsByInterval { /** * Specifies a granularity of temporal data and allows you to visualize the data at specified intervals. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#StopsByInterval) */ interval: TimeInterval; /** * A period of time with definitive start and end dates. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#StopsByInterval) */ timeExtent?: TimeExtent; } export interface TimeSliderTriggerActionEvent { action: Action; } export class TimeZoneLabel extends Widget { /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeZoneLabel.html#disabled) */ disabled: boolean; /** * The direction the widget will expand. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeZoneLabel.html#expandDirection) */ expandDirection: "start" | "end"; /** * The expanded state of the widget. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeZoneLabel.html#expanded) */ expanded: boolean; /** * A reference to a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeZoneLabel.html#view) */ view: MapView; /** * TimeZoneLabel is widget for displaying the current [time zone](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#timeZone) of the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeZoneLabel.html) */ constructor(properties?: TimeZoneLabelProperties); } interface TimeZoneLabelProperties extends WidgetProperties { /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeZoneLabel.html#disabled) */ disabled?: boolean; /** * The direction the widget will expand. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeZoneLabel.html#expandDirection) */ expandDirection?: "start" | "end"; /** * The expanded state of the widget. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeZoneLabel.html#expanded) */ expanded?: boolean; /** * A reference to a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeZoneLabel.html#view) */ view?: MapViewProperties; } export interface Track extends Widget, GoTo { } export class Track { /** * An object used for setting optional position parameters. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#geolocationOptions) */ geolocationOptions: any; /** * Indicates whether the widget will automatically navigate the view to the user's position when a geolocation result is found. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#goToLocationEnabled) */ goToLocationEnabled: boolean; /** * The graphic used to show the user's location on the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#graphic) */ graphic: Graphic; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/DirectionPad#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#iconClass) */ iconClass: string; /** * Indicates whether the widget will automatically rotate to the device heading based on the Geolocation APIs [`GeolocationCoordinates.heading`](https://developer.mozilla.org/en-US/docs/Web/API/GeolocationCoordinates/heading) property. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#rotationEnabled) */ rotationEnabled: boolean; /** * Indicates the [scale](https://developers.arcgis.com/documentation/mapping-apis-and-services/reference/zoom-levels-and-scale/) to set on the view when navigating to the position of the geolocated result, after a location is returned from the [track](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#event-track) event. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#scale) */ scale: number; /** * Indicates whether the widget is watching for new positions. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#tracking) */ readonly tracking: boolean; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#view) */ view: MapView | SceneView; /** * The viewModel for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#viewModel) */ viewModel: TrackViewModel; /** * Provides a simple button that animates the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) to the user's location when clicked. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html) */ constructor(properties?: TrackProperties); /** * When executed, the widget will start [tracking](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#tracking) the user's location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#start) */ start(): void; /** * Stops tracking the user's location when executed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#stop) */ stop(): void; on(name: "track", eventHandler: TrackTrackEventHandler): IHandle; on(name: "track-error", eventHandler: TrackTrackErrorEventHandler): IHandle; } interface TrackProperties extends WidgetProperties, GoToProperties { /** * An object used for setting optional position parameters. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#geolocationOptions) */ geolocationOptions?: any; /** * Indicates whether the widget will automatically navigate the view to the user's position when a geolocation result is found. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#goToLocationEnabled) */ goToLocationEnabled?: boolean; /** * The graphic used to show the user's location on the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#graphic) */ graphic?: GraphicProperties; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/DirectionPad#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#iconClass) */ iconClass?: string; /** * Indicates whether the widget will automatically rotate to the device heading based on the Geolocation APIs [`GeolocationCoordinates.heading`](https://developer.mozilla.org/en-US/docs/Web/API/GeolocationCoordinates/heading) property. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#rotationEnabled) */ rotationEnabled?: boolean; /** * Indicates the [scale](https://developers.arcgis.com/documentation/mapping-apis-and-services/reference/zoom-levels-and-scale/) to set on the view when navigating to the position of the geolocated result, after a location is returned from the [track](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#event-track) event. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#scale) */ scale?: number; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The viewModel for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#viewModel) */ viewModel?: TrackViewModelProperties; } export interface TrackViewModel extends Accessor, Evented, GeolocationPositioning, GoTo { } export class TrackViewModel { /** * Error that caused the last [track-error](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#event:track-error) event to fire. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#error) */ error: any | Error; /** * A function that is used as an expression to evaluate geolocation points, and returns a boolean value. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#positionFilterFunction) */ positionFilterFunction: Function; /** * The current state of the widget. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#state) */ readonly state: "disabled" | "ready" | "tracking" | "waiting" | "error"; /** * Indicates whether new positions are being watched. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#tracking) */ readonly tracking: boolean; /** * Provides the logic for the [Track](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html) widget, which animates the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) to the user's location when clicked and tracks it as the location is updated. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html) */ constructor(properties?: TrackViewModelProperties); /** * When executed, [tracking](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#tracking) starts at the user's location. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#start) */ start(): void; /** * Stops tracking the user's location when executed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#stop) */ stop(): void; on(name: "track", eventHandler: TrackViewModelTrackEventHandler): IHandle; on(name: "track-error", eventHandler: TrackViewModelTrackErrorEventHandler): IHandle; } interface TrackViewModelProperties extends GeolocationPositioningProperties, GoToProperties { /** * Error that caused the last [track-error](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#event:track-error) event to fire. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#error) */ error?: any | Error; /** * A function that is used as an expression to evaluate geolocation points, and returns a boolean value. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#positionFilterFunction) */ positionFilterFunction?: Function; } export interface TrackViewModelTrackErrorEvent { error: any | Error; } export interface TrackViewModelTrackEvent { position: any; } export interface TrackTrackErrorEvent { error: Error; } export interface TrackTrackEvent { position: any; } export class UtilityNetworkAssociations extends Widget { /** * Indicates whether to show a toggle to automatically show associations every time the map extent changes, or an action button to show associations within the current map extent on demand. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#autoRefreshAssociations) */ autoRefreshAssociations: boolean; /** * A [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html) used for representing the polyline geometry that is being drawn for connectivity associations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#connectivityAssociationsLineSymbol) */ connectivityAssociationsLineSymbol: SimpleLineSymbol; /** * Indicates whether to query and display connectivity associations. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#includeConnectivityAssociations) */ includeConnectivityAssociations: boolean; /** * Indicates whether to query and display structural attachment associations. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#includeStructuralAttachmentAssociations) */ includeStructuralAttachmentAssociations: boolean; /** * The maximum number of associations that can be returned from the server. * * @default 250 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#maxAllowableAssociations) */ maxAllowableAssociations: number; /** * The maximum value or upper bound of the Maximum allowable associations slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#maxAllowableAssociationsSliderMax) */ maxAllowableAssociationsSliderMax: number; /** * The minimum value or lower bound of the Maximum allowable associations slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#maxAllowableAssociationsSliderMin) */ maxAllowableAssociationsSliderMin: number; /** * Specifies the interval to move the maximum allowable associations slider with the up, or down keys. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#maxAllowableAssociationsSliderStep) */ maxAllowableAssociationsSliderStep: number; /** * Indicates whether to show arrows for connectivity associations. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#showArrowsConnectivity) */ showArrowsConnectivity: boolean; /** * Indicates whether to show arrows for structural attachment associations. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#showArrowsStructuralAttachment) */ showArrowsStructuralAttachment: boolean; /** * When `autoRefreshAssociations` is `true`, indicates whether to automatically show associations every time the current map extent changes. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#showAssociationsEnabled) */ showAssociationsEnabled: boolean; /** * A [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html) used for representing the polyline geometry that is being drawn for structural attachment associations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#structuralAttachmentAssociationsLineSymbol) */ structuralAttachmentAssociationsLineSymbol: SimpleLineSymbol; /** * Determines the utility network to use. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#utilityNetwork) */ utilityNetwork: UtilityNetwork; /** * The view associated with the UtilityNetworkAssociations widget instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#view) */ view: MapView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#viewModel) */ viewModel: UtilityNetworkAssociationsViewModel; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#visibleElements) */ visibleElements: UtilityNetworkAssociationsVisibleElements; /** * The UtilityNetworkAssociations widget class, functioning as a part of the ArcGIS Maps SDK for JavaScript, simplifies the management and manipulation of associations within a utility network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html) */ constructor(properties?: UtilityNetworkAssociationsProperties); } interface UtilityNetworkAssociationsProperties extends WidgetProperties { /** * Indicates whether to show a toggle to automatically show associations every time the map extent changes, or an action button to show associations within the current map extent on demand. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#autoRefreshAssociations) */ autoRefreshAssociations?: boolean; /** * A [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html) used for representing the polyline geometry that is being drawn for connectivity associations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#connectivityAssociationsLineSymbol) */ connectivityAssociationsLineSymbol?: SimpleLineSymbolProperties; /** * Indicates whether to query and display connectivity associations. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#includeConnectivityAssociations) */ includeConnectivityAssociations?: boolean; /** * Indicates whether to query and display structural attachment associations. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#includeStructuralAttachmentAssociations) */ includeStructuralAttachmentAssociations?: boolean; /** * The maximum number of associations that can be returned from the server. * * @default 250 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#maxAllowableAssociations) */ maxAllowableAssociations?: number; /** * The maximum value or upper bound of the Maximum allowable associations slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#maxAllowableAssociationsSliderMax) */ maxAllowableAssociationsSliderMax?: number; /** * The minimum value or lower bound of the Maximum allowable associations slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#maxAllowableAssociationsSliderMin) */ maxAllowableAssociationsSliderMin?: number; /** * Specifies the interval to move the maximum allowable associations slider with the up, or down keys. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#maxAllowableAssociationsSliderStep) */ maxAllowableAssociationsSliderStep?: number; /** * Indicates whether to show arrows for connectivity associations. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#showArrowsConnectivity) */ showArrowsConnectivity?: boolean; /** * Indicates whether to show arrows for structural attachment associations. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#showArrowsStructuralAttachment) */ showArrowsStructuralAttachment?: boolean; /** * When `autoRefreshAssociations` is `true`, indicates whether to automatically show associations every time the current map extent changes. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#showAssociationsEnabled) */ showAssociationsEnabled?: boolean; /** * A [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html) used for representing the polyline geometry that is being drawn for structural attachment associations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#structuralAttachmentAssociationsLineSymbol) */ structuralAttachmentAssociationsLineSymbol?: SimpleLineSymbolProperties; /** * Determines the utility network to use. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#utilityNetwork) */ utilityNetwork?: UtilityNetworkProperties; /** * The view associated with the UtilityNetworkAssociations widget instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#view) */ view?: MapViewProperties; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#viewModel) */ viewModel?: UtilityNetworkAssociationsViewModelProperties; /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#visibleElements) */ visibleElements?: UtilityNetworkAssociationsVisibleElements; } export class UtilityNetworkAssociationsViewModel extends Accessor { /** * A [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html) used for representing the polyline geometry that is being drawn for connectivity associations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#connectivityAssociationsLineSymbol) */ connectivityAssociationsLineSymbol: SimpleLineSymbol; /** * Indicates whether to query and display connectivity associations. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#includeConnectivityAssociations) */ includeConnectivityAssociations: boolean; /** * Indicates whether to query and display structural attachment associations. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#includeStructuralAttachmentAssociations) */ includeStructuralAttachmentAssociations: boolean; /** * The maximum number of associations that can be returned from the server. * * @default 250 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#maxAllowableAssociations) */ maxAllowableAssociations: number; /** * Indicates whether to show arrows for connectivity associations. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#showArrowsConnectivity) */ showArrowsConnectivity: boolean; /** * Indicates whether to show arrows for structural attachment associations. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#showArrowsStructuralAttachment) */ showArrowsStructuralAttachment: boolean; /** * The view model's state. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#state) */ readonly state: "disabled" | "loading" | "ready" | "executing" | "warning"; /** * A [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html) used for representing the polyline geometry that is being drawn for structural attachment associations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#structuralAttachmentAssociationsLineSymbol) */ structuralAttachmentAssociationsLineSymbol: SimpleLineSymbol; /** * Determines the utility network to use. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#utilityNetwork) */ utilityNetwork: UtilityNetwork; /** * The view associated with the UtilityNetworkAssociations widget instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#view) */ view: MapView; /** * Provides the logic for the [UtilityNetworkAssociations](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html) */ constructor(properties?: UtilityNetworkAssociationsViewModelProperties); /** * Removes all associations from the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#removeAssociations) */ removeAssociations(): void; /** * Queries associations within the current map extent. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#showAssociations) */ showAssociations(): Promise; } interface UtilityNetworkAssociationsViewModelProperties { /** * A [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html) used for representing the polyline geometry that is being drawn for connectivity associations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#connectivityAssociationsLineSymbol) */ connectivityAssociationsLineSymbol?: SimpleLineSymbolProperties; /** * Indicates whether to query and display connectivity associations. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#includeConnectivityAssociations) */ includeConnectivityAssociations?: boolean; /** * Indicates whether to query and display structural attachment associations. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#includeStructuralAttachmentAssociations) */ includeStructuralAttachmentAssociations?: boolean; /** * The maximum number of associations that can be returned from the server. * * @default 250 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#maxAllowableAssociations) */ maxAllowableAssociations?: number; /** * Indicates whether to show arrows for connectivity associations. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#showArrowsConnectivity) */ showArrowsConnectivity?: boolean; /** * Indicates whether to show arrows for structural attachment associations. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#showArrowsStructuralAttachment) */ showArrowsStructuralAttachment?: boolean; /** * A [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html) used for representing the polyline geometry that is being drawn for structural attachment associations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#structuralAttachmentAssociationsLineSymbol) */ structuralAttachmentAssociationsLineSymbol?: SimpleLineSymbolProperties; /** * Determines the utility network to use. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#utilityNetwork) */ utilityNetwork?: UtilityNetworkProperties; /** * The view associated with the UtilityNetworkAssociations widget instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#view) */ view?: MapViewProperties; } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#VisibleElements) */ export interface UtilityNetworkAssociationsVisibleElements { /** * The connectivity associations' line symbol settings that can be further configured. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#VisibleElements) */ connectivityAssociationsSettings?: VisibleElementsConnectivityAssociationsSettings; /** * Indicates whether to display a slider that adjusts the [maxAllowableAssociations](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#maxAllowableAssociations). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#VisibleElements) */ maxAllowableAssociationsSlider: boolean; /** * The structural attachment associations' line symbol settings that can be further configured. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#VisibleElements) */ structuralAttachmentAssociationsSettings?: VisibleElementsStructuralAttachmentAssociationsSettings; } export interface VisibleElementsConnectivityAssociationsSettings { /** * Indicates whether to display a toggle to hide / show arrows for connectivity associations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#VisibleElements) */ arrowsToggle?: boolean; /** * Indicates whether to display the cap input to update the line symbol's cap style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#VisibleElements) */ capSelect?: boolean; /** * Indicates whether to display the color picker to update the line symbol's color. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#VisibleElements) */ colorPicker?: boolean; /** * Indicates whether to display the style input to update the line symbol's style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#VisibleElements) */ stylePicker?: boolean; /** * Indicates whether to display the width input to update the line symbol's width. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#VisibleElements) */ widthInput?: boolean; } export interface VisibleElementsStructuralAttachmentAssociationsSettings { /** * Indicates whether to display a toggle to hide / show arrows for structural attachment associations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#VisibleElements) */ arrowsToggle?: boolean; /** * Indicates whether to display the cap input to update the line symbol's cap style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#VisibleElements) */ capSelect?: boolean; /** * Indicates whether to display the color picker to update the line symbol's color. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#VisibleElements) */ colorPicker?: boolean; /** * Indicates whether to display the style input to update the line symbol's style. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#VisibleElements) */ stylePicker?: boolean; /** * Indicates whether to display the width input to update the line symbol's width. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#VisibleElements) */ widthInput?: boolean; } export class UtilityNetworkTrace extends Widget { /** * The default color to assign the aggregated geometry of a trace result. * * @default { * color: [255, 255, 0, 0.6], * haloOpacity: 0.9, * fillOpacity: 0.2, * hex: "#FFFF00" * } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#defaultGraphicColor) */ defaultGraphicColor: GraphicColor; /** * When true, the widget is visually withdrawn and cannot be interacted with. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#disabled) */ disabled: boolean; /** * When `true`, provides the ability to show the convex hull or buffer. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#enableResultArea) */ enableResultArea: boolean; /** * An array of map points to load into the widget to lookup flags. * * @default [] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#flags) */ flags: FlagProperty[]; /** * The Geodatabase version to pass into the trace. * * @default "sde.DEFAULT" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#gdbVersion) */ gdbVersion: string; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/UtilityNetworkTrace#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#iconClass) */ iconClass: string; /** * Custom labels, descriptions, and symbol for the input [flags](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#flags). * * @default [] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#inputSettings) */ inputSettings: InputSetting[]; /** * The properties to determine the size and color of the result area convex hull or buffer, and determines if it displays on the map when the trace completes. * * @default { * type: "convexhull", * distance: 10, * unit: "meters", * areaUnit: "square-meters", * color: { * color: [255, 165, 0, 0.5], * haloOpacity: 0.9, * fillOpacity: 0.2, * hex: "#ffa500" * }, * show: false * } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#resultAreaProperties) */ resultAreaProperties: ResultAreaPropertiesExtend; /** * A list of global Ids of traces to select on load * * @default [] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#selectedTraces) */ selectedTraces: string[]; /** * When true, the utility network elements are selected in the view when traces are completed. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#selectOnComplete) */ selectOnComplete: boolean; /** * When true, a graphic layer is added to the view to highlight the utility network elements when traces are completed. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#showGraphicsOnComplete) */ showGraphicsOnComplete: boolean; /** * Determines whether to show list of selection attributes * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#showSelectionAttributes) */ showSelectionAttributes: boolean; /** * Determines the utility network to use. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#utilityNetwork) */ utilityNetwork: UtilityNetwork; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#view) */ view: MapView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#viewModel) */ viewModel: UtilityNetworkTraceViewModel; /** * The UtilityNetworkTrace widget provides a way to run traces in a Utility Network based on connectivity or traversability from set input flags. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html) */ constructor(properties?: UtilityNetworkTraceProperties); /** * Checks if the requirements to execute a trace are met. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#checkCanTrace) */ checkCanTrace(): Promise; /** * Prompts to clear all input flags, selected trace types, and the trace results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#confirmReset) */ confirmReset(): void; on(name: "add-flag", eventHandler: UtilityNetworkTraceAddFlagEventHandler): IHandle; on(name: "add-flag-complete", eventHandler: UtilityNetworkTraceAddFlagCompleteEventHandler): IHandle; on(name: "add-flag-error", eventHandler: UtilityNetworkTraceAddFlagErrorEventHandler): IHandle; on(name: "add-result-area", eventHandler: UtilityNetworkTraceAddResultAreaEventHandler): IHandle; on(name: "create-result-area", eventHandler: UtilityNetworkTraceCreateResultAreaEventHandler): IHandle; on(name: "remove-result-area", eventHandler: UtilityNetworkTraceRemoveResultAreaEventHandler): IHandle; } interface UtilityNetworkTraceProperties extends WidgetProperties { /** * The default color to assign the aggregated geometry of a trace result. * * @default { * color: [255, 255, 0, 0.6], * haloOpacity: 0.9, * fillOpacity: 0.2, * hex: "#FFFF00" * } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#defaultGraphicColor) */ defaultGraphicColor?: GraphicColor; /** * When true, the widget is visually withdrawn and cannot be interacted with. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#disabled) */ disabled?: boolean; /** * When `true`, provides the ability to show the convex hull or buffer. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#enableResultArea) */ enableResultArea?: boolean; /** * An array of map points to load into the widget to lookup flags. * * @default [] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#flags) */ flags?: FlagProperty[]; /** * The Geodatabase version to pass into the trace. * * @default "sde.DEFAULT" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#gdbVersion) */ gdbVersion?: string; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/UtilityNetworkTrace#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#iconClass) */ iconClass?: string; /** * Custom labels, descriptions, and symbol for the input [flags](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#flags). * * @default [] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#inputSettings) */ inputSettings?: InputSetting[]; /** * The properties to determine the size and color of the result area convex hull or buffer, and determines if it displays on the map when the trace completes. * * @default { * type: "convexhull", * distance: 10, * unit: "meters", * areaUnit: "square-meters", * color: { * color: [255, 165, 0, 0.5], * haloOpacity: 0.9, * fillOpacity: 0.2, * hex: "#ffa500" * }, * show: false * } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#resultAreaProperties) */ resultAreaProperties?: ResultAreaPropertiesExtend; /** * A list of global Ids of traces to select on load * * @default [] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#selectedTraces) */ selectedTraces?: string[]; /** * When true, the utility network elements are selected in the view when traces are completed. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#selectOnComplete) */ selectOnComplete?: boolean; /** * When true, a graphic layer is added to the view to highlight the utility network elements when traces are completed. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#showGraphicsOnComplete) */ showGraphicsOnComplete?: boolean; /** * Determines whether to show list of selection attributes * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#showSelectionAttributes) */ showSelectionAttributes?: boolean; /** * Determines the utility network to use. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#utilityNetwork) */ utilityNetwork?: UtilityNetworkProperties; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#view) */ view?: MapViewProperties; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#viewModel) */ viewModel?: UtilityNetworkTraceViewModelProperties; } export interface UtilityNetworkTraceViewModel extends Accessor, GoTo { } export class UtilityNetworkTraceViewModel { /** * The default color to assign the aggregated geometry of a trace result. * * @default { * color: [255, 255, 0, 0.6], * haloOpacity: 0.9, * fillOpacity: 0.2, * hex: "#FFFF00" * } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#defaultGraphicColor) */ defaultGraphicColor: GraphicColor; /** * When true, provides the ability to show the convex hull or buffer. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#enableResultArea) */ enableResultArea: boolean; /** * An array of map points to load into the widget to lookup flags. * * @default [] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#flags) */ flags: FlagProperty[]; /** * The Geodatabase version to pass into the trace. * * @default "sde.DEFAULT" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#gdbVersion) */ gdbVersion: string; /** * The properties to determine the size and color of the result area convex hull or buffer, and determines if it displays on the map when the trace completes. * * @default { * type: "convexhull", * distance: 10, * unit: "meters", * areaUnit: "square-meters", * color: { * color: [255, 165, 0, 0.5], * haloOpacity: 0.9, * fillOpacity: 0.2, * hex: "#ffa500" * }, * show: false * } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#resultAreaProperties) */ resultAreaProperties: ResultAreaPropertiesExtend; /** * An array of global Ids of traces to select on initial load. * * @default [] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#selectedTraces) */ selectedTraces: string[]; /** * When true, the utility network elements are selected in the view when traces are completed. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#selectOnComplete) */ selectOnComplete: boolean; /** * When true, a graphic layer is added to the view to highlight the utility network elements when traces are completed. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#showGraphicsOnComplete) */ showGraphicsOnComplete: boolean; /** * Determines whether to show the list of selected features from completed traces. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#showSelectionAttributes) */ showSelectionAttributes: boolean; /** * The view model's state. * * @default ready * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#state) */ readonly state: "loading" | "ready"; /** * Stores the result of completed traces. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#traceResults) */ traceResults: TraceResultExtend[]; /** * Determines the utility network to use. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#utilityNetwork) */ utilityNetwork: UtilityNetwork; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#view) */ view: MapView; /** * Provides the logic for the [UtilityNetworkTrace](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html) */ constructor(properties?: UtilityNetworkTraceViewModelProperties); /** * Adds a flag point graphic for the click event on the view if there is a feature to query. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#addFlagByHit) */ addFlagByHit(type: string): Promise; /** * Creates a graphic from the trace result and adds it to the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#addResultAreaToMap) */ addResultAreaToMap(trace: TraceResultExtend): void; /** * Create a graphic on the view’s [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#graphics) for the aggregated results of all the features returned by the trace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#addResultGraphicToView) */ addResultGraphicToView(trace: TraceResultExtend, color: GraphicColor): Promise; /** * Adds the selected terminal to a flag point. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#addTerminal) */ addTerminal(selectedTerminal: string, feature: FlagProperty): void; /** * Get all parameters for the trace type selected to be run before executing the trace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#callTrace) */ callTrace(): Promise; /** * Change the graphic color for the aggregated results of a trace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#changeResultGraphicColor) */ changeResultGraphicColor(color: GraphicColor, trace: TraceResultExtend): void; /** * May be used to verify if all requirements are met to execute a trace (at least 1 starting point and at least 1 trace type selected). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#checkCanTrace) */ checkCanTrace(): ValidSetup; /** * Indicates if any selection exists on the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#checkSelectionExist) */ checkSelectionExist(): boolean; /** * Removes a specific trace from the results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#clearResult) */ clearResult(trace: TraceItem): void; /** * Creates a buffer or convex hull graphic of the trace result. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#createResultAreaGraphic) */ createResultAreaGraphic(traceResults: TraceResultExtend): Promise; /** * Executes the trace and returns all trace results as graphics and/or feature selections and functions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#executeTrace) */ executeTrace(traceItem: TraceItem, url: string, params: TraceParameters): Promise; /** * Gets the valid edge and junction layers within the view that are part of the Utility Network and can be used for placing flags in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#getValidSources) */ getValidSources(): (EdgeSourceJSON | JunctionSourceJSON)[]; /** * Reads the web map and loads the [UtilityNetwork](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html) if it exists. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#loadUtilityNetwork) */ loadUtilityNetwork(): Promise; /** * Enables or disables the filter barrier setting on barrier flags. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#manageFilterBarrier) */ manageFilterBarrier(status: boolean, feature: FlagProperty): void; /** * Is used to merge the feature selections in the layer views when multiple traces are run. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#mergeSelection) */ mergeSelection(status: boolean, trace: TraceItem): void; /** * Query the layers by ObjectID for more attributes not present on the trace result elements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#queryFeaturesById) */ queryFeaturesById(dataItems: NetworkElement[]): Promise; /** * Takes the result of a hit test to lookup the asset to create a flag for the trace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#queryFlagByHitTest) */ queryFlagByHitTest(e: any, flagType: string): Promise; /** * Removes all the graphics from the result area graphic layer * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#removeAllResultAreaGraphics) */ removeAllResultAreaGraphics(): void; /** * Removes the selected flag from the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#removeFlag) */ removeFlag(flag: FlagProperty): void; /** * Removes the result area graphic from the `Map`. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#removeResultAreaFromMap) */ removeResultAreaFromMap(trace: TraceResultExtend): void; /** * Removes a specific trace result graphic from the view’s [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#graphics). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#removeResultGraphicFromView) */ removeResultGraphicFromView(trace: TraceResultExtend): void; /** * Removes the selection from the layer view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#removeSelection) */ removeSelection(): void; /** * Removes the selected terminal from the flag. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#removeTerminal) */ removeTerminal(selectedTerminal: string, feature: FlagProperty): void; /** * Clears all inputs (flags, trace types) and all results (selections, graphics) in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#reset) */ reset(): void; /** * Performs a selection on a layer view based on a list of ObjectIDs. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#selectFeaturesById) */ selectFeaturesById(resultSet: NetworkElement[]): void; /** * Loops through the trace result elements to group them by network source id and selects them on the layer view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#selectResults) */ selectResults(resultSet: NetworkElement[]): void; /** * Set the trace type to be run from the available trace configurations in the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#selectTraces) */ selectTraces(state: boolean, traceId: string): void; /** * Preset a trace type to be run from the available [trace configurations](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#sharedNamedTraceConfigurations) in the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html) when the widget loads. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#selectTracesOnLoad) */ selectTracesOnLoad(): void; /** * Zoom to a flag's feature or a result feature in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#zoomToAsset) */ zoomToAsset(geometry: GoToTarget2D | GoToTarget3D): void; } interface UtilityNetworkTraceViewModelProperties extends GoToProperties { /** * The default color to assign the aggregated geometry of a trace result. * * @default { * color: [255, 255, 0, 0.6], * haloOpacity: 0.9, * fillOpacity: 0.2, * hex: "#FFFF00" * } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#defaultGraphicColor) */ defaultGraphicColor?: GraphicColor; /** * When true, provides the ability to show the convex hull or buffer. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#enableResultArea) */ enableResultArea?: boolean; /** * An array of map points to load into the widget to lookup flags. * * @default [] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#flags) */ flags?: FlagProperty[]; /** * The Geodatabase version to pass into the trace. * * @default "sde.DEFAULT" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#gdbVersion) */ gdbVersion?: string; /** * The properties to determine the size and color of the result area convex hull or buffer, and determines if it displays on the map when the trace completes. * * @default { * type: "convexhull", * distance: 10, * unit: "meters", * areaUnit: "square-meters", * color: { * color: [255, 165, 0, 0.5], * haloOpacity: 0.9, * fillOpacity: 0.2, * hex: "#ffa500" * }, * show: false * } * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#resultAreaProperties) */ resultAreaProperties?: ResultAreaPropertiesExtend; /** * An array of global Ids of traces to select on initial load. * * @default [] * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#selectedTraces) */ selectedTraces?: string[]; /** * When true, the utility network elements are selected in the view when traces are completed. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#selectOnComplete) */ selectOnComplete?: boolean; /** * When true, a graphic layer is added to the view to highlight the utility network elements when traces are completed. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#showGraphicsOnComplete) */ showGraphicsOnComplete?: boolean; /** * Determines whether to show the list of selected features from completed traces. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#showSelectionAttributes) */ showSelectionAttributes?: boolean; /** * Stores the result of completed traces. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#traceResults) */ traceResults?: TraceResultExtend[]; /** * Determines the utility network to use. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#utilityNetwork) */ utilityNetwork?: UtilityNetworkProperties; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#view) */ view?: MapViewProperties; } /** * AssetGroupJSON represents the [asset group](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/utility-feature-classification.htm#GUID-A4CCEB96-C4F8-459B-A763-FF6A5791F663). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#AssetGroupJSON) */ export interface AssetGroupJSON { /** * The asset group code. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#AssetGroupJSON) */ assetGroupCode: number; /** * The asset group name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#AssetGroupJSON) */ assetGroupName: string; /** * The asset type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#AssetGroupJSON) */ assetTypes: AssetTypeJSON[]; } /** * AssetTypeJSON represents [asset type](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/utility-feature-classification.htm#GUID-A4CCEB96-C4F8-459B-A763-FF6A5791F663). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#AssetTypeJSON) */ export interface AssetTypeJSON { /** * The asset type code. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#AssetTypeJSON) */ assetTypeCode: number; /** * The asset type name. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#AssetTypeJSON) */ assetTypeName: string; /** * The id of the terminal configuration. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#AssetTypeJSON) */ terminalConfigurationId: number; } /** * DisplayField represents the attribute field used as a display label for flags and selected features. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#DisplayField) */ export interface DisplayField { /** * The feature's display field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#DisplayField) */ field: string; /** * The value of the field. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#DisplayField) */ value: string; } /** * EdgeSourceJSON represents the line layers that participate in the utility network service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#EdgeSourceJSON) */ export interface EdgeSourceJSON { /** * The layer id of the line layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#EdgeSourceJSON) */ layerId: number; /** * The asset group attribute values for the line layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#EdgeSourceJSON) */ assetGroups: AssetGroupJSON[]; /** * The network source id of the line layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#EdgeSourceJSON) */ sourceId: number; } /** * FeatureSetInfo represents the information for the results in the featureset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#FeatureSetInfo) */ export interface FeatureSetInfo { /** * The [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) of the dataset. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#FeatureSetInfo) */ layer: FeatureLayer; /** * The [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#FeatureSetInfo) */ featureSet: FeatureSet; } /** * FlagProperty represents the properties to define each flag point (starting points and barriers). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#FlagProperty) */ export interface FlagProperty { /** * The available [terminals](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-Terminal.html) to define the permissible paths based on the terminal configurations. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#FlagProperty) */ allTerminals: TerminalConfiguration; /** * All the information returned by the hitTest. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#FlagProperty) */ details: any; /** * The display field of the flag. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#FlagProperty) */ displayField: DisplayField; /** * The id of the flag. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#FlagProperty) */ id: number; /** * The flag graphic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#FlagProperty) */ mapGraphic: Graphic; /** * The geometry point of the flag. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#FlagProperty) */ mapPoint: Point; /** * The terminals that are selected for the flag (this can be the default terminal or terminals selected by the end-user). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#FlagProperty) */ selectedTerminals: number[]; /** * The flag type being set. * * [Read more...](global.html#type) */ type: string; } /** * GraphicColor represents the color for the trace result graphic in the graphics layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#GraphicColor) */ export interface GraphicColor { /** * The color of the trace result graphic in the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#GraphicColor) */ color: number[]; /** * The opacity of the graphic symbol's halo. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#GraphicColor) */ haloOpacity: number; /** * The color of the trace result graphic in the color picker. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#GraphicColor) */ hex: string; } /** * JunctionSourceJSON represents the point layers that participate in the utility network service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#JunctionSourceJSON) */ export interface JunctionSourceJSON { /** * The layer id of the point layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#JunctionSourceJSON) */ layerId: number; /** * The asset group attribute values for the point layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#JunctionSourceJSON) */ assetGroups: AssetGroupJSON[]; /** * The network source id of the point layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#JunctionSourceJSON) */ sourceId: number; } /** * ResultAreaPropertiesExtend represents the properties to determine the size and color of the result area convex hull or buffer, and whether it displays on the map when the trace completes. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#ResultAreaPropertiesExtend) */ export interface ResultAreaPropertiesExtend { /** * The geometry of the result area. * * [Read more...](global.html#type) */ type: "buffer" | "convexhull"; /** * The buffer or padding added to the result area. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#ResultAreaPropertiesExtend) */ distance: number; /** * Units for linear measurements. * * [Read more...](global.html#unit) */ unit: LinearUnits; /** * Units for area measurements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#ResultAreaPropertiesExtend) */ areaUnit: AreaUnits; /** * The color for the result area graphic. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#ResultAreaPropertiesExtend) */ color: GraphicColor; /** * Determines if the area is shown on the map. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#ResultAreaPropertiesExtend) */ show: boolean; } /** * TraceItem extends the named trace configuration and adds a property to manage the selection on the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#TraceItem) */ export interface TraceItem { /** * Returns `true` if there is a selection on the view for a trace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#TraceItem) */ selected: boolean; } /** * TraceResultExtend organizes the results based on the trace configuration and the trace results. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#TraceResultExtend) */ export interface TraceResultExtend { /** * TraceItem extends the named trace configuration and adds a property to manage the selection on the view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#TraceResultExtend) */ TraceItem: TraceItem; /** * The collection of results returned from the trace. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#TraceResultExtend) */ TraceResult: TraceResult; /** * Returns true if selection is enabled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#TraceResultExtend) */ selectionEnabled: boolean; /** * Returns true if graphic is enabled. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#TraceResultExtend) */ graphicEnabled: boolean; /** * The color for the graphic of the trace results in the graphics layer. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#TraceResultExtend) */ graphicColor: GraphicColor; /** * The current status of the trace to return errors from the server. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#TraceResultExtend) */ status: string; } /** * ValidSetup verifies whether a trace meets all the requirements before it can execute. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#ValidSetup) */ export interface ValidSetup { /** * Is `true` if the requirements are met. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#ValidSetup) */ status: boolean; /** * An array of error messages for the missing requirements. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#ValidSetup) */ issues: string[]; } export interface UtilityNetworkTraceAddFlagCompleteEvent { symbol: SimpleMarkerSymbol | PictureMarkerSymbol; type: "starting-point" | "barrier"; } export interface UtilityNetworkTraceAddFlagErrorEvent { symbol: SimpleMarkerSymbol | PictureMarkerSymbol; type: "starting-point" | "barrier"; } export interface UtilityNetworkTraceAddFlagEvent { type: "starting-point" | "barrier"; } export interface UtilityNetworkTraceAddResultAreaEvent { graphic: Graphic; } export interface UtilityNetworkTraceCreateResultAreaEvent { graphic: Graphic; } /** * InputSetting represents the labels, descriptions, and symbols that can be overridden for the [flags](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#flags) user interface (UI) in the UtilityNetworkTrace widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#InputSetting) */ export interface InputSetting { /** * The flag type indicates which section will have its settings overridden. * * [Read more...](global.html#type) */ type: "starting-point" | "barrier"; /** * The label that replaces either the default "Starting points" or "Barriers" headings depending on what flag type is passed. * * [Read more...](global.html) */ label: string; /** * The description that replaces the default sub-headings for either the starting points or barriers. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#InputSetting) */ description: string; /** * The symbol displayed next to either the "Starting points" or "Barriers" headings. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#InputSetting) */ symbol: SimpleMarkerSymbol | PictureMarkerSymbol; } export interface UtilityNetworkTraceRemoveResultAreaEvent { graphic: Graphic; } export class UtilityNetworkValidateTopology extends Widget { /** * Specifies the extent of the validation. * * @default current * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkValidateTopology.html#extentToValidate) */ extentToValidate: "current" | "entire"; /** * Determines the utility network to use. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkValidateTopology.html#utilityNetwork) */ utilityNetwork: UtilityNetwork; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkValidateTopology.html#view) */ view: MapView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkValidateTopology.html#viewModel) */ viewModel: UtilityNetworkValidateTopologyViewModel; /** * The UtilityNetworkValidateTopology widget class, functioning as a part of the ArcGIS Maps SDK for JavaScript, simplifies the process of validating a DirtyArea within a utility network. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkValidateTopology.html) */ constructor(properties?: UtilityNetworkValidateTopologyProperties); } interface UtilityNetworkValidateTopologyProperties extends WidgetProperties { /** * Specifies the extent of the validation. * * @default current * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkValidateTopology.html#extentToValidate) */ extentToValidate?: "current" | "entire"; /** * Determines the utility network to use. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkValidateTopology.html#utilityNetwork) */ utilityNetwork?: UtilityNetworkProperties; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkValidateTopology.html#view) */ view?: MapViewProperties; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkValidateTopology.html#viewModel) */ viewModel?: UtilityNetworkValidateTopologyViewModel; } export class UtilityNetworkValidateTopologyViewModel { /** * If the validation process fails, this property returns an error message. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkValidateTopology-UtilityNetworkValidateTopologyViewModel.html#executionError) */ readonly executionError: string; /** * Specifies the extent of the validation. * * @default current * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkValidateTopology-UtilityNetworkValidateTopologyViewModel.html#extentToValidate) */ extentToValidate: "current" | "entire"; /** * If an error occurs during during validation a loadError wil be displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkValidateTopology-UtilityNetworkValidateTopologyViewModel.html#loadErrors) */ loadErrors: Collection; /** * The view model's state. * * @default ready * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkValidateTopology-UtilityNetworkValidateTopologyViewModel.html#state) */ readonly state: "disabled" | "executing" | "failed" | "loading" | "ready" | "success"; /** * Determines the utility network to use. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkValidateTopology-UtilityNetworkValidateTopologyViewModel.html#utilityNetwork) */ utilityNetwork: UtilityNetwork; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkValidateTopology-UtilityNetworkValidateTopologyViewModel.html#view) */ view: MapView; constructor(properties?: any); /** * Validates the network topology of the [utility network](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkValidateTopology-UtilityNetworkValidateTopologyViewModel.html#utilityNetwork). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkValidateTopology-UtilityNetworkValidateTopologyViewModel.html#validateTopology) */ validateTopology(): void; } export class ValuePicker extends Widget { /** * Returns `true` if the ValuePicker can be advanced to the next position. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#canNext) */ canNext: boolean; /** * Returns `true` if the ValuePicker can be played. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#canPlay) */ canPlay: boolean; /** * Returns `true` if the ValuePicker can moved to the previous item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#canPrevious) */ canPrevious: boolean; /** * An optional caption that appears on the ValuePicker widget to give context for the user. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#caption) */ caption: string; /** * An optional component for presenting and managing data. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#component) */ component: ValuePickerCollection | ValuePickerCombobox | ValuePickerLabel | ValuePickerSlider; /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#disabled) */ disabled: boolean; /** * Indicates if the widget should be orientated horizontally (default) or vertically. * * @default "horizontal" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#layout) */ layout: "horizontal" | "vertical"; /** * If true, playback will restart when it reaches the end. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#loop) */ loop: boolean; /** * The pause, in milliseconds between playback advancement. * * @default 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#playRate) */ playRate: number; /** * The current value of the ValuePicker. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#values) */ values: number[] | string[] | any[]; /** * This property provides the ability to display or hide the individual elements of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#visibleElements) */ visibleElements: ValuePickerVisibleElements; /** * ValuePicker is a widget that allows users to step or play through a list of values. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html) */ constructor(properties?: ValuePickerProperties); /** * Select the next value or advance to next. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#next) */ next(): void; /** * Pause playing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#pause) */ pause(): void; /** * Start playing. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#play) */ play(): void; /** * Select the previous value. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#previous) */ previous(): void; on(name: "animate", eventHandler: ValuePickerAnimateEventHandler): IHandle; on(name: "next", eventHandler: ValuePickerNextEventHandler): IHandle; on(name: "pause", eventHandler: ValuePickerPauseEventHandler): IHandle; on(name: "play", eventHandler: ValuePickerPlayEventHandler): IHandle; on(name: "previous", eventHandler: ValuePickerPreviousEventHandler): IHandle; } interface ValuePickerProperties extends WidgetProperties { /** * Returns `true` if the ValuePicker can be advanced to the next position. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#canNext) */ canNext?: boolean; /** * Returns `true` if the ValuePicker can be played. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#canPlay) */ canPlay?: boolean; /** * Returns `true` if the ValuePicker can moved to the previous item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#canPrevious) */ canPrevious?: boolean; /** * An optional caption that appears on the ValuePicker widget to give context for the user. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#caption) */ caption?: string; /** * An optional component for presenting and managing data. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#component) */ component?: | (ValuePickerCollection & { type: "collection" }) | (ValuePickerCombobox & { type: "combobox" }) | (ValuePickerLabel & { type: "label" }) | (ValuePickerSlider & { type: "slider" }); /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#disabled) */ disabled?: boolean; /** * Indicates if the widget should be orientated horizontally (default) or vertically. * * @default "horizontal" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#layout) */ layout?: "horizontal" | "vertical"; /** * If true, playback will restart when it reaches the end. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#loop) */ loop?: boolean; /** * The pause, in milliseconds between playback advancement. * * @default 1000 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#playRate) */ playRate?: number; /** * The current value of the ValuePicker. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#values) */ values?: number[] | string[] | any[]; /** * This property provides the ability to display or hide the individual elements of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#visibleElements) */ visibleElements?: ValuePickerVisibleElements; } export class ValuePickerCollection { /** * A collection of values that can be navigated or animated with the play, next, and previous buttons on the [ValuePicker](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html) widget.. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerCollection.html#collection) */ collection: Collection; readonly type: "collection"; constructor(properties?: any); } export class ValuePickerCombobox { /** * An array of combobox items. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerCombobox.html#items) */ items: ComboboxItem[]; /** * Combobox label. * * @default "ValuePickerCombobox" * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerCombobox.html#label) */ label: string; /** * Combobox placeholder text. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerCombobox.html#placeholder) */ placeholder: string; readonly type: "combobox"; constructor(properties?: any); } /** * Object used to define the combobox [item](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerCombobox.html#items). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerCombobox.html#ComboboxItem) */ export interface ComboboxItem { /** * The value of the combobox item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerCombobox.html#ComboboxItem) */ value: string; /** * The label for this item that users will see in the combobox. * * [Read more...](global.html) */ label: string; } export class ValuePickerLabel { /** * An array of label items. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerLabel.html#items) */ items: Labelitem[]; readonly type: "label"; constructor(properties?: any); } /** * Object used to define the label items. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerLabel.html#labelitem) */ export interface Labelitem { /** * The value of the item. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerLabel.html#labelitem) */ value: string; /** * The label users will see for this item. * * [Read more...](global.html) */ label: string; } export class ValuePickerSlider { /** * A function used to format labels. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerSlider.html#labelFormatFunction) */ labelFormatFunction: SliderLabelFormatter; /** * Slider tick labels. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerSlider.html#labels) */ labels: number[]; /** * The positions of major ticks. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerSlider.html#majorTicks) */ majorTicks: number[]; /** * The maximum possible data/thumb value of the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerSlider.html#max) */ max: number; /** * The minimum possible data/thumb value on the slider. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerSlider.html#min) */ min: number; /** * The positions of minor ticks. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerSlider.html#minorTicks) */ minorTicks: number[]; /** * When true, slider values will ascend right to left and bottom to top when horizontal and vertical respectively. * * @default false * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerSlider.html#reversed) */ reversed: number; /** * Positions along the slider that the thumb will snap to when interacted with. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerSlider.html#steps) */ steps: number[]; readonly type: "slider"; /** * This property provides the ability to display or hide the individual elements of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerSlider.html#visibleElements) */ visibleElements: ValuePickerSliderVisibleElements; constructor(properties?: any); } /** * The visible elements that are displayed within the slider component. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerSlider.html#VisibleElements) */ export interface ValuePickerSliderVisibleElements { /** * When set to `true`, the current value is displayed in a permanent tooltip directly over the slider's thumb. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerSlider.html#VisibleElements) */ thumbTooltip?: boolean; } export interface ValuePickerAnimateEvent { } export interface ValuePickerNextEvent { } export interface ValuePickerPauseEvent { } export interface ValuePickerPlayEvent { } export interface ValuePickerPreviousEvent { } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#VisibleElements) */ export interface ValuePickerVisibleElements { /** * When set to `false`, the next button (or up button when vertical) is not displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#VisibleElements) */ nextButton?: boolean; /** * When set to `false`, the play/pause button is not displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#VisibleElements) */ playButton?: boolean; /** * When set to `false`, the previous button (or down button when vertical) is not displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#VisibleElements) */ previousButton?: boolean; } export interface VersionManagementViewModel extends Accessor, Evented { } export class VersionManagementViewModel { /** * Map of Service URLs and user type extensions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#advancedEditingUserTypeExtensionLookup) */ readonly advancedEditingUserTypeExtensionLookup: globalThis.Map; /** * Displays execution errors. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#executionError) */ readonly executionError: string; /** * A key-value pair of [FeatureServiceResourcesBundle](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#FeatureServiceResourcesBundle). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#featureServiceLookup) */ featureServiceLookup: globalThis.Map; /** * Displays an error if loading fails. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#loadError) */ readonly loadError: string; /** * Map of Service URLs and enterprise versions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#serverVersionLookup) */ readonly serverVersionLookup: globalThis.Map; /** * Map of Service URLs and service names. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#serviceNameLookup) */ serviceNameLookup: globalThis.Map; /** * The viewModel's state. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#state) */ readonly state: "disabled" | "executing" | "failed" | "loading" | "ready"; /** * Map of Service URLs and logged in users. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#userLookup) */ readonly userLookup: globalThis.Map; /** * A Map of current version identifiers keyed on the map service url. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#versionIdentifierLookup) */ readonly versionIdentifierLookup: globalThis.Map; /** * Contains information about the versions in the versionmanagementservice such as name, guid, etc * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#versionInfoLookup) */ versionInfoLookup: globalThis.Map; /** * This class contains metadata about the version management service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#versionManagementServiceLookup) */ versionManagementServiceLookup: globalThis.Map; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#view) */ view: MapView; /** * This class allows you to manage versions from a variety of [feature services](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html) */ constructor(properties?: VersionManagementViewModelProperties); /** * The alter operation allows you to change the geodatabase version's name, description, owner, and access permissions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#alterVersion) */ alterVersion(parameters: AlterVersionParameters): Promise; /** * Method used to change a version using a featureServerUrl, name, and guid of a version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#changeVersion) */ changeVersion(featureServerUrl: string, toVersionName: string, toVersionGuid: string): Promise; /** * Creates a new version given the following parameters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#createVersion) */ createVersion(parameters: CreateVersionParameters): Promise; /** * Deletes a version given the following parameters. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#deleteVersion) */ deleteVersion(featureServerUrl: string, versionName: string, versionGuid: string): Promise; /** * Returns an array of versions. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#getVersionInfos) */ getVersionInfos(featureServerUrl: string, refreshVersionInfos: boolean): Promise; } interface VersionManagementViewModelProperties { /** * A key-value pair of [FeatureServiceResourcesBundle](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#FeatureServiceResourcesBundle). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#featureServiceLookup) */ featureServiceLookup?: globalThis.Map; /** * Map of Service URLs and service names. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#serviceNameLookup) */ serviceNameLookup?: globalThis.Map; /** * Contains information about the versions in the versionmanagementservice such as name, guid, etc * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#versionInfoLookup) */ versionInfoLookup?: globalThis.Map; /** * This class contains metadata about the version management service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#versionManagementServiceLookup) */ versionManagementServiceLookup?: globalThis.Map; /** * The view from which the widget will operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#view) */ view?: MapViewProperties; } /** * Parameters used to alter a version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#AlterVersionParameters) */ export interface AlterVersionParameters { /** * The url of a feature service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#AlterVersionParameters) */ featureServerUrl: string; /** * The Identifier of a version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#AlterVersionParameters) */ versionIdentifier: VersionIdentifier; /** * The new owner name of the version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#AlterVersionParameters) */ ownerName?: string; /** * The new name for the version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#AlterVersionParameters) */ versionName?: string; /** * The new access permissions of the version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#AlterVersionParameters) */ access?: "hidden" | "private" | "protected" | "public"; /** * The new description for the version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#AlterVersionParameters) */ description?: string; } /** * Parameters used to create a new version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#CreateVersionParameters) */ export interface CreateVersionParameters { /** * The url of a feature service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#CreateVersionParameters) */ featureServerUrl: string; /** * The name of the new version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#CreateVersionParameters) */ versionName: string; /** * The access type of the new version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#CreateVersionParameters) */ access: "hidden" | "private" | "protected" | "public"; /** * The description of the new version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#CreateVersionParameters) */ description?: string; /** * The version owner. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#CreateVersionParameters) */ ownerName?: string; } /** * Contains [FeatureService](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html) and array of [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#FeatureServiceResourcesBundle) */ export interface VersionManagementViewModelFeatureServiceResourcesBundle { /** * The feature service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#FeatureServiceResourcesBundle) */ featureService: FeatureService; /** * An array of layers from the feature service. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#FeatureServiceResourcesBundle) */ layers: Layer[]; } /** * Contains info about a Version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#VersionInfo) */ export interface VersionInfo { /** * The Identifier of a version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#VersionInfo) */ versionIdentifier: VersionIdentifier; /** * Description of the version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#VersionInfo) */ description?: string; /** * The access type permissions of the version. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#VersionInfo) */ access?: "hidden" | "private" | "protected" | "public"; /** * The id of the version that was edited. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#VersionInfo) */ versionId?: string; /** * The date the version was created on. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#VersionInfo) */ creationDate?: number; } export class Weather extends Widget { /** * Indicates the heading level to use for the title of the widget. * * @default 4 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Weather.html#headingLevel) */ headingLevel: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Weather#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Weather.html#iconClass) */ iconClass: string; /** * A reference to the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Weather.html#view) */ view: SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Weather.html#viewModel) */ viewModel: WeatherViewModel; /** * This property provides the ability to display or hide the individual elements of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Weather.html#visibleElements) */ visibleElements: WeatherVisibleElements; /** * The Weather widget provides an interface for easily selecting and configuring the weather effects in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Weather.html) */ constructor(properties?: WeatherProperties); } interface WeatherProperties extends WidgetProperties { /** * Indicates the heading level to use for the title of the widget. * * @default 4 * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Weather.html#headingLevel) */ headingLevel?: number; /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Weather#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Weather.html#iconClass) */ iconClass?: string; /** * A reference to the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Weather.html#view) */ view?: SceneViewProperties; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Weather.html#viewModel) */ viewModel?: WeatherViewModelProperties; /** * This property provides the ability to display or hide the individual elements of the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Weather.html#visibleElements) */ visibleElements?: WeatherVisibleElements; } export class WeatherViewModel extends Accessor { /** * The current state of the view model that can be used for rendering the UI of the widget. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Weather-WeatherViewModel.html#state) */ readonly state: "disabled" | "ready"; /** * A reference to the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Weather-WeatherViewModel.html#view) */ view: SceneView; /** * Provides the logic for the [Weather](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Weather.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Weather-WeatherViewModel.html) */ constructor(properties?: WeatherViewModelProperties); /** * Sets the weather to the specified type. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Weather-WeatherViewModel.html#setWeatherByType) */ setWeatherByType(type: "sunny" | "cloudy" | "rainy" | "snowy" | "foggy"): void; } interface WeatherViewModelProperties { /** * A reference to the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Weather-WeatherViewModel.html#view) */ view?: SceneViewProperties; } /** * The visible elements that are displayed within the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Weather.html#VisibleElements) */ export interface WeatherVisibleElements { /** * When set to `false`, the header is not displayed. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Weather.html#VisibleElements) */ header?: boolean; } export interface Widget extends Accessor, Evented { } export class Widget { /** * The ID or node representing the DOM element containing the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#container) */ container: string | HTMLElement; /** * Icon which represents the widget. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#icon) */ icon: string; /** * The unique ID assigned to the widget when the widget is created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#id) */ id: string; /** * The widget's label. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label) */ label: string; /** * Indicates whether the widget is visible. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#visible) */ visible: boolean; /** * The base class for the SDK's out-of-the-box widgets. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html) */ constructor(properties?: WidgetProperties); /** * A utility method used for building the value for a widget's `class` property. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#classes) */ classes(...classNames: (string | string[] | any)[]): string; /** * Destroys the widget instance. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#destroy) */ destroy(): void; /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#isFulfilled) */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#isRejected) */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#isResolved) */ isResolved(): boolean; /** * Adds one or more handles which are to be tied to the lifecycle of the widget. * * @deprecated since 4.28 Use {@link module:esri/widgets/Widget#addHandles addHandles()} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#own) */ own(handleOrHandles: WatchHandle | WatchHandle[]): void; /** * *This method is primarily used by developers when implementing custom widgets.* Executes after widget is ready for rendering. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#postInitialize) */ postInitialize(): void; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#render) */ render(): any; /** * Renders widget to the DOM immediately. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#renderNow) */ renderNow(): void; /** * *This method is primarily used by developers when implementing custom widgets.* Schedules widget rendering. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#scheduleRender) */ scheduleRender(): void; /** * `when()` may be leveraged once an instance of the class is created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#when) */ when(callback?: Function, errback?: Function): Promise; } interface WidgetProperties { /** * The ID or node representing the DOM element containing the widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#container) */ container?: string | HTMLElement; /** * Icon which represents the widget. * * @default null * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#icon) */ icon?: string; /** * The unique ID assigned to the widget when the widget is created. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#id) */ id?: string; /** * The widget's label. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label) */ label?: string; /** * Indicates whether the widget is visible. * * @default true * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#visible) */ visible?: boolean; } export class Zoom extends Widget { /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Zoom#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html#iconClass) */ iconClass: string; /** * Determines the layout/orientation of the Zoom widget. * * @default vertical * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html#layout) */ layout: "vertical" | "horizontal"; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html#view) */ view: MapView | SceneView; /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html#viewModel) */ viewModel: ZoomViewModel; /** * The Zoom widget allows users to zoom in/out within a view. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html) */ constructor(properties?: ZoomProperties); /** * Zooms the view in by an LOD factor of 0.5. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html#zoomIn) */ zoomIn(): void; /** * Zooms the view out by an LOD factor of 2. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html#zoomOut) */ zoomOut(): void; } interface ZoomProperties extends WidgetProperties { /** * The widget's default CSS icon class. * * @deprecated since 4.27. Use {@link module:esri/widgets/Zoom#icon icon} instead. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html#iconClass) */ iconClass?: string; /** * Determines the layout/orientation of the Zoom widget. * * @default vertical * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html#layout) */ layout?: "vertical" | "horizontal"; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); /** * The view model for this widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html#viewModel) */ viewModel?: ZoomViewModelProperties; } export class ZoomViewModel extends Accessor { /** * Indicates if the view can zoom in. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom-ZoomViewModel.html#canZoomIn) */ canZoomIn: boolean; /** * Indicates if the view can zoom out. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom-ZoomViewModel.html#canZoomOut) */ canZoomOut: boolean; /** * The current state of the widget. * * @default disabled * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom-ZoomViewModel.html#state) */ readonly state: "disabled" | "ready"; /** * The view from which to operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom-ZoomViewModel.html#view) */ view: MapView | SceneView; /** * Provides the logic for the [Zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html) widget. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom-ZoomViewModel.html) */ constructor(properties?: ZoomViewModelProperties); /** * Zooms the view in by an LOD factor of 0.5. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom-ZoomViewModel.html#zoomIn) */ zoomIn(): void; /** * Zooms the view out by an LOD factor of 2. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom-ZoomViewModel.html#zoomOut) */ zoomOut(): void; } interface ZoomViewModelProperties { /** * Indicates if the view can zoom in. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom-ZoomViewModel.html#canZoomIn) */ canZoomIn?: boolean; /** * Indicates if the view can zoom out. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom-ZoomViewModel.html#canZoomOut) */ canZoomOut?: boolean; /** * The view from which to operate. * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom-ZoomViewModel.html#view) */ view?: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" }); } export type MultipointDrawActionCursorUpdateEventHandler = (event: MultipointDrawActionCursorUpdateEvent) => void; export type MultipointDrawActionDrawCompleteEventHandler = (event: MultipointDrawActionDrawCompleteEvent) => void; export type MultipointDrawActionRedoEventHandler = (event: MultipointDrawActionRedoEvent) => void; export type MultipointDrawActionUndoEventHandler = (event: MultipointDrawActionUndoEvent) => void; export type MultipointDrawActionVertexAddEventHandler = (event: MultipointDrawActionVertexAddEvent) => void; export type MultipointDrawActionVertexRemoveEventHandler = (event: MultipointDrawActionVertexRemoveEvent) => void; export type OGCFeatureLayerLayerviewCreateErrorEventHandler = ( event: OGCFeatureLayerLayerviewCreateErrorEvent, ) => void; export type OGCFeatureLayerLayerviewCreateEventHandler = (event: OGCFeatureLayerLayerviewCreateEvent) => void; export type OGCFeatureLayerLayerviewDestroyEventHandler = (event: OGCFeatureLayerLayerviewDestroyEvent) => void; export type OGCFeatureLayerRefreshEventHandler = (event: OGCFeatureLayerRefreshEvent) => void; export type PointDrawActionCursorUpdateEventHandler = (event: PointDrawActionCursorUpdateEvent) => void; export type PointDrawActionDrawCompleteEventHandler = (event: PointDrawActionDrawCompleteEvent) => void; export type PolygonDrawActionCursorUpdateEventHandler = (event: PolygonDrawActionCursorUpdateEvent) => void; export type PolygonDrawActionDrawCompleteEventHandler = (event: PolygonDrawActionDrawCompleteEvent) => void; export type PolygonDrawActionRedoEventHandler = (event: PolygonDrawActionRedoEvent) => void; export type PolygonDrawActionUndoEventHandler = (event: PolygonDrawActionUndoEvent) => void; export type PolygonDrawActionVertexAddEventHandler = (event: PolygonDrawActionVertexAddEvent) => void; export type PolygonDrawActionVertexRemoveEventHandler = (event: PolygonDrawActionVertexRemoveEvent) => void; export type PolylineDrawActionCursorUpdateEventHandler = (event: PolylineDrawActionCursorUpdateEvent) => void; export type PolylineDrawActionDrawCompleteEventHandler = (event: PolylineDrawActionDrawCompleteEvent) => void; export type PolylineDrawActionRedoEventHandler = (event: PolylineDrawActionRedoEvent) => void; export type PolylineDrawActionUndoEventHandler = (event: PolylineDrawActionUndoEvent) => void; export type PolylineDrawActionVertexAddEventHandler = (event: PolylineDrawActionVertexAddEvent) => void; export type PolylineDrawActionVertexRemoveEventHandler = (event: PolylineDrawActionVertexRemoveEvent) => void; export type PopupTriggerActionEventHandler = (event: PopupTriggerActionEvent) => void; export type PrintCompleteEventHandler = (event: PrintCompleteEvent) => void; export type PrintSubmitEventHandler = (event: PrintSubmitEvent) => void; export type SceneLayerEditsEventHandler = (event: SceneLayerEditsEvent) => void; export type SceneLayerLayerviewCreateErrorEventHandler = (event: SceneLayerLayerviewCreateErrorEvent) => void; export type SceneLayerLayerviewCreateEventHandler = (event: SceneLayerLayerviewCreateEvent) => void; export type SceneLayerLayerviewDestroyEventHandler = (event: SceneLayerLayerviewDestroyEvent) => void; export type SearchSearchBlurEventHandler = (event: SearchSearchBlurEvent) => void; export type SearchSearchClearEventHandler = (event: SearchSearchClearEvent) => void; export type SearchSearchCompleteEventHandler = (event: SearchSearchCompleteEvent) => void; export type SearchSearchFocusEventHandler = (event: SearchSearchFocusEvent) => void; export type SearchSearchStartEventHandler = (event: SearchSearchStartEvent) => void; export type SearchSelectResultEventHandler = (event: SearchSelectResultEvent) => void; export type SearchSuggestCompleteEventHandler = (event: SearchSuggestCompleteEvent) => void; export type SearchSuggestStartEventHandler = (event: SearchSuggestStartEvent) => void; export type SearchViewModelSearchClearEventHandler = (event: SearchViewModelSearchClearEvent) => void; export type SearchViewModelSearchCompleteEventHandler = (event: SearchViewModelSearchCompleteEvent) => void; export type SearchViewModelSearchStartEventHandler = (event: SearchViewModelSearchStartEvent) => void; export type SearchViewModelSelectResultEventHandler = (event: SearchViewModelSelectResultEvent) => void; export type SearchViewModelSuggestCompleteEventHandler = (event: SearchViewModelSuggestCompleteEvent) => void; export type SearchViewModelSuggestStartEventHandler = (event: SearchViewModelSuggestStartEvent) => void; export type SegmentDrawActionCursorUpdateEventHandler = (event: SegmentDrawActionCursorUpdateEvent) => void; export type SegmentDrawActionDrawCompleteEventHandler = (event: SegmentDrawActionDrawCompleteEvent) => void; export type SegmentDrawActionVertexAddEventHandler = (event: SegmentDrawActionVertexAddEvent) => void; export type SketchCreateEventHandler = (event: SketchCreateEvent) => void; export type SketchDeleteEventHandler = (event: SketchDeleteEvent) => void; export type SketchRedoEventHandler = (event: SketchRedoEvent) => void; export type SketchUndoEventHandler = (event: SketchUndoEvent) => void; export type SketchUpdateEventHandler = (event: SketchUpdateEvent) => void; export type SketchViewModelCreateEventHandler = (event: SketchViewModelCreateEvent) => void; export type SketchViewModelDeleteEventHandler = (event: SketchViewModelDeleteEvent) => void; export type SketchViewModelRedoEventHandler = (event: SketchViewModelRedoEvent) => void; export type SketchViewModelUndoEventHandler = (event: SketchViewModelUndoEvent) => void; export type SketchViewModelUpdateEventHandler = (event: SketchViewModelUpdateEvent) => void; export type SliderMaxChangeEventHandler = (event: SliderMaxChangeEvent) => void; export type SliderMaxClickEventHandler = (event: SliderMaxClickEvent) => void; export type SliderMinChangeEventHandler = (event: SliderMinChangeEvent) => void; export type SliderMinClickEventHandler = (event: SliderMinClickEvent) => void; export type SliderSegmentClickEventHandler = (event: SliderSegmentClickEvent) => void; export type SliderSegmentDragEventHandler = (event: SliderSegmentDragEvent) => void; export type SliderThumbChangeEventHandler = (event: SliderThumbChangeEvent) => void; export type SliderThumbClickEventHandler = (event: SliderThumbClickEvent) => void; export type SliderThumbDragEventHandler = (event: SliderThumbDragEvent) => void; export type SliderTickClickEventHandler = (event: SliderTickClickEvent) => void; export type SliderTrackClickEventHandler = (event: SliderTrackClickEvent) => void; export type SmartMappingSliderBaseMaxChangeEventHandler = (event: SmartMappingSliderBaseMaxChangeEvent) => void; export type SmartMappingSliderBaseMinChangeEventHandler = (event: SmartMappingSliderBaseMinChangeEvent) => void; export type SmartMappingSliderBaseSegmentDragEventHandler = (event: SmartMappingSliderBaseSegmentDragEvent) => void; export type SmartMappingSliderBaseThumbChangeEventHandler = (event: SmartMappingSliderBaseThumbChangeEvent) => void; export type SmartMappingSliderBaseThumbDragEventHandler = (event: SmartMappingSliderBaseThumbDragEvent) => void; export type StreamConnectionDataReceivedEventHandler = (event: StreamConnectionDataReceivedEvent) => void; export type StreamLayerViewDataReceivedEventHandler = (event: StreamLayerViewDataReceivedEvent) => void; export type StreamLayerViewMessageReceivedEventHandler = (event: StreamLayerViewMessageReceivedEvent) => void; export type StreamLayerViewUpdateRateEventHandler = (event: StreamLayerViewUpdateRateEvent) => void; export type SubtypeGroupLayerEditsEventHandler = (event: SubtypeGroupLayerEditsEvent) => void; export type SubtypeGroupLayerLayerviewCreateErrorEventHandler = ( event: SubtypeGroupLayerLayerviewCreateErrorEvent, ) => void; export type SubtypeGroupLayerLayerviewCreateEventHandler = (event: SubtypeGroupLayerLayerviewCreateEvent) => void; export type SubtypeGroupLayerLayerviewDestroyEventHandler = (event: SubtypeGroupLayerLayerviewDestroyEvent) => void; export type SubtypeGroupLayerRefreshEventHandler = (event: SubtypeGroupLayerRefreshEvent) => void; export type TableListTriggerActionEventHandler = (event: TableListTriggerActionEvent) => void; export type TableListViewModelTriggerActionEventHandler = (event: TableListViewModelTriggerActionEvent) => void; export type TileLayerLayerviewCreateErrorEventHandler = (event: TileLayerLayerviewCreateErrorEvent) => void; export type TileLayerLayerviewCreateEventHandler = (event: TileLayerLayerviewCreateEvent) => void; export type TileLayerLayerviewDestroyEventHandler = (event: TileLayerLayerviewDestroyEvent) => void; export type TileLayerRefreshEventHandler = (event: TileLayerRefreshEvent) => void; export type TimeSliderTriggerActionEventHandler = (event: TimeSliderTriggerActionEvent) => void; export type TimeSliderViewModelTriggerActionEventHandler = (event: TimeSliderViewModelTriggerActionEvent) => void; export type TrackTrackErrorEventHandler = (event: TrackTrackErrorEvent) => void; export type TrackTrackEventHandler = (event: TrackTrackEvent) => void; export type TrackViewModelTrackErrorEventHandler = (event: TrackViewModelTrackErrorEvent) => void; export type TrackViewModelTrackEventHandler = (event: TrackViewModelTrackEvent) => void; export type UtilityNetworkTraceAddFlagCompleteEventHandler = (event: UtilityNetworkTraceAddFlagCompleteEvent) => void; export type UtilityNetworkTraceAddFlagErrorEventHandler = (event: UtilityNetworkTraceAddFlagErrorEvent) => void; export type UtilityNetworkTraceAddFlagEventHandler = (event: UtilityNetworkTraceAddFlagEvent) => void; export type UtilityNetworkTraceAddResultAreaEventHandler = (event: UtilityNetworkTraceAddResultAreaEvent) => void; export type UtilityNetworkTraceCreateResultAreaEventHandler = ( event: UtilityNetworkTraceCreateResultAreaEvent, ) => void; export type UtilityNetworkTraceRemoveResultAreaEventHandler = ( event: UtilityNetworkTraceRemoveResultAreaEvent, ) => void; export type ValuePickerAnimateEventHandler = (event: ValuePickerAnimateEvent) => void; export type ValuePickerNextEventHandler = (event: ValuePickerNextEvent) => void; export type ValuePickerPauseEventHandler = (event: ValuePickerPauseEvent) => void; export type ValuePickerPlayEventHandler = (event: ValuePickerPlayEvent) => void; export type ValuePickerPreviousEventHandler = (event: ValuePickerPreviousEvent) => void; export type ViewBlurEventHandler = (event: ViewBlurEvent) => void; export type ViewClickEventHandler = (event: ViewClickEvent) => void; export type ViewDoubleClickEventHandler = (event: ViewDoubleClickEvent) => void; export type ViewDragEventHandler = (event: ViewDragEvent) => void; export type ViewFocusEventHandler = (event: ViewFocusEvent) => void; export type ViewHoldEventHandler = (event: ViewHoldEvent) => void; export type ViewImmediateClickEventHandler = (event: ViewImmediateClickEvent) => void; export type ViewImmediateDoubleClickEventHandler = (event: ViewImmediateDoubleClickEvent) => void; export type ViewKeyDownEventHandler = (event: ViewKeyDownEvent) => void; export type ViewKeyUpEventHandler = (event: ViewKeyUpEvent) => void; export type ViewLayerviewCreateErrorEventHandler = (event: ViewLayerviewCreateErrorEvent) => void; export type ViewLayerviewCreateEventHandler = (event: ViewLayerviewCreateEvent) => void; export type ViewLayerviewDestroyEventHandler = (event: ViewLayerviewDestroyEvent) => void; export type ViewMouseWheelEventHandler = (event: ViewMouseWheelEvent) => void; export type ViewPointerDownEventHandler = (event: ViewPointerDownEvent) => void; export type ViewPointerEnterEventHandler = (event: ViewPointerEnterEvent) => void; export type ViewPointerLeaveEventHandler = (event: ViewPointerLeaveEvent) => void; export type ViewPointerMoveEventHandler = (event: ViewPointerMoveEvent) => void; export type ViewPointerUpEventHandler = (event: ViewPointerUpEvent) => void; export type ViewResizeEventHandler = (event: ViewResizeEvent) => void; export type WFSLayerLayerviewCreateErrorEventHandler = (event: WFSLayerLayerviewCreateErrorEvent) => void; export type WFSLayerLayerviewCreateEventHandler = (event: WFSLayerLayerviewCreateEvent) => void; export type WFSLayerLayerviewDestroyEventHandler = (event: WFSLayerLayerviewDestroyEvent) => void; export type WFSLayerRefreshEventHandler = (event: WFSLayerRefreshEvent) => void; export type WMSLayerLayerviewCreateErrorEventHandler = (event: WMSLayerLayerviewCreateErrorEvent) => void; export type WMSLayerLayerviewCreateEventHandler = (event: WMSLayerLayerviewCreateEvent) => void; export type WMSLayerLayerviewDestroyEventHandler = (event: WMSLayerLayerviewDestroyEvent) => void; export type WMSLayerRefreshEventHandler = (event: WMSLayerRefreshEvent) => void; export namespace CIM { /** * Represents the properties required for authoring an Arcade expression. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMRenderers.md#enumberation-ExpressionReturnType) */ export enum ExpressionReturnType { /** * The return type of the expression is determined by the consumer using the expression. */ Default = "Default", /** * The return type of the expression is treated as a string by all consumers. */ String = "String", /** * The return type of the expression is treated as a numeric value by all consumers. */ Numeric = "Numeric" } /** * Represents 3D symbol properties, a collection of symbol properties that apply when the symbol is used in a 3D context. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-AngleAlignment) */ export enum AngleAlignment { /** * Points remain aligned to the display when the map is rotated. */ Display = "Display", /** * Points are rotated with the map. */ Map = "Map" } /** * Represents a balloon callout. Balloon callouts are a filled background that is placed behind text. They may or may not have a leader line connecting the callout to an anchor point. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-BalloonCalloutStyle) */ export enum BalloonCalloutStyle { /** * Rectangle style. */ Rectangle = "Rectangle", /** * Rounded rectangle style. */ RoundedRectangle = "RoundedRectangle", /** * Oval style. */ Oval = "Oval" } /** * Represents a bar chart marker, a chart made of vertical bars displaying values. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-BlendingMode) */ export enum BlendingMode { /** * No blending. */ None = "None", /** * Alpha blending. */ Alpha = "Alpha", /** * Screen. */ Screen = "Screen", /** * Multiply. */ Multiply = "Multiply", /** * Add. */ Add = "Add" } /** * Represents a bar chart marker, a chart made of vertical bars displaying values. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-BlockProgression) */ export enum BlockProgression { /** * Top To Bottom. */ TTB = "TTB", /** * Right To Left (vertical text). */ RTL = "RTL", /** * Bottom To Top. */ BTT = "BTT" } /** * Represents a CGA attribute, the symbol attribute as specified by the CGA code in the rule package. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-CGAAttributeType) */ export enum CGAAttributeType { /** * Float - Attribute is a numeric attribute that is a float value */ Float = "Float", /** * String - Attribute is a string */ String = "String", /** * Boolean - Attribute is a boolean */ Boolean = "Boolean" } /** * Represents a vector marker clipping path. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-ClippingType) */ export enum ClippingType { /** * Intersect. */ Intersect = "Intersect", /** * Subtract. */ Subtract = "Subtract" } /** * Represents the text part position properties on a callout part. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-ExternalColorMixMode) */ export enum ExternalColorMixMode { /** * Tint using external color. */ Tint = "Tint", /** * Ignore external color. */ Ignore = "Ignore", /** * Multiply components by components of external color. */ Multiply = "Multiply" } /** * Represents the text part position properties on a callout part. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-ExtremityPlacement) */ export enum ExtremityPlacement { /** * Both - marker is placed at the beginning and end of the line. */ Both = "Both", /** * JustBegin - marker is placed at the beginning of the line, determined by the direction that the line was digitized. */ JustBegin = "JustBegin", /** * JustEnd - marker is placed at the end of the line, determined by the direction that the line was digitized. */ JustEnd = "JustEnd", /** * None - no marker is placed at either end of the marker. */ None = "None" } /** * Represents the text part position properties on a callout part. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-FillMode) */ export enum FillMode { /** * Mosaic fill. */ Mosaic = "Mosaic", /** * Centered fill. */ Centered = "Centered" } /** * Represents the text part position properties on a callout part. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-FontEffects) */ export enum FontEffects { /** * Normal text. */ Normal = "Normal", /** * Superscript text. */ Superscript = "Superscript", /** * Subscript text */ Subscript = "Subscript" } /** * Represents the text part position properties on a callout part. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-FontEncoding) */ export enum FontEncoding { /** * Symbol encoding. */ MSSymbol = "MSSymbol", /** * Unicode. */ Unicode = "Unicode" } /** * Represents the text part position properties on a callout part. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-FontType) */ export enum FontType { /** * Unspecified. */ Unspecified = "Unspecified", /** * TrueType. */ TrueType = "TrueType", /** * OpenType with CFF outlines. */ PSOpenType = "PSOpenType", /** * OpenType with TrueType outlines. */ TTOpenType = "TTOpenType", /** * Adobe Type 1. */ Type1 = "Type1" } /** * Represents the arrow geometric effect which creates a dynamic line along a line feature with an arrow of a specified arrow type and width. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-GeometricEffectArrowType) */ export enum GeometricEffectArrowType { /** * An open ended arrow. */ OpenEnded = "OpenEnded", /** * A block arrow. */ Block = "Block", /** * A crossed arrow. */ Crossed = "Crossed" } /** * Represents the donut geometric effect which creates a dynamic polygon ring of a specified width in relation to the outline of polygon features. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-GeometricEffectDonutMethod) */ export enum GeometricEffectDonutMethod { /** * Mitered - matches the exact shape around a convex corner of the polygon. */ Mitered = "Mitered", /** * Bevelled - follows the shortest straight path across a convex corner of the polygon. */ Bevelled = "Bevelled", /** * Rounded - follows a path of equal distance around a convex corner of the polygon. */ Rounded = "Rounded", /** * Square - follows a straight path across the corner of a line or polygon. */ Square = "Square", /** * TrueBuffer - uses the buffer algorithm to follow a path around convex corners. */ TrueBuffer = "TrueBuffer" } /** * Represents the enclosing polygon geometric effect which creates a dynamic polygon from the spatial extent of a line or polygon feature. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-GeometricEffectEnclosingPolygonMethod) */ export enum GeometricEffectEnclosingPolygonMethod { /** * ClosePath - for polygon input, it generates a polygon that matches the geometry of a polygon feature. For line input, it generates a polygon that connects both ends of the line to each other. */ ClosePath = "ClosePath", /** * ConvexHull - for polygon input, it generates a polygon with a minimum number of sides to surround the feature. For line input, it generates a polygon that approximates the shape of the line. */ ConvexHull = "ConvexHull", /** * RectangularBox - generates a polygon equal to the spatial envelope of the feature. */ RectangularBox = "RectangularBox" } /** * Represents the extension geometric effect which creates a dynamic line that is extended from either the beginning or the end of the line feature at a specified deflection angle and length. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-GeometricEffectExtensionOrigin) */ export enum GeometricEffectExtensionOrigin { /** * BeginningOfLine - extension is added to the end of the line. */ BeginningOfLine = "BeginningOfLine", /** * EndOfLine - extension is added to the end of the line. */ EndOfLine = "EndOfLine" } /** * Represents a geometric effect which creates a localizer feather for aeronautical charts. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-GeometricEffectLocalizerFeatherStyle) */ export enum GeometricEffectLocalizerFeatherStyle { /** * Displays a complete localizer feather. */ Complete = "Complete", /** * Displays the left side of a localizer feather. */ Left = "Left", /** * Displays the right side of a localizer feather. */ Right = "Right" } /** * Represents a geometric effect which creates a hatch pattern to depict special use airspace for aeronautical charts. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-GeometricEffectOffsetMethod) */ export enum GeometricEffectOffsetMethod { /** * Mitered - matches the exact shape around a corner of the line or polygon. */ Mitered = "Mitered", /** * Bevelled - follows the shortest straight path across a corner of the line or polygon. */ Bevelled = "Bevelled", /** * Rounded - follows a path of equal distance around a corner of the line or polygon. */ Rounded = "Rounded", /** * Square - follows a straight path across the corner of a line or polygon. */ Square = "Square" } /** * Represents a geometric effect which creates a hatch pattern to depict special use airspace for aeronautical charts. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-GeometricEffectOffsetOption) */ export enum GeometricEffectOffsetOption { /** * Fast - ignores complex geometries and applies a best fit to the symbol. */ Fast = "Fast", /** * Accurate - accommodates complex geometries and applied a true fit to the symbol. */ Accurate = "Accurate" } /** * Represents the offset tangent geometric effect which creates a dynamic line along a line feature offset in the direction defined by either the beginning or the end of the line. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-GeometricEffectOffsetTangentMethod) */ export enum GeometricEffectOffsetTangentMethod { /** * BeginningOfLine - the tangent offset is applied from the beginning of the line. */ BeginningOfLine = "BeginningOfLine", /** * EndOfLine - the tangent offset is applied from the end of the line. */ EndOfLine = "EndOfLine" } /** * Represents the wave geometric effect which creates a dynamic line or polygon along a feature with a repeating wave pattern. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-GeometricEffectWaveform) */ export enum GeometricEffectWaveform { /** * Sinus - displays a sinusoidal curve. */ Sinus = "Sinus", /** * Square - displays a three-sided rectangular shape. */ Square = "Square", /** * Triangle - displays a two-sided triangular shape. */ Triangle = "Triangle", /** * Random - displays a sine curve with random variations in the period and amplitude */ Random = "Random" } /** * Represents the wave geometric effect which creates a dynamic line or polygon along a feature with a repeating wave pattern. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-GlyphHinting) */ export enum GlyphHinting { /** * No glyph hinting. */ None = "None", /** * Default glyph hinting according to the font's settings. */ Default = "Default", /** * Force glyph hinting. */ Force = "Force" } /** * Represents the wave geometric effect which creates a dynamic line or polygon along a feature with a repeating wave pattern. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-GradientAlignment) */ export enum GradientAlignment { /** * Buffered - Distributes the color ramp along the line's geometry from the outside in (similar to the effect of creating a buffer of the line, then using the "buffer" fill type). */ Buffered = "Buffered", /** * Left - Progresses the color ramp from the line's centerline to the outside edge on the left. The gradient will follow any curvature in the line's geometry. */ Left = "Left", /** * Right - Progresses the color ramp from the line's centerline to the outside edge on the right. The gradient will follow any curvature in the line's geometry. */ Right = "Right", /** * Along line - Distributes the color ramp linearly along the line, following the curvature of the line. */ AlongLine = "AlongLine" } /** * Represents a gradient fill which fills polygonal geometry with a specified color scheme. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-GradientFillMethod) */ export enum GradientFillMethod { /** * Linear - Change from one color to the next is linear across the geometry. */ Linear = "Linear", /** * Rectangular - Change from one color to the next is rectangular, from the extent of the geometry. */ Rectangular = "Rectangular", /** * Circular - Change from one color to the next is circular, from the extent of the geometry */ Circular = "Circular", /** * Buffered - Color changes based on an internal buffering of the geometry outline */ Buffered = "Buffered" } /** * Represents a gradient stroke which draws linear geometry with a specified color scheme. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-GradientStrokeType) */ export enum GradientStrokeType { /** * Discrete gradient types have distinct lines of separation between each color. */ Discrete = "Discrete", /** * Continuous gradients vary continuously along the color change with no distinct boundary between the colors. */ Continuous = "Continuous" } /** * Represents a hatch fill which fills polygonal geometry with a uniform series of parallel line symbols. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-HorizontalAlignment) */ export enum HorizontalAlignment { /** * Left aligned. */ Left = "Left", /** * Right aligned. */ Right = "Right", /** * Centered. */ Center = "Center", /** * Justified alignment. */ Justify = "Justify" } /** * Represents a hatch fill which fills polygonal geometry with a uniform series of parallel line symbols. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-LeaderLineStyle) */ export enum LeaderLineStyle { /** * The line callout leader is a single line originating from the closest corner of the text box with the gap applied. If the callout has an accent bar it is connected to the closest point at the either top or bottom of the accent bar. */ Base = "Base", /** * The line callout leader is a single line originating from the midpoint of the left or right side of the text box with the gap applied or from the midpoint of the accent bar if the callout has one. */ MidPoint = "MidPoint", /** * The line callout leader is a 3-point line originating from the midpoint of the left or right side of the text box with the gap applied or the midpoint of the accent bar if the callout has one. */ ThreePoint = "ThreePoint", /** * The line callout leader is a 4-point line originating from the midpoint of the left or right side of the text box with the gap applied or the midpoint of the accent bar if the callout has one. */ FourPoint = "FourPoint", /** * The line callout draws a line that connects to the closest of the four corners of the text with the gap applied. If the callout has an accent bar it is connected to the closest point at either the top or bottom of the accent bar. Additionally, either and underline or an "overline" is drawn along the closest side (bottom or top) of the text. */ Underline = "Underline", /** * The line callout leader is curved (clockwise) from the anchor point to the closest corner of the text box with the gap applied. If the callout has an accent bar it is connected to the closest point at the either top or bottom of the accent bar. */ CircularCW = "CircularCW", /** * The line callout leader is curved (counter-clockwise) from the anchor point to the closest corner of the text box with the gap applied. If the callout has an accent bar it is connected to the closest point at the either top or bottom of the accent bar. */ CircularCCW = "CircularCCW" } /** * Represents a hatch fill which fills polygonal geometry with a uniform series of parallel line symbols. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-LineCapStyle) */ export enum LineCapStyle { /** * Stroke ends in butt caps. */ Butt = "Butt", /** * Stroke ends in round caps. */ Round = "Round", /** * Stroke ends in square caps. */ Square = "Square" } /** * Represents a hatch fill which fills polygonal geometry with a uniform series of parallel line symbols. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-LineDashEnding) */ export enum LineDashEnding { /** * No Constraint - no constraint is applied to how the dash is placed. */ NoConstraint = "NoConstraint", /** * Half Pattern - a half dash will be placed on either side of control points. */ HalfPattern = "HalfPattern", /** * Half Gap - a space equal to the half the gap value will be placed on either side of control points. */ HalfGap = "HalfGap", /** * Full Pattern - a full dash will be placed on either side of control points. */ FullPattern = "FullPattern", /** * Full Gap - a space equal to the gap value will be placed on either side of control points. */ FullGap = "FullGap", /** * Custom - the pattern is fit to the length of the feature by adjusting the gaps slightly. */ Custom = "Custom" } /** * Represents a hatch fill which fills polygonal geometry with a uniform series of parallel line symbols. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-LineDecorationStyle) */ export enum LineDecorationStyle { /** * No decoration. */ None = "None", /** * The decoration is defined in the Layers property as a set of SymbolReferences. */ Custom = "Custom", /** * A circle is added at the end of the line. */ Circle = "Circle", /** * An open arrow is added to the end of the line. */ OpenArrow = "OpenArrow", /** * A closed arrow is added to the end of the line. */ ClosedArrow = "ClosedArrow", /** * A diamond is added at the end of the line. */ Diamond = "Diamond" } /** * Represents a hatch fill which fills polygonal geometry with a uniform series of parallel line symbols. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-LineGapType) */ export enum LineGapType { /** * Extra Leading - Adds the specified value to the line spacing that accommodates the largest font in the line */ ExtraLeading = "ExtraLeading", /** * Multiple - Sets the line spacing based on a multiple of the line. */ Multiple = "Multiple", /** * Exact - Sets a fixed line spacing */ Exact = "Exact" } /** * Represents a hatch fill which fills polygonal geometry with a uniform series of parallel line symbols. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-LineJoinStyle) */ export enum LineJoinStyle { /** * The stroke join is beveled. */ Bevel = "Bevel", /** * The line join is round. */ Round = "Round", /** * The line join is mitered. */ Miter = "Miter" } /** * Represents marker placement polygon center which defines how a single marker will be placed within the polygon. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-MarkerPlacementType) */ export enum MarkerPlacementType { /** * Place inside the polygon. */ InsidePolygon = "InsidePolygon", /** * Place inside the polygon at the center. */ PolygonCenter = "PolygonCenter", /** * Place randomly inside the polygon. */ RandomlyInsidePolygon = "RandomlyInsidePolygon" } /** * Represents marker placement polygon center which defines how a single marker will be placed within the polygon. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-MaterialMode) */ export enum MaterialMode { /** * Tint materials and textures with color property. */ Tint = "Tint", /** * Replace materials and textures with color property. */ Replace = "Replace", /** * Multiply materials and textures with color property. */ Multiply = "Multiply" } /** * Represents a pie chart marker which is a marker that draws numeric values arranged in a circle. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-PlacementClip) */ export enum PlacementClip { /** * Markers are clipped at the boundary of the polygon. */ ClipAtBoundary = "ClipAtBoundary", /** * Markers are not drawn if their center falls outside of the polygon. */ RemoveIfCenterOutsideBoundary = "RemoveIfCenterOutsideBoundary", /** * Markers are not drawn if they touch the boundary of the polygon. */ DoNotTouchBoundary = "DoNotTouchBoundary", /** * Markers are not clipped and may extend past the boundary of the polygon. */ DoNotClip = "DoNotClip" } /** * Represents a pie chart marker which is a marker that draws numeric values arranged in a circle. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-PlacementEndings) */ export enum PlacementEndings { /** * No constraint on how the markers are placed. */ NoConstraint = "NoConstraint", /** * A marker is placed at the control point. */ WithMarkers = "WithMarkers", /** * A space equal to the placement template will be placed at the control point. */ WithFullGap = "WithFullGap", /** * A space equal to half the placement template will be placed at the control point. */ WithHalfGap = "WithHalfGap", /** * Will fit the pattern to the length of the features by adjusting the gaps slightly. */ Custom = "Custom" } /** * Represents a pie chart marker which is a marker that draws numeric values arranged in a circle. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-PlacementGridType) */ export enum PlacementGridType { /** * Markers are placed on a uniform grid. */ Fixed = "Fixed", /** * Markers are placed randomly in the polygon. */ Random = "Random", /** * Markers are placed randomly with a fixed quantity (dot density). */ RandomFixedQuantity = "RandomFixedQuantity" } /** * Represents a pie chart marker which is a marker that draws numeric values arranged in a circle. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-PlacementOnLineRelativeTo) */ export enum PlacementOnLineRelativeTo { /** * Marker is placed in the middle of the line. */ LineMiddle = "LineMiddle", /** * Marker is placed at the beginning of the line. */ LineBeginning = "LineBeginning", /** * Marker is placed at the end of the line. */ LineEnd = "LineEnd", /** * Marker is at the midpoint of each segment in a line feature. */ SegmentMidpoint = "SegmentMidpoint" } /** * Represents a pie chart marker which is a marker that draws numeric values arranged in a circle. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-PlacementPolygonCenterMethod) */ export enum PlacementPolygonCenterMethod { /** * Place on the polygon. */ OnPolygon = "OnPolygon", /** * The centroid of the polygon is used. */ CenterOfMass = "CenterOfMass", /** * The bounding box of the polygon is used. */ BoundingBoxCenter = "BoundingBoxCenter" } /** * Represents a pie chart marker which is a marker that draws numeric values arranged in a circle. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-PlacementRandomlyAlongLineRandomization) */ export enum PlacementRandomlyAlongLineRandomization { /** * A low amount of randomness is applied */ Low = "Low", /** * A medium amount of randomness is applied */ Medium = "Medium", /** * A high amount of randomness is applied */ High = "High" } /** * Represents a pie chart marker which is a marker that draws numeric values arranged in a circle. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-PlacementStepPosition) */ export enum PlacementStepPosition { /** * The marker center. */ MarkerCenter = "MarkerCenter", /** * The marker bounds. */ MarkerBounds = "MarkerBounds" } /** * Represents a point symbol callout which draws a point symbol as the background and a line symbol for leaders. Often used for highway shields. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-PointSymbolCalloutScale) */ export enum PointSymbolCalloutScale { /** * No scaling. */ None = "None", /** * Uniform scaling. */ PropUniform = "PropUniform", /** * Non-uniform scaling. */ PropNonuniform = "PropNonuniform", /** * Uniform scaling. */ DifUniform = "DifUniform", /** * Non-uniform scaling. */ DifNonuniform = "DifNonuniform" } /** * Represents shape vertices. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-Simple3DLineStyle) */ export enum Simple3DLineStyle { /** * Stroke draws as a tube where the width determines the diameter of the tube. */ Tube = "Tube", /** * Stroke draws flat upon the surface. */ Strip = "Strip", /** * Stroke is vertically oriented where Width determines the height of the wall. */ Wall = "Wall" } /** * Represents a simple line callout for drawing basic leader lines. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-SizeVariationMethod) */ export enum SizeVariationMethod { /** * Change in size is applied randomly. */ Random = "Random", /** * Markers are drawn with a pattern where the markers increase in size. */ Increasing = "Increasing", /** * Markers are drawn in a pattern where the markers decrease in size. */ Decreasing = "Decreasing", /** * Markers are drawn in a pattern where the size increase and then decrease. */ IncreasingThenDecreasing = "IncreasingThenDecreasing" } /** * Represents a stacked bar chart marker which is a chart made of vertical stacked bars displaying values. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-SymbolUnits) */ export enum SymbolUnits { /** * Relative units. */ Relative = "Relative", /** * Absolute units. */ Absolute = "Absolute" } /** * Represents a stacked bar chart marker which is a chart made of vertical stacked bars displaying values. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-TextCase) */ export enum TextCase { /** * Text is proper/mixed case. */ Normal = "Normal", /** * Text is all lower case. */ LowerCase = "LowerCase", /** * Text is all upper case. */ Allcaps = "Allcaps" } /** * Represents a text margin which defines the margin to apply around text. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-TextReadingDirection) */ export enum TextReadingDirection { /** * Text is drawn from left-to-right. */ LTR = "LTR", /** * Text is drawn from right-to-left. */ RTL = "RTL" } /** * Represents a text symbol which is used to draw text graphics, bleeds, and annotation. Text symbols do not contain any symbol layers but can have callouts. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-TextureFilter) */ export enum TextureFilter { /** * Low draft quality. */ Draft = "Draft", /** * Higher quality, recommended for pictures. */ Picture = "Picture", /** * Higher quality, recommended when it is important to preserve edges for zoomed in images. */ Text = "Text" } /** * Represents a vector marker which can represent vector graphics. It's constructed from MarkerGraphics which are geometries and symbols used as building blocks for the marker. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-VerticalAlignment) */ export enum VerticalAlignment { /** * Top of the highest ascender in the text symbol is used to align the text. */ Top = "Top", /** * Text is centered on the geometry. */ Center = "Center", /** * Text is aligned so that the geometry lines up with the baseline of the text symbol. Descenders will go past the baseline. */ Baseline = "Baseline", /** * Bottom of the lowest descender is used to align the text. */ Bottom = "Bottom" } /** * Represents a vector marker which can represent vector graphics. It's constructed from MarkerGraphics which are geometries and symbols used as building blocks for the marker. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-VerticalGlyphOrientation) */ export enum VerticalGlyphOrientation { /** * Align right. */ Right = "Right", /** * Align upright. */ Upright = "Upright" } /** * Represents a water fill which fills polygonal geometry with animated water. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-WaterbodySize) */ export enum WaterbodySize { /** * Small water body. */ Small = "Small", /** * Medium water body. */ Medium = "Medium", /** * Large water body. */ Large = "Large" } /** * Represents a water fill which fills polygonal geometry with animated water. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumberation-WaveStrength) */ export enum WaveStrength { /** * Calm glassy water with no waves. */ Calm = "Calm", /** * Rippled water. */ Rippled = "Rippled", /** * Slightly wavy water. */ Slight = "Slight", /** * Moderately wavy water. */ Moderate = "Moderate" } /** * Relative to the ground. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMEnumerations.md#enumberation-BillboardMode) */ export enum BillboardMode { /** * Not billboarded. */ None = "None", /** * The symbol always faces toward the viewer as though spinning on a vertical signpost. Viewed from above, the symbol does not face you; you see the top of the symbol. */ SignPost = "SignPost", /** * The symbol always faces the viewer directly, regardless of view angle. */ FaceNearPlane = "FaceNearPlane" } /** * Relative to the ground. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMEnumerations.md#enumberation-DominantSizeAxis) */ export enum DominantSizeAxis { /** * Dominant on the Z axis. */ Z = "Z", /** * Dominant on the X axis. */ X = "X", /** * Dominant on the Y axis. */ Y = "Y" } /** * Relative to the ground. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMEnumerations.md#enumberation-GradientStrokeMethod) */ export enum GradientStrokeMethod { /** * A gradient across the line. */ AcrossLine = "AcrossLine", /** * A gradient along the line. */ AlongLine = "AlongLine" } /** * Relative to the ground. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMEnumerations.md#enumberation-RotationOrder) */ export enum RotationOrder { /** * Rotate in XYZ order. */ XYZ = "XYZ", /** * Rotate in ZYX order. */ ZXY = "ZXY", /** * Rotate in YXZ order. */ YXZ = "YXZ" } /** * Represents the properties required for authoring an Arcade expression. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMRenderers.md#CIMExpressionInfo) */ export interface CIMExpressionInfo { type: "CIMExpressionInfo"; /** * The human readable text that describes the expression. */ title?: string; /** * The Arcade expression used to evaluate and return the value that a property expects. */ expression?: string; /** * The Name of the expression. */ name?: string; /** * The ReturnType of the expression. */ returnType?: keyof typeof ExpressionReturnType; } /** * Represents a primitive override. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMRenderers.md#CIMPrimitiveOverride) */ export interface CIMPrimitiveOverride { type: "CIMPrimitiveOverride"; /** * The primitive name this override applies to. */ primitiveName?: string; /** * The property name in the primitive this override applies to. */ propertyName?: string; /** * The expression. */ expression?: string; /** * ExpressionInfo that contains the Arcade expression that returns value as a number or a string depending on the PropertyName. */ valueExpressionInfo?: CIMExpressionInfo; } /** * Represents the scale dependent size variations for a symbol reference. Applies to point symbols, line symbols and the outline of polygon symbols. When the symbol reference is rendered at an intermediate scale a linearly scaled size is used. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMRenderers.md#CIMScaleDependentSizeVariation) */ export interface CIMScaleDependentSizeVariation { type: "CIMScaleDependentSizeVariation"; /** * The scale the size is associated with. */ scale?: number; /** * The size for the associated scale. */ size?: number; } /** * Represents a symbol reference. Symbol references currently store the symbol in-line in the symbol property. Overrides here are used primarily by renderers to pass overrides through the drawing pipeline. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMRenderers.md#CIMSymbolReference) */ export interface CIMSymbolReference { type: "CIMSymbolReference"; /** * The primitive overrides. Typically set by renderers at draw time. */ primitiveOverrides?: CIMPrimitiveOverride[]; /** * The style path. Reserved for future use. */ stylePath?: string; /** * The symbol. */ symbol?: CIMSymbolType; /** * The symbol name. */ symbolName?: string; /** * The minimum scale range the symbol reference should be displayed at. */ minScale?: number; /** * The maximum scale range the symbol reference should be displayed at. */ maxScale?: number; /** * An array of scale dependent sizes. */ scaleDependentSizeVariation?: CIMScaleDependentSizeVariation[]; /** * The minimum distance at which symbols are visible. Objects closer than this don't get rendered. */ minDistance?: number; /** * The maximum distance at which symbols are visible. Objects beyond this point don't get rendered. */ maxDistance?: number; } /** * Represents 3D symbol properties, a collection of symbol properties that apply when the symbol is used in a 3D context. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIM3DSymbolProperties) */ export interface CIM3DSymbolProperties { type: "CIM3DSymbolProperties"; /** * The dominant size axis. */ dominantSizeAxis3D?: keyof typeof DominantSizeAxis; /** * The rotation order 3D. */ rotationOrder3D?: keyof typeof RotationOrder; /** * The scale Z. */ scaleZ?: number; /** * The scale Y. */ scaleY?: number; } /** * CIMCalloutBase * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMCallout) */ export interface CIMCalloutBase { type: string; /** * The leader tolerance which is the closest distance (in points) to the text the anchor point can be for the callout to draw. */ leaderTolerance?: number; /** * The leader offset which is an offset value defining the distance (in points) between the anchor point and the beginning of the drawn leader. */ leaderOffset?: number; } /** * CIMLineCallout * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMLineCallout) */ export interface CIMLineCallout extends CIMCalloutBase { /** * The line symbol to draw leaders with. */ leaderLineSymbol?: CIMLineSymbol; /** * The gap (in points) between the point symbol and the beginning of the leader line. */ gap?: number; /** * The style of line to generate when a Point leader is drawn defined by an enumeration value. Line leaders will always be drawn with their own geometry. */ lineStyle?: keyof typeof LeaderLineStyle; } /** * CIMSymbolLayerBase * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMSymbolLayer) */ export interface CIMSymbolLayerBase { type: string; /** * Whether the geometric effects that are applied to the symbol layer. Effects dynamically alter the feature geometry when the symbology is applied. Multiple effects applied to a symbol layer are rendered sequentially. */ effects?: CIMGeometricEffectType[]; /** * A value indicating whether the symbol layer is visible. The symbol layer draws only when enabled. Currently, an invisible layer is not considered in any transformations when in a 3D context. */ enable?: boolean; /** * The internal name of the symbol layer used for symbol level drawing. */ name?: string; /** * A value indicating whether the color set at the basic properties level is applied to the symbol layer. If the symbol layer is color locked then changes made to the color in the basic properties will not be applied to the symbol layer. */ colorLocked?: boolean; /** * The primitive name. */ primitiveName?: string; /** * A value indicating whether or not the symbol layer should overprint in press printing. */ overprint?: boolean; } /** * CIMMarker * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMMarker) */ export interface CIMMarker extends CIMSymbolLayerBase { /** * The specified location where all transformation property operations originate. */ anchorPoint?: ExternalReferencePoint; /** * A value which specifies if the anchor point location is considered a percentage of the size or as an absolute distance. */ anchorPointUnits?: keyof typeof SymbolUnits; /** * The angle the marker is rotated around the X axis. This type of rotation is also referred to as tilt and is only applied in 3D. The order of how this is applied with respect to other rotations depends on the RotationOrder3D. The name in the user interface is Tilt. */ angleX?: number; /** * The angle the marker is rotated around the Y axis. This type of rotation is also referred to as roll and is only applied in 3D. The order of how this is applied with respect to other rotations depends on the RotationOrder3D. The name in the user interface is Roll. */ angleY?: number; /** * Which axis is considered as the Size in 3D. Only applicable when the marker layer is a 3DShapeMarker. */ dominantSizeAxis3D?: keyof typeof DominantSizeAxis; /** * The value the marker is moved along the X axis from the anchor point. This is applied after all rotation, as opposed to anchor point which is applied before the rotation. */ offsetX?: number; /** * The value the marker is moved along the Y axis from the anchor point. This is applied after all rotation, as opposed to anchor point which is applied before the rotation. */ offsetY?: number; /** * The value the marker is moved along the Z axis from the anchor point. This is applied after all rotation, as opposed to anchor point which is applied before the rotation. */ offsetZ?: number; /** * A value indicating whether the rotation is applied clockwise or counterclockwise to the marker layer. */ rotateClockwise?: boolean; /** * The angle that the marker is rotated around the anchor point, in degrees. */ rotation?: number; /** * The height of the marker. Modifying Size changes the marker's height to the specified size and the width is updated proportionally. */ size?: number; /** * The billboard mode of the marker. */ billboardMode3D?: keyof typeof BillboardMode; /** * Marker placements which determine how markers are placed along a line or within a polygon. */ markerPlacement?: CIMMarkerPlacementType; } /** * Represents a CGA attribute, the symbol attribute as specified by the CGA code in the rule package. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMCGAAttribute) */ export interface CIMCGAAttribute { type: "CIMCGAAttribute"; /** * The name. */ name?: string; /** * The CGA attribute type. */ CGAAttributeType?: keyof typeof CGAAttributeType; /** * The value. */ value?: any; } /** * Represents a character marker. The shape of a marker is defined by a glyph in a font. The marker is drawn using the specified size and color. Each marker has a defined frame around the glyph that is considered when the size is applied. As a result, character markers of the same size may appear different sizes if the glyphs frames are different sizes. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMCharacterMarker) */ export interface CIMCharacterMarker extends CIMMarker { type: "CIMCharacterMarker"; /** * The Unicode decimal value for the individual glyph of the font that defines the shape of the marker. */ characterIndex?: number; /** * The depth of the marker when drawn in 3D. */ depth3D?: number; /** * The font family name of the font. e.g. Comic Sans. */ fontFamilyName?: string; /** * The style name for the font family. e.g. Regular, Bold, or Italic. */ fontStyleName?: string; /** * The font type. */ fontType?: keyof typeof FontType; /** * The width of the symbol without changing the height (or depth in 3D), as a ratio. */ scaleX?: number; /** * The polygon symbol that is used to renderer the marker. */ symbol?: CIMPolygonSymbol; /** * A value indicating whether the marker stands a marker upright as though locked in place. The marker can be viewed from all angles. */ verticalOrientation3D?: boolean; /** * A value indicating whether the strokes and/or fills of a marker are scaled proportionally when the symbol size is changed. When enabled, the strokes for the outline or fill of the polygon symbol used to draw the marker will be scaled proportionally with changes to the symbol size. If this property is not enabled, the stroke will draw with the specified width regardless of the marker size. */ scaleSymbolsProportionally?: boolean; /** * A value indicating whether the frame of the character marker should be honored when transforming the marker. */ respectFrame?: boolean; } /** * Represents a vector marker clipping path. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMClippingPath) */ export interface CIMClippingPath { type: "CIMClippingPath"; /** * The clipping type. */ clippingType?: keyof typeof ClippingType; /** * The clipping path. */ path?: ExternalReferencePolygon; } /** * Represents color substitution, an ordered list of color substitutes. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMColorSubstitution) */ export interface CIMColorSubstitution { type: "CIMColorSubstitution"; /** * The old color (the color that will be substituted). */ oldColor?: number[]; /** * The new color that will replace the old color. */ newColor?: number[]; } /** * CIMGeometricEffectBase * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGeometricEffect) */ export interface CIMGeometricEffectBase { type: string; /** * The primitive name. */ primitiveName?: string; } /** * Represents the add control points geometric effect. Dynamically adds geometry control points to a feature to dictate the placement of markers or other effect properties that leverage control points. Control points are placed at angles or deflection based on the AngleTolerance value. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGeometricEffectAddControlPoints) */ export interface CIMGeometricEffectAddControlPoints extends CIMGeometricEffectBase { type: "CIMGeometricEffectAddControlPoints"; /** * The value below which a control point will be placed. The maximum amount of deflection from one segment to another at a vertex. Angle values between 180 and 360 are interpreted the same as values between 0 and 180. Angle values of 180 and 360 are the same as 0. */ angleTolerance?: number; } /** * Represents the arrow geometric effect which creates a dynamic line along a line feature with an arrow of a specified arrow type and width. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGeometricEffectArrow) */ export interface CIMGeometricEffectArrow extends CIMGeometricEffectBase { type: "CIMGeometricEffectArrow"; /** * The type of arrow to be displayed. */ geometricEffectArrowType?: keyof typeof GeometricEffectArrowType; /** * The distance between the lines that construct the body of the arrow. */ width?: number; } /** * Represents the buffer geometric effect which creates a dynamic polygon with a specified distance around features. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGeometricEffectBuffer) */ export interface CIMGeometricEffectBuffer extends CIMGeometricEffectBase { type: "CIMGeometricEffectBuffer"; /** * The distance from the feature. This distance is either from the edge of the marker, the edge of the stroke or the edge of the polygon outline. */ size?: number; } /** * Represents the cut geometric effect which creates a dynamic line that is shorter on one or both ends than the line feature or polygon outline. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGeometricEffectCut) */ export interface CIMGeometricEffectCut extends CIMGeometricEffectBase { type: "CIMGeometricEffectCut"; /** * The distance from the beginning of a line that the display of the stroke starts. The beginning of the line is determined by the direction in which the line was digitized. */ beginCut?: number; /** * The distance from the end of a line that the display of the stroke ends. The end of the line is determined by the direction in which the line was digitized. */ endCut?: number; /** * The distance around the middle of a line that the display of the stroke is interrupted. */ middleCut?: number; /** * A value indicating whether the effect should be applied in the opposite manner. This displays the stroke symbol only at the ends of the line and leaves the rest of the line unsymbolized. */ invert?: boolean; } /** * Represents the dashes geometric effect which creates a dynamic multipart line geometry from a line feature or the outline of a polygon based on a template. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGeometricEffectDashes) */ export interface CIMGeometricEffectDashes extends CIMGeometricEffectBase { type: "CIMGeometricEffectDashes"; /** * Where the pattern should end relative to the ending point of the geometry. Negative numbers indicate a shift to the left and positive numbers a shift to the right. This property is only applied if the LineDashEnding is set to Custom. */ customEndingOffset?: number; /** * The distance for each dash and gap. There can be multiple dash and gap values to form a complex pattern. */ dashTemplate?: number[]; /** * The setting which determines how the strokes with dash patterns and other patterns (pictures, placement effects) are handled at the end points of the line geometry's segments. */ lineDashEnding?: keyof typeof LineDashEnding; /** * The position where the pattern should begin relative to the starting point of the geometry. It shifts the entire pattern along the line the specified distance. Negative values indicate a shift to the left and positive numbers a shift to the right. This property is only applied if LineDashEnding is set to NoConstraint or Custom. */ offsetAlongLine?: number; /** * The line dash ending position. */ controlPointEnding?: keyof typeof LineDashEnding; } /** * Represents the donut geometric effect which creates a dynamic polygon ring of a specified width in relation to the outline of polygon features. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGeometricEffectDonut) */ export interface CIMGeometricEffectDonut extends CIMGeometricEffectBase { type: "CIMGeometricEffectDonut"; /** * The method which specifies the way the strokes are displayed at convex corners of the polygon. */ method?: keyof typeof GeometricEffectDonutMethod; /** * The option for the way the symbol handles complex geometries. */ option?: keyof typeof GeometricEffectOffsetOption; /** * The distance from the edge of the polygon that the fill symbol is to be displayed. */ width?: number; } /** * Represents the enclosing polygon geometric effect which creates a dynamic polygon from the spatial extent of a line or polygon feature. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGeometricEffectEnclosingPolygon) */ export interface CIMGeometricEffectEnclosingPolygon extends CIMGeometricEffectBase { type: "CIMGeometricEffectEnclosingPolygon"; /** * The method which specifies the way in which the polygon geometry is generated around the feature geometry. */ method?: keyof typeof GeometricEffectEnclosingPolygonMethod; } /** * Represents the extension geometric effect which creates a dynamic line that is extended from either the beginning or the end of the line feature at a specified deflection angle and length. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGeometricEffectExtension) */ export interface CIMGeometricEffectExtension extends CIMGeometricEffectBase { type: "CIMGeometricEffectExtension"; /** * The deflection angle used for the extension. A value of 0 indicates no deflection. */ deflection?: number; /** * The origin of the extension to add to the line. The beginning and end of the line is defined by the direction the line was digitized. */ origin?: keyof typeof GeometricEffectExtensionOrigin; /** * The length of the extension that is dynamically created. */ length?: number; } /** * Represents the jog geometric effect which creates a dynamic line with a jog of a specified angle, position, and width in the line. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGeometricEffectJog) */ export interface CIMGeometricEffectJog extends CIMGeometricEffectBase { type: "CIMGeometricEffectJog"; /** * The angle of the jog in the line which is measured in degrees. */ angle?: number; /** * The length of the segment that forms the jog in the line. */ length?: number; /** * The location of the center of the jog, as a percentage measured from the start of the input geometry. */ position?: number; } /** * Represents a geometric effect which creates a localizer feather for aeronautical charts. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGeometricEffectLocalizerFeather) */ export interface CIMGeometricEffectLocalizerFeather extends CIMGeometricEffectBase { type: "CIMGeometricEffectLocalizerFeather"; /** * The localizer feather style. */ style?: keyof typeof GeometricEffectLocalizerFeatherStyle; /** * The length of the localizer feather. */ length?: number; /** * The width of the localizer feather. */ width?: number; /** * The angle of the localizer feather. */ angle?: number; } /** * Represents the move geometric effect which creates a point, line or polygon that is offset a specified distance in X and Y. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGeometricEffectMove) */ export interface CIMGeometricEffectMove extends CIMGeometricEffectBase { type: "CIMGeometricEffectMove"; /** * The distance to move the symbol along the X-axis of the feature geometry. */ offsetX?: number; /** * The distance to move the symbol along the Y-axis of the feature geometry. */ offsetY?: number; } /** * Represents the offset geometric effect which creates a dynamic line or polygon offset at a specified distance perpendicularly from a feature. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGeometricEffectOffset) */ export interface CIMGeometricEffectOffset extends CIMGeometricEffectBase { type: "CIMGeometricEffectOffset"; /** * The way the strokes or fills are displayed at corners. */ method?: keyof typeof GeometricEffectOffsetMethod; /** * The distance of the symbol perpendicular to the feature geometry. */ offset?: number; /** * The way the symbol handles complex geometries. */ option?: keyof typeof GeometricEffectOffsetOption; } /** * Represents a geometric effect which creates a hatch pattern to depict special use airspace for aeronautical charts. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGeometricEffectOffsetHatch) */ export interface CIMGeometricEffectOffsetHatch extends CIMGeometricEffectBase { type: "CIMGeometricEffectOffsetHatch"; /** * The length of the offset hatch. */ length?: number; /** * The spacing of the offset hatch. */ spacing?: number; } /** * Represents the offset tangent geometric effect which creates a dynamic line along a line feature offset in the direction defined by either the beginning or the end of the line. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGeometricEffectOffsetTangent) */ export interface CIMGeometricEffectOffsetTangent extends CIMGeometricEffectBase { type: "CIMGeometricEffectOffsetTangent"; /** * The origin of the tangent offset for the line. The beginning and end of the lines are defined by how the line was digitized. */ method?: keyof typeof GeometricEffectOffsetTangentMethod; /** * The distance the geometry is moved tangent. */ offset?: number; } /** * Represents the radial geometric effect which creates a dynamic line of a specified length and angle originating from a point feature. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGeometricEffectRadial) */ export interface CIMGeometricEffectRadial extends CIMGeometricEffectBase { type: "CIMGeometricEffectRadial"; /** * The orientation of the line from the marker. The angle is calculated in a counterclockwise manner with 0 degrees equal to due east. */ angle?: number; /** * The distance of the line from end to end. */ length?: number; } /** * Represents the regular polygon geometric effect which creates a dynamic polygon around a point feature with a specified number of edges. All edges are equal in length and all angles are equal. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGeometricEffectRegularPolygon) */ export interface CIMGeometricEffectRegularPolygon extends CIMGeometricEffectBase { type: "CIMGeometricEffectRegularPolygon"; /** * The amount of rotation for the polygon. */ angle?: number; /** * The number of sides for the polygon. Specifying a value less than 3 produces a circle. */ edges?: number; /** * The distance from the center of the polygon. */ radius?: number; } /** * Represents the reverse geometric effect which creates a dynamic polygon around a point feature with a specified number of edges. All edges are equal in length and all angles are equal. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGeometricEffectReverse) */ export interface CIMGeometricEffectReverse extends CIMGeometricEffectBase { type: "CIMGeometricEffectReverse"; /** * A value indicating whether the dynamic output of a previous geometric effect is to be flipped or not. */ reverse?: boolean; } /** * Represents the rotate geometric effect which creates a dynamic line or polygon rotated a specified angle from the feature. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGeometricEffectRotate) */ export interface CIMGeometricEffectRotate extends CIMGeometricEffectBase { type: "CIMGeometricEffectRotate"; /** * The amount of rotation for the symbol. */ angle?: number; } /** * Represents the rotate geometric effect which creates a dynamic line or polygon scaled by a specified factor. Vertices are moved in relation to the center point of a feature envelope. Values greater than 1 move vertices away from the center point. Values between 0 and 1 move vertices toward the center point. Values less than 0 draw an inverse dynamic line or polygon where the vertices have crossed to the other side of the center point. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGeometricEffectScale) */ export interface CIMGeometricEffectScale extends CIMGeometricEffectBase { type: "CIMGeometricEffectScale"; /** * The amount of change in size of a symbol in the x-axis. The value is expressed in terms of a ratio/percentage. */ XScaleFactor?: number; /** * The amount of change in size of a symbol in the y-axis. The value is expressed in terms of a ratio/percentage. */ YScaleFactor?: number; } /** * Represents the suppress geometric effect which creates a dynamic line that hides sections of a stroke between pairs control points. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGeometricEffectSuppress) */ export interface CIMGeometricEffectSuppress extends CIMGeometricEffectBase { type: "CIMGeometricEffectSuppress"; /** * A value indicating whether the portion of the stroke symbol between control points should be suppressed. Sections that are suppressed draw with no symbol. */ suppress?: boolean; /** * A value indicating whether to invert the suppression process. If this value is true, portions of the stroke symbol between control points are kept and all other portions are suppressed. */ invert?: boolean; } /** * Represents the tapered polygon geometric effect which creates a dynamic polygon along a line feature, whose width varies by two specified amounts along its length, as defined by a percentage of the line feature's length. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGeometricEffectTaperedPolygon) */ export interface CIMGeometricEffectTaperedPolygon extends CIMGeometricEffectBase { type: "CIMGeometricEffectTaperedPolygon"; /** * The width at the start of the line to be used to generate a polygon. */ fromWidth?: number; /** * The distance along the line to be used to generate the polygon. */ length?: number; /** * The width at the end of the line to be used to generate the polygon. */ toWidth?: number; } /** * Represents the wave geometric effect which creates a dynamic line or polygon along a feature with a repeating wave pattern. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGeometricEffectWave) */ export interface CIMGeometricEffectWave extends CIMGeometricEffectBase { type: "CIMGeometricEffectWave"; /** * The distance perpendicular to a feature to display the curves for the symbol. */ amplitude?: number; /** * The distance along the line or polygon to display the curves for the symbol. */ period?: number; /** * The staring value for generating a random number. This is only used when the Waveform is set to Random. */ seed?: number; /** * The shape of the curves to be displayed along the symbol. */ waveform?: keyof typeof GeometricEffectWaveform; } /** * CIMFill * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMFill) */ export interface CIMFill extends CIMSymbolLayerBase { } /** * Represents a gradient fill which fills polygonal geometry with a specified color scheme. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGradientFill) */ export interface CIMGradientFill extends CIMFill { type: "CIMGradientFill"; /** * The angle of the gradient when the GradientMethod is set to Linear or Rectangular. */ angle?: number; /** * The color scheme that is applied to the fill. */ colorRamp?: any; /** * A value which specifies how the gradient is applied within the fill. */ gradientMethod?: keyof typeof GradientFillMethod; /** * A value which determines how much of the feature is covered by the color scheme. This is either a percentage of the total area which the color scheme spans or the number of page units from the starting point at which the gradient displays. */ gradientSize?: number; /** * A value which specifies whether GradientSize is applied with an absolute distance or a relative percentage. */ gradientSizeUnits?: keyof typeof SymbolUnits; /** * A value which specifies if the gradient is applied with discrete intervals or if it is continuous. */ gradientType?: keyof typeof GradientStrokeType; /** * How many bands draw when the GradientType is set to Discrete. */ interval?: number; } /** * CIMStroke * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMStroke) */ export interface CIMStroke extends CIMSymbolLayerBase { /** * How the stroke should draw at the ends of the geometries. */ capStyle?: keyof typeof LineCapStyle; /** * How the symbol is drawn at the stroke segment connections. */ joinStyle?: keyof typeof LineJoinStyle; /** * How strokes will be rendered in 3D. */ lineStyle3D?: keyof typeof Simple3DLineStyle; /** * The maximum 'sharpness' that is allowed for Miter joins. If the spike created by the miter join exceeds the miter limit times the width of the stroke, the sharp angle will be clipped and rendered with a bevel join. This property is only applied to the symbol layer when the JoinType is set to Miter. */ miterLimit?: number; /** * The width of the stroke. */ width?: number; /** * A value indicating whether to close caps when drawing them in 3D. When set to false, the caps are hollow. */ closeCaps3D?: boolean; } /** * Represents a gradient stroke which draws linear geometry with a specified color scheme. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMGradientStroke) */ export interface CIMGradientStroke extends CIMStroke { type: "CIMGradientStroke"; /** * The color scheme that is applied to the stroke. */ colorRamp?: any; /** * How the gradient is applied along the stroke. */ gradientMethod?: keyof typeof GradientStrokeMethod; /** * How much of the feature is covered by the color scheme. This is either a percentage of the total area which the color scheme spans or the number of page units from the starting point at which the gradient displays. */ gradientSize?: number; /** * Whether GradientSize is applied with an absolute distance or a relative percentage. */ gradientSizeUnits?: keyof typeof SymbolUnits; /** * Whether the gradient is applied with discrete or continuous intervals. */ gradientType?: keyof typeof GradientStrokeType; /** * How many bands draw when the GradientType is set to Discrete. */ interval?: number; } /** * Represents a hatch fill which fills polygonal geometry with a uniform series of parallel line symbols. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMHatchFill) */ export interface CIMHatchFill extends CIMFill { type: "CIMHatchFill"; /** * The line symbol that is used to draw the hatch lines in the fill. */ lineSymbol?: CIMLineSymbol; /** * How much to move the stroke to a new X-position. */ offsetX?: number; /** * The angle of rotation for all the strokes, in degrees. */ rotation?: number; /** * The distance between the line symbols in the hatch pattern. */ separation?: number; /** * How much to move the stroke to a new Y-position. */ offsetY?: number; } /** * CIMSymbolBase * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMSymbol) */ export interface CIMSymbolBase { type: string; } /** * CIMMultiLayerSymbol * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMMultiLayerSymbol) */ export interface CIMMultiLayerSymbol extends CIMSymbolBase { /** * The geometric effects that are applied to the symbol. */ effects?: CIMGeometricEffectType[]; /** * The symbol layers. Symbol layers are the components that make up a symbol. A symbol layer is represented by a stroke, fill, marker, or procedural symbol layer. */ symbolLayers?: CIMSymbolLayerType[]; /** * The representative image of the symbol. */ thumbnailURI?: string; /** * A value indicating whether the symbol size properties are rendered using real world units or page units. When set to true the symbol will draw using real world units (e.g. meters). */ useRealWorldSymbolSizes?: boolean; } /** * Represents a line symbol which is used to draw polyline features or graphics. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMLineSymbol) */ export interface CIMLineSymbol extends CIMMultiLayerSymbol { type: "CIMLineSymbol"; } /** * Represents a marker graphic which is used to define vector graphics in a vector marker. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMMarkerGraphic) */ export interface CIMMarkerGraphic { type: "CIMMarkerGraphic"; /** * The geometry of the marker. */ geometry?: ExternalReferenceGeometry; /** * The symbol used to draw the marker graphic, can be a point, line, polygon, or text symbol. */ symbol?: CIMSymbolType; /** * The text that is defined within the marker if drawn with a text symbol. */ textString?: string; /** * The primitive name. */ primitiveName?: string; } /** * CIMMarkerPlacementBase * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMMarkerPlacement) */ export interface CIMMarkerPlacementBase { type: string; /** * The primitive name. */ primitiveName?: string; } /** * CIMMarkerStrokePlacement * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMMarkerStrokePlacement) */ export interface CIMMarkerStrokePlacement extends CIMMarkerPlacementBase { /** * A value indicating whether to angle the marker to the line. */ angleToLine?: boolean; /** * The offset. */ offset?: number; } /** * CIMMarkerPlacementAlongLine * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMMarkerPlacementAlongLine) */ export interface CIMMarkerPlacementAlongLine extends CIMMarkerStrokePlacement { /** * How markers are placed at control points. */ controlPointPlacement?: keyof typeof PlacementEndings; /** * Where the pattern should end relative to the ending point of the geometry. The entire pattern is shifted along the line for the specified distance. Negative numbers shift to the left and positive numbers shift to the right. This is only applied if the Endings property is set to Custom. */ customEndingOffset?: number; /** * How markers are placed at the end points of a line. */ endings?: keyof typeof PlacementEndings; /** * Where the pattern should begin relative to the starting point of the geometry. The entire pattern is shifted along the line for the specified distance. Negative numbers shift to the left and positive numbers shift to the right. This is only applied if the Endings property is set to No Constraint or Custom. */ offsetAlongLine?: number; /** * The numeric pattern that defines the sequence of placed markers and the length of space between them. */ placementTemplate?: number[]; } /** * Represents marker placement along the line which places randomly sized markers evenly along a line or polygon outline. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMMarkerPlacementAlongLineRandomSize) */ export interface CIMMarkerPlacementAlongLineRandomSize extends CIMMarkerPlacementAlongLine { type: "CIMMarkerPlacementAlongLineRandomSize"; /** * The amount of randomness to be used for the size and rotation of the markers on the line. The size and rotation of the marker will vary for individual markers. */ randomization?: keyof typeof PlacementRandomlyAlongLineRandomization; /** * The starting value for generating a random number. This random number is used by the Randomization property to determine the marker shape. */ seed?: number; } /** * Represents marker placement along the line which places markers that are the same size evenly along a line or polygon outline. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMMarkerPlacementAlongLineSameSize) */ export interface CIMMarkerPlacementAlongLineSameSize extends CIMMarkerPlacementAlongLine { type: "CIMMarkerPlacementAlongLineSameSize"; } /** * Represents marker placement along the line which places markers in either increasing, decreasing or alternating gradations along a line or polygon outline. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMMarkerPlacementAlongLineVariableSize) */ export interface CIMMarkerPlacementAlongLineVariableSize extends CIMMarkerPlacementAlongLine { type: "CIMMarkerPlacementAlongLineVariableSize"; /** * The maximum random offset. */ maxRandomOffset?: number; /** * The largest size of the marker to be placed on the line. The value is expressed as a ratio. */ maxZoom?: number; /** * The smallest size of the marker to be placed on the line. The value is expressed as a ratio. */ minZoom?: number; /** * The number of different sizes of markers to be placed on the line. */ numberOfSizes?: number; /** * The starting value for generating a random number. This random number is used by the Randomization property to determine which size a marker will receive. This is only used if the VariationMethod is set to Random. */ seed?: number; /** * The order in which the change of size in the markers should occur. */ variationMethod?: keyof typeof SizeVariationMethod; } /** * Represents marker placement at extremities which places markers at only one or both endpoints of a line. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMMarkerPlacementAtExtremities) */ export interface CIMMarkerPlacementAtExtremities extends CIMMarkerStrokePlacement { type: "CIMMarkerPlacementAtExtremities"; /** * Which ends of the line a marker will be placed. */ extremityPlacement?: keyof typeof ExtremityPlacement; /** * The distance from the ends of a line that the marker will be placed. */ offsetAlongLine?: number; } /** * Represents marker placement at geometry M values. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMMarkerPlacementAtMeasuredUnits) */ export interface CIMMarkerPlacementAtMeasuredUnits extends CIMMarkerStrokePlacement { type: "CIMMarkerPlacementAtMeasuredUnits"; /** * The interval of measured units used to place markers. */ interval?: number; /** * The rate of markers to skip. */ skipMarkerRate?: number; /** * A value indicating whether markers should be placed at extremities. */ placeAtExtremities?: boolean; } /** * Represents marker placement at ratio positions which places a set number of markers along the line or the outline of a polygon. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMMarkerPlacementAtRatioPositions) */ export interface CIMMarkerPlacementAtRatioPositions extends CIMMarkerStrokePlacement { type: "CIMMarkerPlacementAtRatioPositions"; /** * The distance from the beginning of a line that the marker will be placed. */ beginPosition?: number; /** * The distance from the end of a line that the marker will be placed. The ending of a line is determined by the direction in which the line was digitized. */ endPosition?: number; /** * A value indicating whether only the first marker will be rotated 180 degrees. */ flipFirst?: boolean; /** * The array of positions. */ positionArray?: number[]; } /** * CIMMarkerFillPlacement * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMMarkerFillPlacement) */ export interface CIMMarkerFillPlacement extends CIMMarkerPlacementBase { } /** * Represents marker placement inside a polygon which defines how a polygon is filled with a pattern of markers. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMMarkerPlacementInsidePolygon) */ export interface CIMMarkerPlacementInsidePolygon extends CIMMarkerFillPlacement { type: "CIMMarkerPlacementInsidePolygon"; /** * The orientation angle that the markers are placed on within the polygon. */ gridAngle?: number; /** * The grid type which defines how markers are placed. */ gridType?: keyof typeof PlacementGridType; /** * The marker row offset horizontally. */ offsetX?: number; /** * The randomness of the pattern when markers are placed randomly in a polygon. */ randomness?: number; /** * The starting value for generating a random pattern. */ seed?: number; /** * A value indicating whether every other row of markers should be shifted to create an offset grid. */ shiftOddRows?: boolean; /** * The distance between each marker on the X-axis of the grid. */ stepX?: number; /** * The distance between each marker on the Y-axis of the grid. */ stepY?: number; /** * The marker row offset vertically. */ offsetY?: number; /** * The clipping option which specifies how markers should be clipped at the polygon boundary. */ clipping?: keyof typeof PlacementClip; } /** * Represents a marker placement on the line. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMMarkerPlacementOnLine) */ export interface CIMMarkerPlacementOnLine extends CIMMarkerStrokePlacement { type: "CIMMarkerPlacementOnLine"; /** * The location on a line where a marker will be placed. The direction of the line is determined by the direction in which the line was digitized. */ relativeTo?: keyof typeof PlacementOnLineRelativeTo; /** * The distances from a specified location on a line that a marker will be placed. */ startPointOffset?: number; } /** * Represents a marker placement on vertices which places a single marker on a line or polygon outline at a set distance from the middle or one of the endpoints. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMMarkerPlacementOnVertices) */ export interface CIMMarkerPlacementOnVertices extends CIMMarkerStrokePlacement { type: "CIMMarkerPlacementOnVertices"; /** * A value indicating whether a marker will be placed on the control points of the line. */ placeOnControlPoints?: boolean; /** * A value indicating whether a marker will be placed on the endpoints of the line. */ placeOnEndPoints?: boolean; /** * A value indicating whether a marker will be placed on the vertices of the line. */ placeOnRegularVertices?: boolean; } /** * Represents marker placement polygon center which defines how a single marker will be placed within the polygon. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMMarkerPlacementPolygonCenter) */ export interface CIMMarkerPlacementPolygonCenter extends CIMMarkerFillPlacement { type: "CIMMarkerPlacementPolygonCenter"; /** * The method used to determine the polygon center. */ method?: keyof typeof PlacementPolygonCenterMethod; /** * The value which offsets the marker horizontally from the center. */ offsetX?: number; /** * The value which offsets the marker vertically from the center. */ offsetY?: number; /** * A value indicating whether the marker should be clipped if it extends pasts the boundary of the polygon. */ clipAtBoundary?: boolean; } /** * Represents material properties. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMMaterialProperties) */ export interface CIMMaterialProperties { type: "CIMMaterialProperties"; /** * The specular color. */ specularColor?: number[]; /** * The shininess. */ shininess?: number; /** * How this material combines with externally defined colors. */ externalColorMixMode?: keyof typeof ExternalColorMixMode; } /** * Represents a material which defines how the multipatch or mesh is drawn. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMMaterialSymbolLayer) */ export interface CIMMaterialSymbolLayer extends CIMSymbolLayerBase { type: "CIMMaterialSymbolLayer"; /** * The material color. */ color?: number[]; /** * The mode in which the material is applied. */ materialMode?: keyof typeof MaterialMode; } /** * Represents a marker symbol for 3D objects. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMObjectMarker3D) */ export interface CIMObjectMarker3D extends CIMMarker { type: "CIMObjectMarker3D"; /** * The URI of the binary reference containing the "web resource". */ modelURI?: string; /** * The marker width. */ width?: number; /** * The marker depth. */ depth?: number; /** * The color which defines the color that is applied to the marker. */ tintColor?: number[]; /** * A value indicating whether the model can be exported. */ isRestricted?: boolean; /** * The representative image of the marker. */ thumbnail?: string; /** * A value indicating whether or not to ignore the marker anchor point and insert the model directly at the data point. */ useAnchorPoint?: boolean; /** * The array of levels of detail. */ LODs?: CIMObjectMarker3DLOD[]; } /** * Represents a level of detail of an object marker 3D. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMObjectMarker3DLOD) */ export interface CIMObjectMarker3DLOD { type: "CIMObjectMarker3DLOD"; /** * The total number of triangles in the geometry of this level of detail. */ faceCount?: number; /** * The URI of the binary reference containing the "web resource" for this level of detail. */ modelURI?: string; } /** * Represents a picture fill which fills polygonal geometry with a picture. Supported file types are .bmp, .jpg, .png, and .gif. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMPictureFill) */ export interface CIMPictureFill extends CIMFill { type: "CIMPictureFill"; /** * The URL of the image. Typically a base64 encoded image. */ url?: string; /** * The distance that the image is offset in the horizontal direction. */ offsetX?: number; /** * The distance that the image is offset in the vertical direction. */ offsetY?: number; /** * Angle of the image within the fill. */ rotation?: number; /** * The width of the symbol without changing the height (or depth in 3D), as a ratio. */ scaleX?: number; /** * The height of the image. */ height?: number; /** * How the image is resampled. */ textureFilter?: keyof typeof TextureFilter; /** * The color substitutions which allows colors in the image to be substituted with a different color. */ colorSubstitutions?: CIMColorSubstitution[]; /** * The color that is applied as a tint to the image. The color is applied to the whole image. When the tint is set to white the image appears with its native colors. */ tintColor?: number[]; } /** * Represents a picture marker created from a raster (bitmapped) image file. The image can have color substitutions to replace one or more colors in the image or it can have a tint applied to the whole image depending on the picture type. Supported formats are .bmp, .jpg, .png, and .gif. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMPictureMarker) */ export interface CIMPictureMarker extends CIMMarker { type: "CIMPictureMarker"; /** * The color substitutions for the picture. */ colorSubstitutions?: CIMColorSubstitution[]; /** * The depth of the image when drawn in 3D. */ depth3D?: number; /** * A value indicating whether the image is right-reading when viewed from behind. */ invertBackfaceTexture?: boolean; /** * The scale X which changes the width of the symbol without changing the height (or depth in 3D), as a ratio. */ scaleX?: number; /** * How the image is resampled. */ textureFilter?: keyof typeof TextureFilter; /** * The color that is applied as a tint to the image. The color is applied to the whole image. When the tint is set to white the image appears with its native colors. */ tintColor?: number[]; /** * The image that is used in the symbol layer. Typically a base64 encoded image. */ url?: string; /** * A value indicating whether the marker stands upright as though locked in place. The marker can be viewed from all angles. */ verticalOrientation3D?: boolean; } /** * Represents a picture stroke which draws linear geometry with a repeating image file. Supported file types are .bmp, .jpg, .png, and .gif. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMPictureStroke) */ export interface CIMPictureStroke extends CIMStroke { type: "CIMPictureStroke"; /** * The color substitutions for the picture. */ colorSubstitutions?: CIMColorSubstitution[]; /** * How the image is resampled. */ textureFilter?: keyof typeof TextureFilter; /** * The image that is used in the symbol layer. Typically a base64 encoded image. */ url?: string; /** * The color that is applied as a tint to the image. The color is applied to the whole image. When the tint is set to white the image appears with its native colors. */ tintColor?: number[]; } /** * Represents a point symbol used to draw point features and point graphics. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMPointSymbol) */ export interface CIMPointSymbol extends CIMMultiLayerSymbol { type: "CIMPointSymbol"; /** * The callout of the point symbol. */ callout?: CIMCalloutType; /** * The size of the halo that extends beyond the symbol shape. */ haloSize?: number; /** * The polygon symbol that is used to draw the halo for a point symbol. */ haloSymbol?: CIMPolygonSymbol; /** * The primitive name. */ primitiveName?: string; /** * The X scale which changes the width of the symbol without changing the height (or depth in 3D), as a ratio. */ scaleX?: number; /** * The collection of symbol properties that apply when the symbol is used in a 3D context. */ symbol3DProperties?: CIM3DSymbolProperties; /** * The amount of variation applied to the symbol, measured in degrees, propagated cumulatively to all marker symbols. */ angle?: number; /** * Whether point symbols align to the map or to the display when a rotation is applied to the map. */ angleAlignment?: keyof typeof AngleAlignment; } /** * Represents a polygon symbol which is used to draw polygon features or polygon graphics. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMPolygonSymbol) */ export interface CIMPolygonSymbol extends CIMMultiLayerSymbol { type: "CIMPolygonSymbol"; } /** * Represents shape vertices. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMShapeVertices) */ export interface CIMShapeVertices { type: "CIMShapeVertices"; /** * The indices. */ indices?: number; /** * The shape. */ shapes?: string; } /** * Represents a solid fill which fills polygonal geometry with a single solid color. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMSolidFill) */ export interface CIMSolidFill extends CIMFill { type: "CIMSolidFill"; /** * The color that is applied to the fill. */ color?: number[]; } /** * Represents a solid stroke which draws linear geometry with a single solid color. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMSolidStroke) */ export interface CIMSolidStroke extends CIMStroke { type: "CIMSolidStroke"; /** * The color that is applied to the stroke. */ color?: number[]; } /** * Represents a text margin which defines the margin to apply around text. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMTextMargin) */ export interface CIMTextMargin { type: "CIMTextMargin"; /** * The left margin. */ left?: number; /** * The right margin. */ right?: number; /** * The top margin. */ top?: number; /** * The bottom margin. */ bottom?: number; } /** * Represents a text symbol which is used to draw text graphics, bleeds, and annotation. Text symbols do not contain any symbol layers but can have callouts. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMTextSymbol) */ export interface CIMTextSymbol extends CIMSymbolBase { type: "CIMTextSymbol"; /** * The amount of rotation applied to the text symbol, measured in degrees, around the geometry. */ angle?: number; /** * The amount of rotation of the text symbol around the X axis, measured in degrees, around the geometry. This type of rotation is also referred to as tilt. It is applied in 3D. */ angleX?: number; /** * The amount of rotation of the text symbol around the Y axis, measured in degrees, around the geometry. This type of rotation is also referred to as roll. It is applied in 3D. */ angleY?: number; /** * The direction in which multi-line text is stacked. */ blockProgression?: keyof typeof BlockProgression; /** * The callout or background of the text with optional leader lines. */ callout?: CIMCalloutType; /** * A value indicating whether to draw the text in a fashion compatible with ArcMap. */ compatibilityMode?: boolean; /** * The ISO code for the base country of the text. */ countryISO?: string; /** * The depth of the glyph when drawn in 3D. This is an extrusion of the characters of the text in the Z axis. */ depth3D?: number; /** * A value indicating whether fonts that are drawn as rasters at some scales to draw as vectors instead. */ drawGlyphsAsGeometry?: boolean; /** * A value indicating whether soft hyphens should be drawn. Soft hyphens are invisible markers that indicate where a hyphenated break is allowed within the text. They are only drawn if there is word wrapping at the end of a line. */ drawSoftHyphen?: boolean; /** * A value indicating whether the baseline of the text geometry should be expanded in the same manner as the existing geometry if the text extends beyond the baseline. */ extrapolateBaselines?: boolean; /** * The angle (in degrees from vertical) at which point rotated text is flipped (mirrored) in place. */ flipAngle?: number; /** * Whether the text is drawn as subscript or superscript. */ fontEffects?: keyof typeof FontEffects; /** * The font encoding. */ fontEncoding?: keyof typeof FontEncoding; /** * The font family name of the font. e.g. Comic Sans. */ fontFamilyName?: string; /** * The style name for the font family. e.g. Regular, Bold, or Italic. */ fontStyleName?: string; /** * The type of font that the font family/style name reference. */ fontType?: keyof typeof FontType; /** * An additional rotation that is applied to the individual glyphs contained in the text. This is applied to the individual glyphs whereas Angle, AngleX and AngleY are affect how the entire text string is oriented. */ glyphRotation?: number; /** * The size of the halo that extends beyond the symbol shape. */ haloSize?: number; /** * The polygon symbol that is used to draw the halo for a text symbol. */ haloSymbol?: CIMPolygonSymbol; /** * The size of the text in points. */ height?: number; /** * If hinting from the font is used for text rendering. Hinting is information included with most fonts to effectively fit the vector glyphs of the font into the raster grid onto which they are displayed. */ hinting?: keyof typeof GlyphHinting; /** * The alignment type used to align the text to the geometry horizontally. Affects which side of a point geometry the point text is drawn or which end of a line it is drawn close to. Commonly used to define how stacked text appears. */ horizontalAlignment?: keyof typeof HorizontalAlignment; /** * How many points to indent the text back from the end of the baseline. */ indentAfter?: number; /** * How many points to indent the text from the beginning of the baseline. */ indentBefore?: number; /** * How many points to indent the text from the beginning of the baseline for the first line only. */ indentFirstLine?: number; /** * A value indicating whether the text is drawn with metric kerning, which adjusts the spacing between individual letter forms. */ kerning?: boolean; /** * Whether the ISO code for the base language of the text. */ languageISO?: string; /** * The additional spacing that is added to each glyph beyond what is defined by its character box in the font. Value indicates the percentage of a glyph's width. Also known as tracking. */ letterSpacing?: number; /** * The width that is added to each glyph beyond what is defined by its character box in its font. This is a percentage of the original glyph. */ letterWidth?: number; /** * A value indicating whether text is to be drawn with ligatures, which occur when two or more letters or portions of letters are joined to form a single glyph. */ ligatures?: boolean; /** * The spacing between lines of text. This is also known as leading or line spacing. */ lineGap?: number; /** * The type of line gap that is applied. */ lineGapType?: keyof typeof LineGapType; /** * The X offset. */ offsetX?: number; /** * The Y offset. */ offsetY?: number; /** * The Z offset. */ offsetZ?: number; /** * The color of the shadow that is defined for the text symbol. The shadow is drawn as an offset copy of the text. */ shadowColor?: number[]; /** * The shadow offset from the text symbol in the horizontal direction. If X and Y are zero, no shadow is drawn. */ shadowOffsetX?: number; /** * The shadow offset from the text symbol in the vertical direction. If X and Y are zero, no shadow is drawn. */ shadowOffsetY?: number; /** * A value indicating whether the text should be drawn as Small Capitals, where lower case text is converted to small caps and upper case text is left as upper case. */ smallCaps?: boolean; /** * A value indicating whether to draw the text with a strike through it. */ strikethrough?: boolean; /** * The polygon symbol that is used to draw the glyphs of the text. */ symbol?: CIMPolygonSymbol; /** * The collection of properties that are applied to the text symbol only in a 3D context. */ symbol3DProperties?: CIM3DSymbolProperties; /** * The letter case used to draw the text. */ textCase?: keyof typeof TextCase; /** * The base text direction to draw the text. */ textDirection?: keyof typeof TextReadingDirection; /** * A value indicating whether to draw the text with an underline. */ underline?: boolean; /** * The vertical alignment of the text. */ verticalAlignment?: keyof typeof VerticalAlignment; /** * The orientation for the non-vertical text in a vertical layout. For example, an English fragment in a Japanese text. */ verticalGlyphOrientation?: keyof typeof VerticalGlyphOrientation; /** * The additional spacing that is added to between the words of the text string. 100% indicates that regular spacing is used. */ wordSpacing?: number; /** * The billboard mode of the text symbol. */ billboardMode3D?: keyof typeof BillboardMode; /** * A value indicating whether or not the symbol should overprint in press printing. */ overprint?: boolean; } /** * Represents a vector marker which can represent vector graphics. It's constructed from MarkerGraphics which are geometries and symbols used as building blocks for the marker. * * [Read more...](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#CIMVectorMarker) */ export interface CIMVectorMarker extends CIMMarker { type: "CIMVectorMarker"; /** * The depth of the marker when drawn in 3D. */ depth3D?: number; /** * The outer boundary of the entire vector marker. */ frame?: ExternalReferenceEnvelope; /** * The vector graphics that define the shape of the marker. */ markerGraphics?: CIMMarkerGraphic[]; /** * A value indicating whether the marker stands upright as though locked in place. The marker can be viewed from all angles. */ verticalOrientation3D?: boolean; /** * A value indicating whether the strokes and or fills of a marker are scaled proportionally when the symbol size is changed. When enabled, the strokes for the outline or fill of the polygon symbol used to draw the marker will be scaled proportionally with changes to the symbol size. If this property is not enabled, then the stroke will draw with the specified width regardless of the marker size. */ scaleSymbolsProportionally?: boolean; /** * A value indicating whether the frame of the vector marker should be honored when drawing the marker. */ respectFrame?: boolean; /** * A clipping path for the vector marker graphics. */ clippingPath?: CIMClippingPath; } export type CIMMarkerPlacementType = | CIMMarkerPlacementAlongLineRandomSize | CIMMarkerPlacementAlongLineSameSize | CIMMarkerPlacementAlongLineVariableSize | CIMMarkerPlacementAtExtremities | CIMMarkerPlacementAtMeasuredUnits | CIMMarkerPlacementAtRatioPositions | CIMMarkerPlacementOnLine | CIMMarkerPlacementOnVertices | CIMMarkerPlacementInsidePolygon | CIMMarkerPlacementPolygonCenter; export type CIMSymbolType = CIMLineSymbol | CIMPointSymbol | CIMPolygonSymbol | CIMTextSymbol; export type CIMGeometricEffectType = | CIMGeometricEffectAddControlPoints | CIMGeometricEffectArrow | CIMGeometricEffectBuffer | CIMGeometricEffectCut | CIMGeometricEffectDashes | CIMGeometricEffectDonut | CIMGeometricEffectEnclosingPolygon | CIMGeometricEffectExtension | CIMGeometricEffectJog | CIMGeometricEffectLocalizerFeather | CIMGeometricEffectMove | CIMGeometricEffectOffset | CIMGeometricEffectOffsetHatch | CIMGeometricEffectOffsetTangent | CIMGeometricEffectRadial | CIMGeometricEffectRegularPolygon | CIMGeometricEffectReverse | CIMGeometricEffectRotate | CIMGeometricEffectScale | CIMGeometricEffectSuppress | CIMGeometricEffectTaperedPolygon | CIMGeometricEffectWave; export type CIMSymbolLayerType = | CIMCharacterMarker | CIMObjectMarker3D | CIMPictureMarker | CIMVectorMarker | CIMGradientFill | CIMHatchFill | CIMPictureFill | CIMSolidFill | CIMGradientStroke | CIMPictureStroke | CIMSolidStroke | CIMMaterialSymbolLayer; export type CIMCalloutType = CIMLineCallout; export interface ExternalReferencePoint { x?: number; y?: number; z?: number; m?: number; spatialReference?: ExternalReferenceSpatialReference; } export interface ExternalReferencePolyline { hasM?: boolean; hasZ?: boolean; paths?: number[][][]; curvePath?: number[][][]; spatialReference?: ExternalReferenceSpatialReference; } export interface ExternalReferencePolygon { hasM?: boolean; hasZ?: boolean; rings?: number[][][]; curveRings?: number[][][]; spatialReference?: ExternalReferenceSpatialReference; } export interface ExternalReferenceEnvelope { mmax?: number; mmin?: number; xmax?: number; xmin?: number; ymax?: number; ymin?: number; zmax?: number; zmin?: number; spatialReference?: ExternalReferenceSpatialReference; } export interface ExternalReferenceSpatialReference { wkid?: number; latestWkid?: number; vcsWkid?: number; latestVcsWkid?: number; } export type ExternalReferenceGeometry = | ExternalReferencePoint | ExternalReferencePolyline | ExternalReferencePolygon | ExternalReferenceEnvelope; } }